gui Namespace Reference

Graphical user interface namespace. More...

Classes
class	AboutWindow
	Window displaying program version and authors. More...
class	AddItemDialog
	Dialog for adding items to Dictionaries or Arrays. More...
class	AnnotDialog
	Dialog for adding annotations. More...
class	Base
	Script hosting base class. More...
class	BaseConsole
	Script hosting base class. More...
class	BaseCore
	Core scripting functions. More...
class	BaseGUI
	Script hosting base class. More...
class	BoolOption
	Widget to edit boolean option. More...
class	BoolProperty
	Property editor widget for editing CBool. More...
class	ColorTool
	Toolbar widget for changing current color. More...
class	ComboOption
	Widget to edit option by picking from list of choices. More...
class	CommandWindow
class	ConsoleWindow
	Commandline mode Main "window". More...
class	ConsoleWriter
	Abstract class for console output. More...
class	ConsoleWriterConsole
	Console output in commandline. More...
class	ConsoleWriterGui
	Console output in GUI. More...
class	DialogOption
	Abstract class for option editable as string and pickable by dialog. More...
class	TreeItemDragObject
	Drag and drop object. More...
class	DragListView
	Drag and drop enhanced QListView. More...
class	EditTool
	Toolbar widget for editing arbitrary text. More...
class	FileOption
	Widget to edit option by typing or picking a file. More...
class	FontOption
	Widget to edit option by typing or picking a font. More...
class	HelpWindow
	Help window. More...
class	IconCache
	Class caching loaded icons. More...
class	ImageWidget
class	IntOption
	Widget to edit integer option. More...
class	IntProperty
	Property editor widget for editing CInt. More...
class	InvalidMenuException
	Exception raised when encountering invalid menu item. More...
class	Menu
	Menu and Toolbar management. More...
struct	NodeData
class	ListItem
class	MergeArray
	Type for merge dialog result. More...
class	MergeDialog
	Dialog for merging documents. More...
class	MultiTreeWindow
	Treeview with tab support. More...
class	NameProperty
	Property editor widget for editing CName. More...
class	NullPointerException
	Exception raised when encountering NULL pointer when not expected. More...
class	NumberTool
	Toolbar widget for editing arbitrary text. More...
class	OperatorHint
	Mode controller wrapper. More...
class	Option
	Abstract class for option editing widget. More...
class	OptionWindow
	Window for showing/editing program settings. More...
class	TextLine
class	PageSpace
class	PageTool
	Toolbar widget for changing page. More...
class	DrawingObjectFactory
class	DrawingObject
class	DrawingLine
class	DrawingRect
class	DrawingRect2
class	DrawingRect3
class	PageViewModeFactory
class	PageViewMode
class	PageViewMode_NewObject
class	PageViewMode_TextSelection
class	PageViewMode_OperatorsSelection
class	PageViewMode_Annotations
class	PageViewMode_TextMarking
class	PageViewMode_GraphicalOperatorsSelection
class	PageViewS
class	PasswordDialog
	Window for asking password. More...
class	PdfEditWindow
	Main window of application. More...
class	ProgressBar
class	Property
	Abstract class for property editing widget. More...
class	PropertyEditor
	Property editor widget. More...
class	PropertyModeController
	Mode controller wrapper. More...
class	QSAnnotation
	QObject wrapper around CAnnotation object. More...
class	QSArray
	QObject wrapper around CArray. More...
class	QSCObject
	Common base class of all QObject wrappers used in scripting. More...
class	QSContentStream
	QObject wrapper around CContentStream. More...
class	QSDict
	QObject wrapper around CDict. More...
class	QSImporter
	QObject importer into scripting. More...
class	QSIProperty
	QObject wrapper around IProperty. More...
class	QSIPropertyArray
	QObject wrapper around array of arbitrary IProperty items. More...
class	QSMenu
	QObject wrapper around popup menu. More...
class	QSPage
	QObject wrapper around CPage. More...
class	QSPdf
	QObject wrapper around shared_ptr<CPdf>. More...
class	QSPdfOperator
	QObject wrapper around PdfOperator. More...
class	QSPdfOperatorIterator
	QObject wrapper around PdfOperator::Iterator. More...
class	QSPdfOperatorStack
	QObject wrapper around array (stack) of PDF Operators. More...
class	QSStream
	QObject wrapper around CStream. More...
class	QSTreeItem
	QObject wrapper around TreeItemAbstract (or its subclasses). More...
class	QSTreeItemContentStream
	QObject wrapper around TreeItemContentStream. More...
class	QSWrapper
	QObject Wrapper factory. More...
class	RealOption
	Widget to edit floating-point number option. More...
class	RealProperty
	Property editor widget for editing CReal. More...
class	BBoxOfObjectOnPage
class	RectArray
class	Rect2DArray
class	RefProperty
	Property editor widget for editing CRef. More...
class	RefPropertyDialog
	Dialog to pick reference target. More...
class	RefValidator
	Reference format validator. More...
class	RevisionTool
	Toolbar widget for changing revision. More...
class	SelectPagesDialog
class	SelectTool
	Toolbar widget for selecting arbitrary text. More...
class	SelfDestructiveWidget
	Widget destroying itself on certain signal. More...
class	Settings
	Saving and loading settings. More...
class	StaticSettings
	Loading static settings from file. More...
class	StatusBar
	Editor statusbar. More...
class	StringOption
	Widget to edit string option. More...
class	StringProperty
	Property editor widget for editing CString. More...
class	ToolBar
	Application toolbar. More...
class	ToolButton
	Pushbutton in application toolbar. More...
class	ToolFactory
	Special Toolbar item factory. More...
class	TreeData
	Tree parameters shared between tree and tree items. More...
class	TreeItem
	Tree item containing IProperty. More...
class	TreeItemAbstract
	Abstract tree item class. More...
class	TreeItemAnnotation
	Tree item containing CAnnotation. More...
class	TreeItemAnnotationContainer
	Tree item containing vector of Annotations. More...
class	TreeItemArray
	Tree item containing CArray. More...
class	TreeItemContentStream
	Tree item containing CContentStream. More...
class	TreeItemContentStreamObserver
	Observer for TreeItemContentStream. More...
class	TreeItemCStream
	Tree item containing CStream. More...
class	TreeItemDict
	Tree item containing CDict. More...
class	TreeItemGenericObserver
	Generic observer that will reload tree item on change. More...
class	TreeItemObserver
	Observer for TreeItem. More...
class	TreeItemOperatorContainer
	Tree item containing vector of PDF operators. More...
class	TreeItemOutline
	Tree item containing one outline. More...
class	TreeItemPage
	Tree item containing CPage. More...
class	TreeItemPageObserver
	Observer for TreeItemPage. More...
class	TreeItemPdf
	Tree item containing PDF document or special parts of it. More...
class	TreeItemPdfOperator
	Tree item containing PdfOperator. More...
class	TreeItemRef
	Tree item containing CRef. More...
class	TreeItemSimple
	Tree item containing simple property. More...
class	TreeWindow
	Object tree view widget. More...
class	Units
	Units conversion. More...
class	ZoomTool
	Toolbar widget for changing zoom level. More...
Typedefs
typedef vector< size_t >	PageNums
typedef Q_PtrDict< Q_PtrDict < void > >	TreeBindingMap
typedef Q_PtrDictIterator < QSTreeItem >	TreeBindingMapIterator
typedef QMap< QString, QPixmap * >	IconCacheData
typedef QMap< QString, QIcon * >	IconSetsData
typedef QMap< QString, int >	ActionMap
typedef QMap< int, QString >	ActionMapInverse
typedef QMap< QString, ToolBar * >	ToolBarList
typedef QMap< QString, QString >	AccelList
typedef QMap< QString, Q_PopupMenu * >	MenuCache
typedef QMap< QMenuData *, QString >	MenuAccels
typedef QMap< QString, QString >	MenuNames
typedef std::pair< QMenuData *, int >	MenuItemsValue
typedef std::pair< QString, int >	MapKey
typedef QMap< MapKey, MenuItemsValue >	MenuItems
typedef QMap< MapKey, QWidget * >	ToolbarItems
typedef std::pair< TreeType, void * >	TreeKey
typedef QMap< TreeKey, TreeWindow * >	TreeWindowList
typedef QMap< TreeWindow *, TreeKey >	TreeWindowListReverse
typedef PropertyMode	PropertyFlags
typedef std::deque < boost::shared_ptr < PdfOperator > >	pdfOpDeque
typedef int	ChildType
typedef boost::shared_ptr < IProperty >	OutlineItem
typedef std::vector < boost::shared_ptr < pdfobjects::PdfOperator > >	OperatorVector
typedef std::vector < boost::shared_ptr < pdfobjects::CAnnotation > >	AnnotationVector
Enumerations
enum	TreeType { Tree_Invalid = 0, Tree_Main, Tree_OperatorVector, Tree_IProperty, Tree_ContentStream }
enum	TreeItemContentStreamMode { All, Text, Font, Graphic }
enum	childType { invalidItem = -1, pageList = 1, outlineList, pageItem, outlineItem, dictItem }
Functions
bool	pdfWriterAskPassword (const QString &inFile, boost::shared_ptr< utils::PdfDocumentWriter > wr)
QString	getDir (QFileDialog &fd)
QString	openFileDialog (QWidget *parent, const QString &caption, const QString &settingName, const QString &filters, const QString &savePath)
QString	openFileDialogPdf (QWidget *parent)
QString	saveFileDialog (QWidget *parent, const QString &oldname, bool askOverwrite, const QString &caption, const QString &settingName, const QString &filters, const QString &savePath)
QString	saveFileDialogPdf (QWidget *parent, const QString &oldname, bool askOverwrite)
QString	saveFileDialogXml (QWidget *parent, const QString &oldname, bool askOverwrite)
QString	readStringDialog (QWidget *parent, const QString &message, const QString &def)
QColor	colorDialog (QWidget *parent)
bool	questionDialog (QWidget *parent, const QString &msg)
void	removeOperatorHint ()
void	applyLookAndFeel (bool notify)
void	applyStyle ()
Property *	propertyFactory (pdfobjects::IProperty prop, const QString &_name, QWidget parent)
void	removePropertyModeController ()
QRegExp	valid ("\\d+,\\d+")
QRegExp	ivalid ("\\d,?\\d")
Variables
QString	app = QString(APP_NAME) +" "+ QString(PDFEDIT_VERSION)
const Qt::WFlags	aboutDialogFlags = Qt::WDestructiveClose \| Qt::WType_Dialog
const int	addDialogPropertyTypes = 8
static QDateTime	basetime = QDateTime::currentDateTime()
QString	CMD = "gui/CommandLine/"
QString	CMDSHOWHISTORY = "CmdShowHistory"
QString	CMDSHOWLINE = "CmdShowLine"
QString	CMDSHOWEDITOR = "CmdShowEditor"
QString	HISTORYSIZE = "HistorySize"
QString	HISTORYFILE = "HistoryFile"
QString	HISTORYFILEITEMSEPARATOR = "HistoryFileItemSeparator"
QString	DEFAULT__HISTORYFILE = ".pdfedit-history"
QString	DEFAULT__HISTORYFILEITEMSEPARATOR = "<EndItem>"
int	DEFAULT__HISTORYSIZE = 10
bool	DEFAULT__CMDSHOWHISTORY = true
bool	DEFAULT__CMDSHOWLINE = true
bool	DEFAULT__CMDSHOWEDITOR = false
const char *	TREEITEM_TYPE = "pdfedit/treeitem"
int	iconCacheInstances = 0
QStringList	iconPath
QString	iconStyleName
IconCacheData	iconCache
IconSetsData	setCache
const QString	ROOT = "gui/items/"
const QString	ROOT_ADD = "gui/items_add/"
const char	MENUDEF_SEPARATOR = ','
const char	MENULIST_SEPARATOR = ','
const char	TOOLBARLIST_SEPARATOR = ','
OperatorHint *	OperatorHintInstance = NULL
OperatorHinter	hinter
StringConfigurationParser	baseParserHint (StringConfigurationParser(NULL))
StringConfigurationParser	parserHint (baseParserHint)
OptionWindow *	opt = NULL
QString	PAGESPC = "gui/PageSpace/"
QString	RESIZINGZONE = "ResizingZone"
int	DEFAULT__RESIZINGZONE = 2
QString	VIEWED_UNITS = "ViewedUnits"
QString	DEFAULT__VIEWED_UNITS = "cm"
QString	format = "x:%1 y:%2 %3"
int	windowCount
const PropertyMode	defaultPropertyMode = mdNormal
PropertyModeController *	propertyModeControllerInstance = NULL
ModeController	modeController
StringConfigurationParser	baseParser (NULL)
ModeController::ConfParser	parser (baseParser)
const int	TMP_OFFSET = 0x3fffffff
const QString	APP_KEY = "/PDFedit/"
const QString	CONFIG_FILE = "pdfeditrc"
const QString	APP_PATH_VAR = "PDFEDIT_BIN"
const QString	DATA_PATH_VAR = "PDFEDIT_DATA"
Settings *	globalSettings = NULL

Detailed Description

Graphical user interface namespace.

GUI namespace
This namespace contain all user-interface related classes (widgets, tree items, scripting wrappers and others)

Typedef Documentation

typedef QMap<QString, QString> gui::AccelList

Mapping from accel name to widget that have this accel

typedef QMap<QString, int> gui::ActionMap

Action map type: mapping from to

typedef QMap<int, QString> gui::ActionMapInverse

Inverse action map: mapping from to

typedef std::vector<boost::shared_ptr<pdfobjects::CAnnotation> > gui::AnnotationVector

Vector with annotationss

typedef int gui::ChildType

Type of TreeItemAbstract's child.
The type is arbitrary integer and must be unique only across single type (different types must have different values).
Two distict TreeItemAbstract descendants can have collisions in types (same value meaning different type)
Types of childs from different items are never mixed or compared together

typedef QMap<QString, QPixmap*> gui::IconCacheData

Icon Cache type: mapping from icon name to pixmap

typedef QMap<QString, QIcon*> gui::IconSetsData

Icon Sets Cache type: mapping from icon name to icon set

typedef std::pair<QString,int> gui::MapKey

Key type for MenuItems and ToolbarItems

typedef QMap<QMenuData*, QString> gui::MenuAccels

List of already used accelerators for specific popup menu

typedef QMap<QString, Q_PopupMenu*> gui::MenuCache

Cache of already defined menu items (some menus may be used on more than one place)

typedef QMap<MapKey,MenuItemsValue> gui::MenuItems

Pointer to of all items by item or "item class" name - menu items

typedef std::pair<QMenuData*,int> gui::MenuItemsValue

Value type for MenuItems type

typedef QMap<QString, QString> gui::MenuNames

Cache of already defined menu items (names)

typedef std::vector<boost::shared_ptr<pdfobjects::PdfOperator> > gui::OperatorVector

Vector with operators

typedef boost::shared_ptr<IProperty> gui::OutlineItem

type representing one outline item

typedef vector<size_t> gui::PageNums

(for pdftoxml)

typedef std::deque<boost::shared_ptr<PdfOperator> > gui::pdfOpDeque

Double ended queue with operators

typedef PropertyMode gui::PropertyFlags

Property flags (property mode - hidden, advanced ...)

typedef QMap<MapKey,QWidget*> gui::ToolbarItems

Pointer to of all items by item or "item class" name - toolbar items

typedef QMap<QString, ToolBar*> gui::ToolBarList

Toolbar list type: mapping from toolbar name to toolbar object

typedef Q_PtrDict<Q_PtrDict<void> > gui::TreeBindingMap

Type containing binding between treeitem and its QSA wrapper.
Mapping is from TreeItemAbstract* to (QSTreeItem*)[]

typedef Q_PtrDictIterator<QSTreeItem> gui::TreeBindingMapIterator

Iterator type for TreeBindingMap dictionary type

See also:: TreeBindingMap

typedef std::pair<TreeType,void*> gui::TreeKey

Key type used to identify the tree in map

typedef QMap<TreeKey,TreeWindow*> gui::TreeWindowList

Mapping from TreeKey to associated Tree Window

typedef QMap<TreeWindow*,TreeKey> gui::TreeWindowListReverse

Mapping from Tree Window to TreeKey associated with them (reverse mapping)

Enumeration Type Documentation

enum gui::childType

Child type specific for TreeItemPdf

Enumerator:

invalidItem
pageList
outlineList
pageItem
outlineItem
dictItem

enum gui::TreeItemContentStreamMode

What should be shown as children under tree item wit Content stream

Enumerator:

All	Show all operators
Text	Show only text operators
Font	Show only font operators
Graphic	Show only graphical operators

enum gui::TreeType

Possible types of tree - which item is in root

Enumerator:

Tree_Invalid	Invalid type
Tree_Main	Main - the document
Tree_OperatorVector	Vector with operators
Tree_IProperty	IPproperty
Tree_ContentStream	Content stream

Function Documentation

void gui::applyLookAndFeel ( bool notify )

Applies look and feel settings from options

Parameters:

notify

If true, all fonts will be immediately changed in all widgets

Referenced by main().

void gui::applyStyle ( )

Apply current style to GUI (to all windows)

QColor gui::colorDialog ( QWidget * parent )

Invoke dialog to select color. Last selected color is remembered and offered as default next time. The 'initial default color' is red

Parameters:

parent

Parent widget - will be disabled during the dialog.

Returns:: selected color. If dialog is cancelled, 'invalid' color is returned

QString gui::getDir ( QFileDialog & fd )

Get current directory from File Dialog

Parameters:

fd

File Dialog

Returns:: current directory

QRegExp gui::ivalid	(	"\\d*	,
		?\\d *"
	)

Regular expression for intermediate validation

Referenced by gui::RefValidator::validate().

QString gui::openFileDialog	(	QWidget *	parent,
		const QString &	caption,
		const QString &	settingName,
		const QString &	filters,
		const QString &	savePath
	)

Generic "Open file" dialog. Wait for user to select one existing file and return its name. Will return NULL if user cancels the dialog.

Parameters:

	parent	Parent widget - will be disabled during the dialog.
	caption	Caption used in dialog title
	settingName	Key in settings used to save/load dialog window position
	savePath	Key in settings used to identify where to save last used directory in the dialog
	filters	Filters available to user to restrict shown filetypes in dialog

Returns:: selected Filename (or NULL)

QString gui::openFileDialogPdf ( QWidget * parent )

Invoke "open file" dialog for PDF files. Specialization of openFileDialog

See also:: openFileDialog

Parameters:

parent

Parent widget - will be disabled during the dialog.

Returns:: selected Filename (or NULL)

bool gui::pdfWriterAskPassword	(	const QString &	inFile,
		boost::shared_ptr< utils::PdfDocumentWriter >	wr
	)

Common code to flattener and delinearizator Ask for password for opening the PDF file if one is needed

Parameters:

	inFile	name of input file
	wr	PdfDocumentWriter

Returns:: true if either valid password is entered or no password is needed

Property * gui::propertyFactory	(	pdfobjects::IProperty *	prop,
		const QString &	_name,
		QWidget *	parent
	)

Return one of the subclasses of Property widget for editing given property. If property is of unknown or uneditable type, NULL is returned

Parameters:

	prop	IProperty to create property from
	parent	Parent widget
	_name	Name of this property

Returns:: subclass of Property widget (or NULL)

Referenced by gui::PropertyEditor::appendMessage().

bool gui::questionDialog	(	QWidget *	parent,
		const QString &	msg
	)

Asks question with Yes/No answer. "Yes" is default. Return true if user selected "yes", false if user selected "no"

Parameters:

	msg	Question to display
	parent	Parent widget - will be disabled during the dialog.

Returns:: True if yes, false if no

QString gui::readStringDialog	(	QWidget *	parent,
		const QString &	message,
		const QString &	def
	)

Invoke "read string" dialog. Show message and wait for user to type any string. Will return NULL if user cancels the dialog.

Parameters:

	parent	Parent widget - will be disabled during the dialog.
	message	Message to show in the dialog
	def	Default text that will be pre-typed in the dialog

Returns:: typed text, or NULL if dialog cancelled

void gui::removeOperatorHint ( )

atexit handler that will delete the single instance if it was allocated

void gui::removePropertyModeController ( )

atexit handler that will delete the single instance if it was allocated

References propertyModeControllerInstance.

Referenced by gui::PropertyModeController::PropertyModeController().

QString gui::saveFileDialog	(	QWidget *	parent,
		const QString &	oldname,
		bool	askOverwrite,
		const QString &	caption,
		const QString &	settingName,
		const QString &	filters,
		const QString &	savePath
	)

Invoke generic "save file" dialog. Wait for user to select or type a single file and return its name. Will return NULL if user cancels the dialog.

Parameters:

	parent	Parent widget - will be disabled during the dialog.
	oldname	Name of file to be saved - if specified, this name will be pre-selected.
	askOverwrite	If true and selected file exists, user will be asked to confirm overwriting it
	caption	Caption used in dialog title
	settingName	Key in settings used to save/load dialog window position
	savePath	Key in settings used to identify where to save last used directory in the dialog
	filters	Filters available to user to restrict shown filetypes in dialog

Returns:: selected Filename (or NULL)

QString gui::saveFileDialogPdf	(	QWidget *	parent,
		const QString &	oldname,
		bool	askOverwrite
	)

Invoke "save file" dialog for PDF files. Specialization of saveFileDialog

See also:: saveFileDialog

Parameters:

	parent	Parent widget - will be disabled during the dialog.
	oldname	Name of file to be saved - if specified, this name will be pre-selected.
	askOverwrite	If true and selected file exists, user will be asked to confirm overwriting it

Returns:: selected Filename (or NULL)

QString gui::saveFileDialogXml	(	QWidget *	parent,
		const QString &	oldname,
		bool	askOverwrite
	)

Invoke "save file" dialog for xml files. Specialization of saveFileDialog

See also:: saveFileDialog

Parameters:

	parent	Parent widget - will be disabled during the dialog.
	oldname	Name of file to be saved - if specified, this name will be pre-selected.
	askOverwrite	If true and selected file exists, user will be asked to confirm overwriting it

Returns:: selected Filename (or NULL)

QRegExp gui::valid	(	"\\d+	,
		\\d+"
	)

Regular expression for validation

Referenced by gui::RefValidator::validate().

Variable Documentation

const Qt::WFlags gui::aboutDialogFlags = Qt::WDestructiveClose | Qt::WType_Dialog

About Dialog flags

const int gui::addDialogPropertyTypes = 8

Number of property types that can be added in AddItemDialog

Referenced by gui::AddItemDialog::AddItemDialog().

QString gui::app = QString(APP_NAME) +" "+ QString(PDFEDIT_VERSION)

Version of program

Referenced by gui::AboutWindow::AboutWindow(), and main().

const QString gui::APP_KEY = "/PDFedit/"

"Root" item of all configuration settings, which are relative to this item

Referenced by gui::Settings::read(), and gui::Settings::write().

const QString gui::APP_PATH_VAR = "PDFEDIT_BIN"

Name of variable which will be expanded to full path to the executable

Referenced by gui::Settings::expand().

StringConfigurationParser gui::baseParser(NULL)

Low-level parser for simple configuration files (one line = one setting). This base parser is used by ConfParser, which is used by ModeController in loadFromFile

StringConfigurationParser gui::baseParserHint(StringConfigurationParser(NULL))

Low-level parser for simple configuration files (one line = one hint). This base parser is used by ConfParser, which is used by OperatorHinter in loadFromFile

QDateTime gui::basetime = QDateTime::currentDateTime() [static]

Base datetime (for tick counter)

QString gui::CMD = "gui/CommandLine/"

Root settings key prefixing all settings defined in this class

Referenced by gui::CommandWindow::CommandWindow(), gui::CommandWindow::loadHistory(), gui::CommandWindow::reloadSettings(), gui::CommandWindow::saveHistory(), gui::CommandWindow::setHistoryFile(), and gui::CommandWindow::setHistorySize().