gui::PageSpace Class Reference

#include <pagespace.h>

Public Slots
QStringList	getAllUnits () const
QStringList	getAllUnitIds () const
bool	setDefaultUnits (const QString dunits=QString::null)
QString	getDefaultUnits () const
QString	getDescriptionForUnit (const QString _unit) const
QString	getUnitFromAlias (const QString _unit) const
double	convertUnits (double num, const QString fromUnits=QString::null, const QString toUnits=QString::null) const
double	convertFromUnitsToPoint (double num, const QString &fromUnits) const
double	convertFromPointToUnits (double num, const QString &toUnits) const
void	setResizingZone (int width)
int	getResizingZone ()
void	refresh (QSPage pageToView=NULL, QSPdf pdf=NULL)
void	refresh (QSPage pageToView, QObject pdf)
void	refresh (int pageToView, QSPdf *pdf=NULL)
void	refresh (int pageToView, QObject *pdf)
void	hidePageNumberAndPosition ()
void	showPageNumberAndPosition ()
void	setSelectionMode (QString mode, QString drawingObject=QString::null, QString scriptFncAtMouseRelease=QString::null, QString scriptFncAtMoveSelectedObjects=QString::null, QString scriptFncAtResizeSelectedObjects=QString::null)
void	setSelectArea (int left, int top, int right, int bottom)
void	selectObjectOnPage (const std::vector< boost::shared_ptr< PdfOperator > > &ops)
void	addSelectedObjectOnPage (const std::vector< boost::shared_ptr< PdfOperator > > &ops)
void	unselectObjectOnPage ()
bool	isSomeoneSelected ()
float	getZoomFactor ()
void	setZoomFactor (float set_zoomFactor)
void	zoomTo (int percentage)
void	zoomIn (float step=0.1)
void	zoomOut (float step=0.1)
void	firstPage ()
void	prevPage ()
void	nextPage ()
void	lastPage ()
bool	saveImage (const QString &filename, const char *format, int quality=-1, bool onlySelectedArea=false)
bool	saveImageWithDialog (bool onlySelectedArea=false)
double	convertPixmapPosToPdfPos_x (double fromX, double fromY)
double	convertPixmapPosToPdfPos_y (double fromX, double fromY)
double	convertPdfPosToPixmapPos_x (double fromX, double fromY)
double	convertPdfPosToPixmapPos_y (double fromX, double fromY)
int	findText (QString &text, bool startAtTop=true, double xStart=0, double yStart=0, double xEnd=-1, double yEnd=-1)
QMainWindow *	getTextLine (int x, int y, int fontsize=12, const QString &fontName=QString::null)
Signals
void	changedPageTo (const QSPage &page, int numberOfPage)
void	changedZoomFactorTo (float zoom)
void	changeSelection (std::vector< boost::shared_ptr< PdfOperator > > ops)
void	changeSelection (std::vector< boost::shared_ptr< CAnnotation > > annots)
void	changeMousePosition (double x, double y)
void	popupMenu (const QPoint &pagePos)
void	executeCommand (QString cmd)
void	deleteSelection ()
Public Member Functions
	PageSpace (QWidget parent=0, const char name=0)
virtual	~PageSpace ()
void	convertPixmapPosToPdfPos (const QPoint &pos, Point &pdfPos)
void	convertPdfPosToPixmapPos (const Point &pdfPos, QPoint &pos)
Private Slots
void	newSelection (const std::vector< boost::shared_ptr< PdfOperator > > &objects)
void	newSelection (const std::vector< boost::shared_ptr< CAnnotation > > &objects)
void	requestPopupMenu (const QPoint &p)
void	showMousePosition (double x, double y)
Private Attributes
QLabel *	pageNumber
QLabel *	mousePositionOnPage
PageViewS *	pageImage
QVBoxLayout *	vBox
QHBoxLayout *	hBox
Q_ScrollView *	scrollPageSpace
QSPdf *	actualPdf
boost::shared_ptr< CPage >	actualPage
int	actualPagePos
boost::shared_ptr< PageViewMode >	selectionMode
Units	actualUnits
TextLine *	textLine

Detailed Description

QWidget's class for viewing a page.

Constructor & Destructor Documentation

gui::PageSpace::PageSpace	(	QWidget *	parent = `0`,
		const char *	name = `0`
	)

Constructor with parameters as parent (see QWidget in Qt documentation)

Parameters:

	parent	Parent widget (see QWidget constroctor)
	name	Name of widget (see QWidget constructor)

Initialize all private variables, create scrollspace and bar with page number and position of cursor on page.

References actualPage, actualPagePos, actualPdf, actualUnits, changeMousePosition(), gui::DEFAULT__VIEWED_UNITS, gui::format, gui::Units::getDefaultUnits(), gui::globalSettings, hBox, Init(), initStruct::labelWidth, mousePositionOnPage, pageImage, pageNumber, gui::PAGESPC, gui::Settings::read(), scrollPageSpace, selectionMode, gui::Units::setDefaultUnits(), showMousePosition(), textLine, TheWheelFocus, vBox, and gui::VIEWED_UNITS.

gui::PageSpace::~PageSpace ( ) [virtual]

Destroctor of PageSpace

References actualPdf, and textLine.

Member Function Documentation

void gui::PageSpace::addSelectedObjectOnPage ( const std::vector< boost::shared_ptr< PdfOperator > > & ops ) [slot]

Add objects (PdfOperators) to selection on page.

Parameters:

ops

Vector of PdfOperators for add.

See also:: selectObjectOnPage; unselectObjectOnPage; isSomeoneSelected

References selectionMode.

void gui::PageSpace::changedPageTo	(	const QSPage &	page,
		int	numberOfPage
	)			`[signal]`

Signal emitted when viewed page is changed.

Parameters:

	page	Page which is actual viewed.
	numberOfPage	Position of page in documents.

Referenced by refresh().

void gui::PageSpace::changedZoomFactorTo ( float zoom ) [signal]

Signal emitted when zoom of viewed page is changed.

Parameters:

zoom

Current zoom factor (1.0 = 100%)

Referenced by setZoomFactor().

void gui::PageSpace::changeMousePosition	(	double	x,
		double	y
	)			`[signal]`

Signal emitted when mouse position over the viewed page is changed.

Parameters:

	x	Horizontal position on page.
	y	Vertical position on page.

Referenced by PageSpace().

void gui::PageSpace::changeSelection ( std::vector< boost::shared_ptr< CAnnotation > > annots ) [signal]

Signal emitted when new annotations are selected.

Parameters:

annots

Vector of selected annotations.

void gui::PageSpace::changeSelection ( std::vector< boost::shared_ptr< PdfOperator > > ops ) [signal]

Signal emitted when new operators are selected.

Parameters:

ops

Vector of selected operators.

Referenced by newSelection().

double gui::PageSpace::convertFromPointToUnits	(	double	num,
		const QString &	toUnits
	)			const `[slot]`

Conver value from points ("pt") to some unite.

Parameters:

	num	Value for conversion.
	toUnits	To which unit is required conversion of value num.

If toUnits is not set, then default unit use.

Returns:: Return value num conversed from points to units toUnits.

References actualUnits, and gui::Units::convertFromPointToUnits().

double gui::PageSpace::convertFromUnitsToPoint	(	double	num,
		const QString &	fromUnits
	)			const `[slot]`

Conver value to point ("pt").

Parameters:

	num	Value for conversion.
	fromUnits	Unit of value num.

If fromUnits is not set, then default unit use.

Returns:: Return value num conversed to points.

References actualUnits, and gui::Units::convertFromUnitsToPoint().

void gui::PageSpace::convertPdfPosToPixmapPos	(	const Point &	pdfPos,
		QPoint &	pos
	)

Method for convert pdf position to page position viewed on screen (apply rotation, viewing dpi, ...)

Parameters:

	pdfPos	Position on page in pdf.
	pos	Position on viewed page.

Position is returned in pos.

See also:: convertPdfPosToPixmapPos_x; convertPdfPosToPixmapPos_y; convertPixmapPosToPdfPos

References gui::PageViewS::convertPdfPosToPixmapPos(), and pageImage.

double gui::PageSpace::convertPdfPosToPixmapPos_x	(	double	fromX,
		double	fromY
	)			`[slot]`

Function return X position on viewed page from position in pdf page (apply rotation, viewing dpi, ...)

Parameters:

	fromX	X position in pdf page.
	fromY	Y position in pdf page.

Returns:: Return X position in pdf page.

See also:: convertPdfPosToPixmapPos_y; convertPdfPosToPixmapPos; convertPixmapPosToPdfPos

References gui::PageViewS::convertPdfPosToPixmapPos(), and pageImage.

double gui::PageSpace::convertPdfPosToPixmapPos_y	(	double	fromX,
		double	fromY
	)			`[slot]`

Function return Y position on viewed page from position in pdf page (apply rotation, viewing dpi, ...)

Parameters:

	fromX	X position in pdf page.
	fromY	Y position in pdf page.

Returns:: Return Y position in pdf page.

See also:: convertPdfPosToPixmapPos_x; convertPdfPosToPixmapPos; convertPixmapPosToPdfPos

References gui::PageViewS::convertPdfPosToPixmapPos(), and pageImage.

void gui::PageSpace::convertPixmapPosToPdfPos	(	const QPoint &	pos,
		Point &	pdfPos
	)

Method for convert page position viewed on screen to pdf position (unapply rotation, viewing dpi, ...)

Parameters:

	pos	Position on viewed page.
	pdfPos	Position on page in pdf.

Position is returned in pdfPos.

See also:: convertPixmapPosToPdfPos_x; convertPixmapPosToPdfPos_y; convertPdfPosToPixmapPos

References gui::PageViewS::convertPixmapPosToPdfPos(), and pageImage.

double gui::PageSpace::convertPixmapPosToPdfPos_x	(	double	fromX,
		double	fromY
	)			`[slot]`

Function return X position in pdf page from position of viewed page on screen (unapply rotation, viewing dpi, ...)

Parameters:

	fromX	X position on viewed page.
	fromY	Y position on viewed page.

Returns:: Return X position in pdf page.

See also:: convertPixmapPosToPdfPos_y; convertPixmapPosToPdfPos; convertPdfPosToPixmapPos

References gui::PageViewS::convertPixmapPosToPdfPos(), and pageImage.

double gui::PageSpace::convertPixmapPosToPdfPos_y	(	double	fromX,
		double	fromY
	)			`[slot]`

Function return Y position in pdf page from position of viewed page on screen (unapply rotation, viewing dpi, ...)

Parameters:

	fromX	X position on viewed page.
	fromY	Y position on viewed page.

Returns:: Return Y position in pdf page.

See also:: convertPixmapPosToPdfPos_x; convertPixmapPosToPdfPos; convertPdfPosToPixmapPos

References gui::PageViewS::convertPixmapPosToPdfPos(), and pageImage.

double gui::PageSpace::convertUnits	(	double	num,
		const QString	fromUnits = `QString::null`,
		const QString	toUnits = `QString::null`
	)			const `[slot]`

Convert value from one unit to other.

Parameters:

	num	Value for conversion.
	fromUnits	Unit of value num.
	toUnits	To which unit is required conversion of value num.

If fromUnits or toUnits is not set, then default unit use.

Returns:: Return value num conversed to unit toUnits.

References actualUnits, and gui::Units::convertUnits().

Referenced by showMousePosition().

void gui::PageSpace::deleteSelection ( ) [signal]

Signal emitted, when selected objects on page should be deleted.

Referenced by setSelectionMode().

void gui::PageSpace::executeCommand ( QString cmd ) [signal]

Signal emitted when command in script needs to be executed

Parameters:

cmd

Command for executing.

Referenced by setSelectionMode().

int gui::PageSpace::findText	(	QString &	text,
		bool	startAtTop = `true`,
		double	xStart = `0`,
		double	yStart = `0`,
		double	xEnd = `-1`,
		double	yEnd = `-1`
	)			`[slot]`

Function find text in actual viewed page, and select all operators whitch contains this text.

Parameters:

	text	Text for find.
	startAtTop	Start search text at top of page, if is TRUE (default). Otherwise start search at ...
	xStart
	yStart
	xEnd
	yEnd

Returns:: Return count of founded text.

References actualPage, util::convertFromUnicode(), debug::DBG_DBG, iterator::DoubleListIterator< Item >::getCurrent(), guiPrintDbg, iterator::DoubleListIterator< Item >::isEnd(), _JM_NAMESPACE::max(), _JM_NAMESPACE::min(), iterator::DoubleListIterator< Item >::next(), util::PDF, selectionMode, pdfobjects::TextSearchParams::startAtTop, unselectObjectOnPage(), pdfobjects::TextSearchParams::xEnd, pdfobjects::TextSearchParams::xStart, pdfobjects::TextSearchParams::yEnd, and pdfobjects::TextSearchParams::yStart.

void gui::PageSpace::firstPage ( ) [slot]

Change viewed page to first page of documents If nothing page is viewed, nothing view

See also:: prevPage; nextPage; lastPage

References actualPdf, gui::QSPdf::get(), and refresh().

Referenced by nextPage(), and prevPage().

QStringList gui::PageSpace::getAllUnitIds ( ) const [slot]

Function return identifiers of all units internal defined.

Returns:: Return identifiers of units.

References actualUnits, and gui::Units::getAllUnitIds().

QStringList gui::PageSpace::getAllUnits ( ) const [slot]

Function return description of all units internal defined.

Returns:: Return description of units.

References actualUnits, and gui::Units::getAllUnits().

QString gui::PageSpace::getDefaultUnits ( ) const [slot]

Method return default conversion unit.

Returns:: Return defualt unit.

References actualUnits, and gui::Units::getDefaultUnits().

QString gui::PageSpace::getDescriptionForUnit ( const QString _unit ) const [slot]

Method return description for unit.

Parameters:

_unit

Which unit is required description.

Returns:: Description for _unit. If nothing description found for _unit, return _unit.

References actualUnits, and gui::Units::getDescriptionForUnit().

int gui::PageSpace::getResizingZone ( ) [slot]

Function return actual set width of resizing zone

Returns:: Actual set resizing zone

References gui::DEFAULT__RESIZINGZONE, gui::globalSettings, gui::PAGESPC, gui::Settings::readNum(), gui::RESIZINGZONE, and selectionMode.

QMainWindow * gui::PageSpace::getTextLine	(	int	x,
		int	y,
		int	fontsize = `12`,
		const QString &	fontName = `QString::null`
	)			`[slot]`

Get pointer to insance of widget to show only edit line.

Parameters:

	x	Global X position for showing edit line.
	y	Global Y position for showing edit line.
	fontsize	To which font size will be set text in edit line.
	fontName	To which font will be set text in edit line.

Returns:: Return instance of widget to show only edit line.

References gui::TextLine::setText(), and textLine.

QString gui::PageSpace::getUnitFromAlias ( const QString _unit ) const [slot]

Function return unit from its aliases or description.

Parameters:

_unit

Alias or description of unit.

Returns:: Return unit for alias _unit. If alias _unit is not find in internal aliases or descrition, return _unit.

References actualUnits, and gui::Units::getUnitFromAlias().

float gui::PageSpace::getZoomFactor ( ) [slot]

Function return actual zoom factor of viewed page.

Returns:: Return zoom factor (1.0 = 100%)

See also:: setZoomFactor; zoomTo; zoomIn; zoomOut

References gui::PageViewS::getZoomFactor(), and pageImage.

Referenced by gui::ToolFactory::specialItem().

void gui::PageSpace::hidePageNumberAndPosition ( ) [slot]

Hide bar for view number of actual viewed page and mouse position on page.

See also:: showPageNumberAndPosition

References mousePositionOnPage, and pageNumber.

bool gui::PageSpace::isSomeoneSelected ( ) [slot]

Function return if some object is selected (not in selection mode PageView::SelectRect)

Returns:: Return TRUE, if some object is selected. Otherwise return FALSE.

References selectionMode.

void gui::PageSpace::lastPage ( ) [slot]

Change viewed page to last page of documents If nothing page is viewed, nothing view

See also:: firstPage; prevPage; nextPage

References actualPdf, gui::QSPdf::get(), and refresh().

void gui::PageSpace::newSelection ( const std::vector< boost::shared_ptr< CAnnotation > > & objects ) [private, slot]

On this slot is connected same named signal from class viewed the page (see pageImage).

Parameters:

objects

Vector of selected annotations.

This method emit signal "changeSelection".

References changeSelection().

void gui::PageSpace::newSelection ( const std::vector< boost::shared_ptr< PdfOperator > > & objects ) [private, slot]

On this slot is connected same named signal from class viewed the page (see pageImage).

Parameters:

objects

Vector of selected operators.

This method emit signal "changeSelection".

References changeSelection().

Referenced by setSelectionMode().

void gui::PageSpace::nextPage ( ) [slot]

Change viewed page to next page in documents If nothing page is viewed, nothing view

See also:: firstPage; prevPage; lastPage

References actualPage, actualPagePos, actualPdf, firstPage(), gui::QSPdf::get(), and refresh().

void gui::PageSpace::popupMenu ( const QPoint & pagePos ) [signal]

Signal emitted when popup menu for page is requested

Parameters:

pagePos

Position on the page when popup menu was invoked.

Referenced by requestPopupMenu(), and setSelectionMode().

void gui::PageSpace::prevPage ( ) [slot]

Change viewed page to previous page in documents If nothing page is viewed, nothing view

See also:: firstPage; nextPage; lastPage

References actualPage, actualPagePos, actualPdf, firstPage(), gui::QSPdf::get(), and refresh().

void gui::PageSpace::refresh	(	int	pageToView,
		QObject *	pdf
	)			`[slot]`

Method for refreshing page on screen.

Parameters:

	pageToView	Page position in pdf for refresh. If page is other then actual viewed, view this new page. Nothing do, if page position don't exist in pdf
	pdf	Pdf in whitch is pageToView. If pdf is NULL then pageToView is from same pdf as actual viewed page, if exist actual viewed page. Otherwise don't view pageToView.

See also:: refresh(QSPage*,QSPdf*)

References refresh().

void gui::PageSpace::refresh	(	int	pageToView,
		QSPdf *	pdf = `NULL`
	)			`[slot]`

Method for refreshing page on screen.

Parameters:

	pageToView	Page position in pdf for refresh. If page is other then actual viewed, view this new page. Nothing do, if page position don't exist in pdf
	pdf	Pdf in whitch is pageToView. If pdf is NULL then pageToView is from same pdf as actual viewed page, if exist actual viewed page. Otherwise don't view pageToView.

See also:: refresh(QSPage*,QSPdf*)

References actualPdf, gui::QSPdf::get(), and refresh().

void gui::PageSpace::refresh	(	QSPage *	pageToView,
		QObject *	pdf
	)			`[slot]`

Method for refreshing page on screen and actualize selected objects.

Parameters:

	pageToView	Page for refresh. If pageToView is other then actual viewed, view this new page. (default is set to NULL = refresh actual viewed page)
	pdf	Pdf in whitch is pageToView. If pdf is NULL then pageToView is from same pdf as actual view page, if exist actual viewed page. Otherwise don't view pageToView.

See also:: refresh(int,QSPdf)

References refresh().

void gui::PageSpace::refresh	(	QSPage *	pageToView = `NULL`,
		QSPdf *	pdf = `NULL`
	)			`[slot]`

Method for refreshing page on screen and actualize selected objects.

Parameters:

	pageToView	Page for refresh. If pageToView is other then actual viewed, view this new page. (default is set to NULL = refresh actual viewed page)
	pdf	Pdf in whitch is pageToView. If pdf is NULL then pageToView is from same pdf as actual view page, if exist actual viewed page. Otherwise don't view pageToView.

See also:: refresh(int,QSPdf)

References actualPage, actualPagePos, actualPdf, changedPageTo(), gui::QSPdf::get(), gui::QSPage::get(), gui::QSPdf::getPageCount(), pageImage, pageNumber, and gui::PageViewS::showPage().

Referenced by firstPage(), lastPage(), nextPage(), prevPage(), and refresh().

void gui::PageSpace::requestPopupMenu ( const QPoint & p ) [private, slot]

On this slot is connected same named signal from class viewed the page (see pageImage).

Parameters:

p

Position on the page over which is calling popup menu.

This method emit signal "popupMenu".

References popupMenu().

Referenced by setSelectionMode().

bool gui::PageSpace::saveImage	(	const QString &	filename,
		const char *	format,
		int	quality = `-1`,
		bool	onlySelectedArea = `false`
	)			`[slot]`

Function save viewed page to file.

Parameters:

	filename	Name of destination file.
	format	Format of file (see QImageIO::outputFormats)
	quality	Quality factor. Must be in range [0, 100] or -1 (default) (see QPixmap::save for more)
	onlySelectedArea	Save all page, if is FALSE (default). Otherwise save only bounding rectangle of selected area.

Returns:: Return TRUE, if image is saved. Otherwise return FALSE.

See also:: saveImageWithDialog

References debug::DBG_DBG, guiPrintDbg, pageImage, and gui::PageViewS::saveImage().

Referenced by saveImageWithDialog().

bool gui::PageSpace::saveImageWithDialog ( bool onlySelectedArea = false ) [slot]

Function save viewed page to file and for choose destination file view dialog with all available destination file format.

Parameters:

onlySelectedArea

Save all page, if is FALSE (default). Otherwise save only bounding rectangle of selected area.

Returns:: Return TRUE, if image is saved. Otherwise return FALSE.

See also:: saveImage

References saveImage().

void gui::PageSpace::selectObjectOnPage ( const std::vector< boost::shared_ptr< PdfOperator > > & ops ) [slot]

Select objects (PdfOperators) on page.

Parameters:

ops

Vector of PdfOperators for select.

See also:: addSelectedObjectOnPage; unselectObjectOnPage; isSomeoneSelected

References selectionMode.

bool gui::PageSpace::setDefaultUnits ( const QString dunits = QString::null ) [slot]

Method set default unit for conversion.

Parameters:

dunits

Unit for set as default. Nothing chenage, if not find in internal units.

Returns:: Return true if default unit is change to dunits. Otherwise return false.

References actualUnits, and gui::Units::setDefaultUnits().

void gui::PageSpace::setResizingZone ( int width ) [slot]

Method set width of resizing zone

Parameters:

width

width in pixels

Default is set to 2.

References debug::DBG_INFO, gui::globalSettings, guiPrintDbg, gui::PAGESPC, gui::RESIZINGZONE, selectionMode, and gui::Settings::write().

void gui::PageSpace::setSelectArea	(	int	left,
		int	top,
		int	right,
		int	bottom
	)			`[slot]`

Select area on viewed page.

Parameters:

	left	X position of lefttop edge of new select rectangle
	top	Y position of lefttop edge of new select rectangle
	right	X position of rightbottom edge of new select rectangle
	bottom	Y position of rightbottom edge of new select rectangle

Position is in pixels on viewed page, not in pdf (see PageSpace::convertPdfPosToPixmapPos for convert position)

References selectionMode.

void gui::PageSpace::setSelectionMode	(	QString	mode,
		QString	drawingObject = `QString::null`,
		QString	scriptFncAtMouseRelease = `QString::null`,
		QString	scriptFncAtMoveSelectedObjects = `QString::null`,
		QString	scriptFncAtResizeSelectedObjects = `QString::null`
	)			`[slot]`

Set selection mode.

Parameters:

	mode	Mode for selection.
	drawingObject	What be drawing in mode
	scriptFncAtMouseRelease	Name of function in script, which be call at mouse left button release
	scriptFncAtMoveSelectedObjects	Name of function in script, which be call at mouse moved with selected area
	scriptFncAtResizeSelectedObjects	Name of function in script, which be call at mouse resize selected area