Switches the current document to print preview mode. More...

Inheritance diagram for PrintPreview:

Public Member Functions
void	beginEvent ()
	Called when the user starts this action by clicking a button, choosing a menu, entering a command, etc.
void	colorModeUpdate ()
void	drawGlueMargins (void path, void border)
	Draws the glue margins for the given page.
void	drawPaper (void path, void border)
	Draws the paper border for the given page.
void	drawShadow (void path, void border)
	Draws the shadow for the given page.
void	finishEvent ()
	Called when this action is terminated.
void	getPaperBox ()
void	hideUiOptions ()
	Hides the UI options of this action.
void	initScaleCombo ()
void	initUiOptions (void resume)
	Initializes the scale combo box in the options toolbar with defaults.
void	mouseMoveEvent (void event)
	Implements moving of paper (offset).
void	mousePressEvent (void event)
	Implements moving of paper (offset).
void	mouseReleaseEvent (void event)
	Reimplemented from EAction to prevent that a right-click closes the print preview.
void	PrintPreview (void guiAction)
void	setState (void state)
	Handles additional state changes for offset moving state.
void	showUiOptions (void resume)
	Reimplementation from EAction.
void	slotAutoCenter ()
void	slotAutoFitDrawing ()
	Auto fit drawing button clicked in options toolbar.
void	slotAutoFitPages ()
	Auto fit number of pages to drawing size.
void	slotAutoZoomToPages ()
void	slotBlackWhiteChanged (void checked)
void	slotDone ()
	Triggered by the "Done" button in the options toolbar.
void	slotFullColorChanged (void checked)
	Triggered by the b/w button in the options toolbar.
void	slotGrayscaleChanged (void checked)
void	slotLandscapeChanged ()
void	slotMultiPagesButton ()
	Multi page button clicked in options toolbar.
void	slotOffsetChanged (void checked)
	Triggered by the offset tool button in the options toolbar.
void	slotOnePageButton ()
	One page button clicked in options toolbar.
void	slotPaperSizeChanged (void index)
	Temporarily disabled.
void	slotPdfExport ()
void	slotPortraitChanged ()
void	slotPrint (void pdfFile)
void	slotPrintCropMarksChanged (void checked)
	Crop marks toggled in options toolbar.
void	slotScaleChanged (void scaleString)
	Called whenever the user changes the drawing scale in the print preview.
void	slotShowPaperBordersChanged (void checked)
	Page borders toggled in options toolbar.
void	suspendEvent ()
	Called whenver the action is suspended, for example if another action is started while this action is active.
void	updateBackgroundDecoration ()
	Called to update the background decoration (paper borders) if the scale or paper settings change.
void	updateBackgroundTransform ()
	Updates the background decoration transformation.
Public Member Functions inherited from DefaultAction
void	coordinateEvent (void event)
	Default implementation.
void	coordinateEventPreview (void event)
	Default implementation.
void	DefaultAction (void guiAction)
void	escapeEvent (void event)
	Called when the user presses Escape or clicks the right mouse button.
void	mouseDoubleClickEvent (void event)
void	resumeEvent ()
	Called whenver the action resumes its operation, for example after it was temporary suspended for another action.
Public Member Functions inherited from EAction
void	applyCommand (void event, void preview)
	High level event triggered when a command line command should be applied or previewed.
void	applyOperation ()
	Applies the operation returned by this.getOperation().
void	commandEvent (void event)
	Default implementation.
void	commandEventPreview (void event)
	Default implementation.
void	createDialog (void uiFile, void parent)
	Creates a new dialog based on the given UI file with the given parent.
void	createWidget (void uiFile, void parent)
	Creates a new widget based on the given UI file with the given parent.
void	EAction (void guiAction)
void	entityPickEvent (void event)
	Default implementation.
void	entityPickEventPreview (void event)
	Default implementation.
void	getAuxPreview ()
	Called by updatePreview.
void	getDocumentInterface ()
void	getHighlightedEntities ()
	Called by updatePreview.
void	getOperation (void preview)
	Called by updatePreview.
void	getScales ()
void	initState ()
	Called to initialize a new state of this action.
void	keyPressEvent (void event)
	Called when the user presses a key.
void	keyReleaseEvent (void event)
	Called when the user releases a key.
void	pickCoordinate (void event, void preview)
	High level event triggered when a coordinate was specified by the user of a coordinate specification should be previewed.
void	pickEntity (void event, void preview)
	High level event triggered when an entity was picked by the user or to preview picking an entity.
void	propertyChangeEvent (void event)
	Allows all actions to handle property change events.
void	setArrowCursor ()
	Sets the current cursor of the current document interface (all views attached to it) to the normal arrow cursor.
void	setCommandPrompt (void prompt)
void	setCrosshairCursor ()
	Sets the current cursor of the current document interface (all views attached to it) to crosshair cursor.
void	setLeftMouseTip (void tip)
void	setRightMouseTip (void tip)
void	setUiOptions (void uiFile, void split)
	Sets the UI options toolbar content for this tool.
void	showUiOptions (void resume, void restoreFromSettings)
	Shows the UI options of this action if this.uiFile is set.
void	simulateMouseMoveEvent ()
void	slotReset ()
	Called if the user clicks the reset button of an action.
void	updatePreview (void clear)
	Updates the preview based on the operation returned by getOperation and the auxiliary construction returned be getAuxPreview.
Public Member Functions inherited from RActionAdapter
virtual void	commandEvent (RCommandEvent &)
	Called when a command is entered in the command line.
virtual void	commandEventPreview (RCommandEvent &)
	Called when a command is being edited in the command line.
virtual void	coordinateEvent (RCoordinateEvent &)
	Called for every coordinate event.
virtual void	coordinateEventPreview (RCoordinateEvent &)
	Called if the action is in `PickCoordinate` mode and the mouse is moved around.
virtual void	entityPickEvent (REntityPickEvent &)

virtual void	entityPickEventPreview (REntityPickEvent &)

virtual void	keyPressEvent (QKeyEvent &)
virtual void	keyReleaseEvent (QKeyEvent &)
virtual void	mouseDoubleClickEvent (RMouseEvent &)
	Called on mouse double click events.
virtual void	mouseMoveEvent (RMouseEvent &)
	Called on mouse move events.
virtual void	mousePressEvent (RMouseEvent &)
	Called on mouse press events.
virtual void	mouseReleaseEvent (RMouseEvent &)
	Called on mouse release events.
virtual void	panGestureEvent (QPanGesture &)
	Called on pan gesture events.
virtual void	pinchGestureEvent (QPinchGesture &)
	Called on pinch gesture events.
virtual void	propertyChangeEvent (RPropertyEvent &)
	Called when the value of a property is modified while this action is active.
	RActionAdapter (RGuiAction *guiAction=NULL)
virtual void	setGraphicsView (RGraphicsView *)
	Called if this action is set as a navigation action of a graphics view.
virtual void	swipeGestureEvent (QSwipeGesture &)
	Called on swipe gesture events.
virtual void	tabletEvent (RTabletEvent &)
	Called on tablet events.
virtual void	wheelEvent (RWheelEvent &)
	Called on mouse wheel events.
Public Member Functions inherited from RAction
RAction::ClickMode	getClickMode ()
RDocument *	getDocument ()
QList< RGraphicsScene * >	getGraphicsScenes ()
virtual RGuiAction *	getGuiAction ()
RAction *	getOverrideBase ()
RStorage *	getStorage ()
QString	getUniqueGroup ()
bool	hasNoState ()
bool	isOverride ()
bool	isTerminated ()
	RAction (RGuiAction *guiAction=NULL)
void	setClickMode (RAction::ClickMode m)
	Sets the current click mode.
void	setDocumentInterface (RDocumentInterface *di)
void	setGuiAction (RGuiAction *guiAction)
void	setNoState ()
void	setOverride ()
void	setOverrideBase (RAction *base)
void	setUniqueGroup (const QString &ug)
RVector	snap (RMouseEvent &event)
	Uses the currently active snap function to snap to the closest object or grid point.
void	terminate ()
	Terminates the action.
virtual	~RAction ()

Public Attributes
int	cursor
int	enableSlotPaperSizeChanged
int	mpColumns
int	mpRows
int	panningOffset
int	panOffsetOrigin
int	updateDisabled
int	view

Detailed Description

Switches the current document to print preview mode.

In print preview mode, the paper is shown in the background of the drawing.

Constructor & Destructor Documentation

void PrintPreview::PrintPreview ( void guiAction )

inline

Member Function Documentation

void PrintPreview::beginEvent ( void )

inlinevirtual

Called when the user starts this action by clicking a button, choosing a menu, entering a command, etc.

Shows the GUI elements that refer to this action as checked. Displays GUI options if this.uiFile is set to a valid UI file. Displays tool help in Help Viewer if available.

Reimplemented from DefaultAction.

void PrintPreview::colorModeUpdate ( )

inline

void PrintPreview::drawGlueMargins	(	void	path,
		void	border
	)

inline

Draws the glue margins for the given page.

void PrintPreview::drawPaper	(	void	path,
		void	border
	)

inline

Draws the paper border for the given page.

void PrintPreview::drawShadow	(	void	path,
		void	border
	)

inline

Draws the shadow for the given page.

void PrintPreview::finishEvent ( void )

inlinevirtual

Called when this action is terminated.

Shows the GUI elements that refer to this action as un-checked. Hides GUI options if this.uiFile is set to a valid UI file. Clears up mouse tips, etc.

Reimplemented from EAction.

void PrintPreview::getPaperBox ( )

inline

void PrintPreview::hideUiOptions ( void saveToSettings )

inline

Hides the UI options of this action.

Usually this function does not need to be called directly by implementing actions.

Parameters:

saveToSettings if true, the state is saved to settings

Reimplemented from EAction.

void PrintPreview::initScaleCombo ( )

inline

void PrintPreview::initUiOptions ( void resume )

inline

Initializes the scale combo box in the options toolbar with defaults.

Reimplemented from EAction.

void PrintPreview::mouseMoveEvent ( void event )

inline

Implements moving of paper (offset).

Reimplemented from DefaultAction.

void PrintPreview::mousePressEvent ( void event )

inline

Implements moving of paper (offset).

Reimplemented from DefaultAction.

void PrintPreview::mouseReleaseEvent ( void event )

inline

Reimplemented from EAction to prevent that a right-click closes the print preview.

TODO implemented twice, see #311

Reimplemented from DefaultAction.

void PrintPreview::setState ( void state )

inline

Handles additional state changes for offset moving state.

Reimplemented from DefaultAction.

void PrintPreview::showUiOptions ( void resume )

inline

Reimplementation from EAction.

Implements initialization of options toolbar from member variables.

void PrintPreview::slotAutoCenter ( )

inline

void PrintPreview::slotAutoFitDrawing ( )

inline

Auto fit drawing button clicked in options toolbar.

void PrintPreview::slotAutoFitPages ( )

inline

Auto fit number of pages to drawing size.

void PrintPreview::slotAutoZoomToPages ( )

inline

void PrintPreview::slotBlackWhiteChanged ( void checked )

inline

void PrintPreview::slotDone ( )

inline

Triggered by the "Done" button in the options toolbar.

Terminates this action and returns to normal drawing mode.

void PrintPreview::slotFullColorChanged ( void checked )

inline

Triggered by the b/w button in the options toolbar.

Activates / deactivates the black white mode.

void PrintPreview::slotGrayscaleChanged ( void checked )

inline

void PrintPreview::slotLandscapeChanged ( )

inline

void PrintPreview::slotMultiPagesButton ( )

inline

Multi page button clicked in options toolbar.

void PrintPreview::slotOffsetChanged ( void checked )

inline

Triggered by the offset tool button in the options toolbar.

Activates / deactivates the offset tool.

void PrintPreview::slotOnePageButton ( )

inline

One page button clicked in options toolbar.

void PrintPreview::slotPaperSizeChanged ( void index )

inline

Temporarily disabled.

void PrintPreview::slotPdfExport ( )

inline

void PrintPreview::slotPortraitChanged ( )

inline

void PrintPreview::slotPrint ( void pdfFile )

inline

void PrintPreview::slotPrintCropMarksChanged ( void checked )

inline

Crop marks toggled in options toolbar.

void PrintPreview::slotScaleChanged ( void scaleString )

inline

Called whenever the user changes the drawing scale in the print preview.

void PrintPreview::slotShowPaperBordersChanged ( void checked )

inline

Page borders toggled in options toolbar.

void PrintPreview::suspendEvent ( )

inlinevirtual

Called whenver the action is suspended, for example if another action is started while this action is active.

Reimplemented from DefaultAction.

void PrintPreview::updateBackgroundDecoration ( )

inline

Called to update the background decoration (paper borders) if the scale or paper settings change.

void PrintPreview::updateBackgroundTransform ( )

inline

Updates the background decoration transformation.

Member Data Documentation

int PrintPreview::cursor

int PrintPreview::enableSlotPaperSizeChanged

int PrintPreview::mpColumns

int PrintPreview::mpRows

int PrintPreview::panningOffset

int PrintPreview::panOffsetOrigin

int PrintPreview::updateDisabled

int PrintPreview::view

The documentation for this class was generated from the following file:

scripts/File/PrintPreview/PrintPreview.js

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation