Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

CheckDocument Class Reference

Preflight Verifier GUI (P.V.) A tool to check document for errors (in P.V. profiles) which can be set up in Preferences dialog. More...

#include <checkDocument.h>

Inheritance diagram for CheckDocument:

Inheritance graph
[legend]
Collaboration diagram for CheckDocument:

Collaboration graph
[legend]

List of all members.

Public Types

enum  CheckMode {
  checkNULL, checkPDF, checkEPS, checkPrint,
  checkPrintPreview
}
 State of the P.V. More...

Public Slots

void slotSelect (QTreeWidgetItem *ite)
 Called when is selected a new item in error list.
void doReScan ()
 Do a manual rechecking.
void newScan (const QString &name)
 Process error checking itself.

Signals

void selectElement (int, int)
 Signal emitted when user selects any page item in error list.
void selectPage (int)
 Signal emitted when user selects any page in error list.
void selectMasterPage (QString)
 Signal emitted when user selects any master page in error list.
void selectMasterPageElement (QString, int)
 Signal emitted when user selects any master page item in error list.
void ignoreAllErrors ()
 Signal emitted when user press the "ignore errors" button.

Public Member Functions

 CheckDocument (QWidget *parent, bool modal)
 ~CheckDocument ()
virtual void changeEvent (QEvent *e)
void clearErrorList ()
 Clean the list view tree and reset the P.V. attributes.
void buildErrorList (ScribusDoc *doc)
 Get all possible errors for given document.
void setIgnoreEnabled (bool state)
 Enable/disable "ignore" button and noButton property.
bool isIgnoreEnabled ()
 Get the state of the "ignore" button.

Public Attributes

CheckMode checkMode
 Current state of P.V.

Protected Slots

virtual void languageChange ()

Protected Attributes

QVBoxLayout * checkDocumentLayout
QHBoxLayout * layout1
QHBoxLayout * layout2

Private Attributes

QMap< QTreeWidgetItem *, int > itemMap
 Mappping Page Item - item nr.
QMap< QTreeWidgetItem *, int > pageMap
 Mappping Page - page nr.
QMap< QTreeWidgetItem *, QString > masterPageMap
 Mappping Master Page - MP nr.
QMap< QTreeWidgetItem *, int > masterPageItemMap
 Mappping MP Item - MP item nr.
ScribusDocm_Doc
 a reference to the current document
QPixmap graveError
 Icon for fatal error.
QPixmap onlyWarning
 Icon for warning.
QPixmap noErrors
 Icon for OK.
QString missingGlyph
 Strings for common texts in GUI dialog tree.
QString textOverflow
QString notOnPage
QString missingImg
QString lowDPI
QString highDPI
QString transpar
QString annot
QString rasterPDF
QString isGIF
QString isGIFtoolTip
QString WrongFont
bool noButton
 Flag if is ignore button shown. true = hidden, false = shown.
ScComboBoxcurCheckProfile
QLabel * textLabel1
QTreeWidget * reportDisplay
QPushButton * ignoreErrors
QPushButton * reScan


Detailed Description

Preflight Verifier GUI (P.V.) A tool to check document for errors (in P.V. profiles) which can be set up in Preferences dialog.

Definition at line 31 of file checkDocument.h.


Member Enumeration Documentation

State of the P.V.

Enumerator:
checkNULL 
checkPDF 
checkEPS 
checkPrint 
checkPrintPreview 

Definition at line 42 of file checkDocument.h.


Constructor & Destructor Documentation

CheckDocument::CheckDocument ( QWidget *  parent,
bool  modal 
)

CheckDocument::~CheckDocument (  )  [inline]

Definition at line 37 of file checkDocument.h.


Member Function Documentation

void CheckDocument::changeEvent ( QEvent *  e  )  [virtual]

Definition at line 812 of file checkDocument.cpp.

References languageChange().

void CheckDocument::clearErrorList (  ) 

Clean the list view tree and reset the P.V. attributes.

Definition at line 217 of file checkDocument.cpp.

References itemMap, masterPageItemMap, masterPageMap, pageMap, reportDisplay, and slotSelect().

Referenced by buildErrorList(), ScribusMainWindow::doFileNew(), ScribusMainWindow::keyPressEvent(), ScribusMainWindow::newActWin(), and newScan().

void CheckDocument::buildErrorList ( ScribusDoc doc  ) 

void CheckDocument::setIgnoreEnabled ( bool  state  ) 

Enable/disable "ignore" button and noButton property.

Parameters:
state true to enable the button

Definition at line 848 of file checkDocument.cpp.

References ignoreErrors, and noButton.

Referenced by CheckDocument(), ScribusMainWindow::slotFilePrint(), and ScribusMainWindow::slotReallyPrint().

bool CheckDocument::isIgnoreEnabled (  ) 

Get the state of the "ignore" button.

Return values:
true on button is visible

Definition at line 854 of file checkDocument.cpp.

References noButton.

Referenced by ScribusMainWindow::slotReallyPrint().

void CheckDocument::slotSelect ( QTreeWidgetItem *  ite  )  [slot]

void CheckDocument::doReScan (  )  [slot]

Do a manual rechecking.

Definition at line 202 of file checkDocument.cpp.

References curCheckProfile, and newScan().

Referenced by CheckDocument().

void CheckDocument::newScan ( const QString &  name  )  [slot]

Process error checking itself.

Parameters:
name a QString with P.V. profile name

Definition at line 207 of file checkDocument.cpp.

References buildErrorList(), DocumentChecker::checkDocument(), clearErrorList(), ScribusDoc::curCheckProfile, and m_Doc.

Referenced by buildErrorList(), CheckDocument(), and doReScan().

void CheckDocument::selectElement ( int  ,
int   
) [signal]

Signal emitted when user selects any page item in error list.

Referenced by slotSelect().

void CheckDocument::selectPage ( int   )  [signal]

Signal emitted when user selects any page in error list.

Referenced by slotSelect().

void CheckDocument::selectMasterPage ( QString   )  [signal]

Signal emitted when user selects any master page in error list.

Referenced by slotSelect().

void CheckDocument::selectMasterPageElement ( QString  ,
int   
) [signal]

Signal emitted when user selects any master page item in error list.

void CheckDocument::ignoreAllErrors (  )  [signal]

Signal emitted when user press the "ignore errors" button.

Referenced by CheckDocument().

void CheckDocument::languageChange (  )  [protected, virtual, slot]


Member Data Documentation

Current state of P.V.

Definition at line 57 of file checkDocument.h.

Referenced by CheckDocument(), ScribusMainWindow::slotFilePrint(), and ScribusMainWindow::slotReallyPrint().

QVBoxLayout* CheckDocument::checkDocumentLayout [protected]

Definition at line 84 of file checkDocument.h.

Referenced by CheckDocument().

QHBoxLayout* CheckDocument::layout1 [protected]

Definition at line 85 of file checkDocument.h.

Referenced by CheckDocument().

QHBoxLayout* CheckDocument::layout2 [protected]

Definition at line 86 of file checkDocument.h.

Referenced by CheckDocument().

QMap<QTreeWidgetItem*, int> CheckDocument::itemMap [private]

Mappping Page Item - item nr.

Definition at line 93 of file checkDocument.h.

Referenced by buildErrorList(), CheckDocument(), clearErrorList(), and slotSelect().

QMap<QTreeWidgetItem*, int> CheckDocument::pageMap [private]

Mappping Page - page nr.

Definition at line 95 of file checkDocument.h.

Referenced by buildErrorList(), CheckDocument(), clearErrorList(), and slotSelect().

QMap<QTreeWidgetItem*, QString> CheckDocument::masterPageMap [private]

Mappping Master Page - MP nr.

Definition at line 97 of file checkDocument.h.

Referenced by buildErrorList(), CheckDocument(), clearErrorList(), and slotSelect().

QMap<QTreeWidgetItem*, int> CheckDocument::masterPageItemMap [private]

Mappping MP Item - MP item nr.

Definition at line 99 of file checkDocument.h.

Referenced by buildErrorList(), CheckDocument(), clearErrorList(), and slotSelect().

a reference to the current document

Definition at line 102 of file checkDocument.h.

Referenced by buildErrorList(), newScan(), and slotSelect().

QPixmap CheckDocument::graveError [private]

Icon for fatal error.

Definition at line 104 of file checkDocument.h.

Referenced by buildErrorList(), and CheckDocument().

QPixmap CheckDocument::onlyWarning [private]

Icon for warning.

Definition at line 106 of file checkDocument.h.

Referenced by buildErrorList(), and CheckDocument().

QPixmap CheckDocument::noErrors [private]

Icon for OK.

Definition at line 108 of file checkDocument.h.

Referenced by buildErrorList(), and CheckDocument().

QString CheckDocument::missingGlyph [private]

Strings for common texts in GUI dialog tree.

Definition at line 111 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::textOverflow [private]

Definition at line 112 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::notOnPage [private]

Definition at line 113 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::missingImg [private]

Definition at line 114 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::lowDPI [private]

Definition at line 115 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::highDPI [private]

Definition at line 116 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::transpar [private]

Definition at line 117 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::annot [private]

Definition at line 118 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::rasterPDF [private]

Definition at line 119 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::isGIF [private]

Definition at line 120 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

QString CheckDocument::isGIFtoolTip [private]

Definition at line 121 of file checkDocument.h.

QString CheckDocument::WrongFont [private]

Definition at line 122 of file checkDocument.h.

Referenced by buildErrorList(), and languageChange().

bool CheckDocument::noButton [private]

Flag if is ignore button shown. true = hidden, false = shown.

Definition at line 125 of file checkDocument.h.

Referenced by isIgnoreEnabled(), and setIgnoreEnabled().

Definition at line 126 of file checkDocument.h.

Referenced by buildErrorList(), CheckDocument(), and doReScan().

QLabel* CheckDocument::textLabel1 [private]

Definition at line 127 of file checkDocument.h.

Referenced by CheckDocument(), and languageChange().

QTreeWidget* CheckDocument::reportDisplay [private]

Definition at line 128 of file checkDocument.h.

Referenced by buildErrorList(), CheckDocument(), clearErrorList(), and languageChange().

QPushButton* CheckDocument::ignoreErrors [private]

Definition at line 129 of file checkDocument.h.

Referenced by buildErrorList(), CheckDocument(), languageChange(), and setIgnoreEnabled().

QPushButton* CheckDocument::reScan [private]

Definition at line 130 of file checkDocument.h.

Referenced by CheckDocument(), and languageChange().


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.