Graphics scene for map printing. More...

#include <qgscomposition.h>

Inheritance diagram for QgsComposition:

Collaboration diagram for QgsComposition:

Public Types
enum	PlotStyle { Preview = 0, Print, Postscript }
	Plot type. More...

enum	GridStyle { Solid, Dots, Crosses }
	Style to draw the snapping grid. More...

enum	ZValueDirection { ZValueBelow, ZValueAbove }

enum	AtlasMode { AtlasOff, PreviewAtlas, ExportAtlas }
	Composition atlas modes. More...

Public Slots
void	sendItemAddedSignal (QgsComposerItem *item)
	Casts object to the proper subclass type and calls corresponding itemAdded signal. More...

void	updateBounds ()
	Updates the scene bounds of the composition. More...

void	refreshItems ()
	Forces items in the composition to refresh. More...

void	setSelectedItem (QgsComposerItem *item)
	Clears any selected items and sets an item as the current selection. More...

Signals
void	paperSizeChanged ()

void	nPagesChanged ()

void	printResolutionChanged ()
	Is emitted when the compositions print resolution changes. More...

void	selectedItemChanged (QgsComposerItem *selected)
	Is emitted when selected item changed. More...

void	composerArrowAdded (QgsComposerArrow *arrow)
	Is emitted when new composer arrow has been added to the view. More...

void	composerHtmlFrameAdded (QgsComposerHtml html, QgsComposerFrame frame)
	Is emitted when a new composer html has been added to the view. More...

void	composerLabelAdded (QgsComposerLabel *label)
	Is emitted when new composer label has been added to the view. More...

void	composerMapAdded (QgsComposerMap *map)
	Is emitted when new composer map has been added to the view. More...

void	composerScaleBarAdded (QgsComposerScaleBar *scalebar)
	Is emitted when new composer scale bar has been added. More...

void	composerLegendAdded (QgsComposerLegend *legend)
	Is emitted when a new composer legend has been added. More...

void	composerPictureAdded (QgsComposerPicture *picture)
	Is emitted when a new composer picture has been added. More...

void	composerShapeAdded (QgsComposerShape *shape)
	Is emitted when a new composer shape has been added. More...

void	composerTableAdded (QgsComposerAttributeTable *table)
	Is emitted when a new composer table has been added. More...

void	itemRemoved (QgsComposerItem *)
	Is emitted when a composer item has been removed from the scene. More...

void	refreshItemsTriggered ()
	Is emitted when item in the composition must be refreshed. More...

void	statusMsgChanged (QString message)
	Is emitted when the composition has an updated status bar message for the composer window. More...

Public Member Functions
Q_DECL_DEPRECATED	QgsComposition (QgsMapRenderer *mapRenderer)

	QgsComposition (const QgsMapSettings &mapSettings)

	~QgsComposition ()

void	setPaperSize (double width, double height)
	Changes size of paper item. More...

double	paperHeight () const
	Returns height of paper item. More...

double	paperWidth () const
	Returns width of paper item. More...

double	spaceBetweenPages () const

void	setNumPages (int pages)
	Note: added in version 1.9. More...

int	numPages () const
	Note: added in version 1.9. More...

void	setPageStyleSymbol (QgsFillSymbolV2 *symbol)
	Note: added in version 2.1. More...

QgsFillSymbolV2 *	pageStyleSymbol ()
	Note: added in version 2.1. More...

QPointF	positionOnPage (const QPointF &position) const
	Returns the position within a page of a point in the composition. More...

int	pageNumberForPoint (const QPointF &position) const
	Returns the page number corresponding to a point in the composition. More...

void	setStatusMessage (const QString &message)
	Sets the status bar message for the composer window. More...

void	updateSettings ()
	Refreshes the composition when composer related options change Note: added in version 2.1. More...

void	setSnapToGridEnabled (bool b)

bool	snapToGridEnabled () const

void	setGridVisible (bool b)

bool	gridVisible () const

void	setSnapLinesVisible (bool visible)
	Hides / shows custom snap lines. More...

bool	snapLinesVisible () const

void	setAlignmentSnap (bool s)

bool	alignmentSnap () const

void	setSmartGuidesEnabled (bool b)

bool	smartGuidesEnabled () const

void	clearSnapLines ()
	Removes all snap lines. More...

void	setSnapGridResolution (double r)

double	snapGridResolution () const

void	setSnapGridTolerance (double tolerance)

double	snapGridTolerance () const

void	setSnapGridOffsetX (double offset)

double	snapGridOffsetX () const

void	setSnapGridOffsetY (double offset)

double	snapGridOffsetY () const

void	setGridPen (const QPen &p)

const QPen &	gridPen () const

void	setGridStyle (GridStyle s)

GridStyle	gridStyle () const

void	setAlignmentSnapTolerance (double t)

double	alignmentSnapTolerance () const

QUndoStack *	undoStack ()
	Returns pointer to undo/redo command storage. More...

QgsComposerItem *	composerItemAt (const QPointF &position)
	Returns the topmost composer item. More...

QgsComposerItem *	composerItemAt (const QPointF &position, const QgsComposerItem *belowItem)
	Returns the highest composer item at a specified position which is below a specified item. More...

int	pageNumberAt (const QPointF &position) const
	Returns the page number (0-bsaed) given a coordinate. More...

int	itemPageNumber (const QgsComposerItem *) const
	Returns on which page number (0-based) is displayed an item. More...

QList< QgsComposerItem * >	selectedComposerItems ()

QList< const QgsComposerMap * >	composerMapItems () const
	Returns pointers to all composer maps in the scene. More...

template<class T >
void	composerItems (QList< T * > &itemList)
	Return composer items of a specific type. More...

const QgsComposerMap *	getComposerMapById (int id) const
	Returns the composer map with specified id. More...

const QgsComposerHtml *	getComposerHtmlByItem (QgsComposerItem *item) const
	Returns the composer html with specified id (a string as named in the composer user interface item properties). More...

const QgsComposerItem *	getComposerItemById (QString theId) const
	Returns a composer item given its text identifier. More...

const QgsComposerItem *	getComposerItemByUuid (QString theUuid) const
	Returns a composer item given its unique identifier. More...

int	printResolution () const

void	setPrintResolution (int dpi)

bool	printAsRaster () const

void	setPrintAsRaster (bool enabled)

bool	generateWorldFile () const

void	setGenerateWorldFile (bool enabled)

QgsComposerMap *	worldFileMap () const

void	setWorldFileMap (QgsComposerMap *map)

bool	useAdvancedEffects () const
	Returns true if a composition should use advanced effects such as blend modes. More...

void	setUseAdvancedEffects (bool effectsEnabled)
	Used to enable or disable advanced effects such as blend modes in a composition. More...

Q_DECL_DEPRECATED QgsMapRenderer *	mapRenderer ()
	Returns pointer to map renderer of qgis map canvas. More...

const QgsMapSettings &	mapSettings () const
	Return setting of QGIS map canvas. More...

QgsComposition::PlotStyle	plotStyle () const

void	setPlotStyle (QgsComposition::PlotStyle style)

int	pixelFontSize (double pointSize) const
	Returns the pixel font size for a font that has point size set. More...

double	pointFontSize (int pixelSize) const
	Does the inverse calculation and returns points for pixels (equals to mm in QgsComposition) More...

bool	writeXML (QDomElement &composerElem, QDomDocument &doc)
	Writes settings to xml (paper dimension) More...

bool	readXML (const QDomElement &compositionElem, const QDomDocument &doc)
	Reads settings from xml file. More...

bool	loadFromTemplate (const QDomDocument &doc, QMap< QString, QString > *substitutionMap=0, bool addUndoCommands=false)
	Load a template document. More...

void	addItemsFromXML (const QDomElement &elem, const QDomDocument &doc, QMap< QgsComposerMap , int > mapsToRestore=0, bool addUndoCommands=false, QPointF *pos=0, bool pasteInPlace=false)
	Add items from XML representation to the graphics scene (for project file reading, pasting items from clipboard) More...

void	addItemToZList (QgsComposerItem *item)
	Adds item to z list. More...

void	removeItemFromZList (QgsComposerItem *item)
	Removes item from z list. More...

void	raiseSelectedItems ()

void	raiseItem (QgsComposerItem *item)

void	lowerSelectedItems ()

void	lowerItem (QgsComposerItem *item)

void	moveSelectedItemsToTop ()

void	moveItemToTop (QgsComposerItem *item)

void	moveSelectedItemsToBottom ()

void	moveItemToBottom (QgsComposerItem *item)

void	selectNextByZOrder (ZValueDirection direction)

QgsComposerItem *	getComposerItemBelow (QgsComposerItem *item)

QgsComposerItem *	getComposerItemAbove (QgsComposerItem *item)

void	alignSelectedItemsLeft ()

void	alignSelectedItemsHCenter ()

void	alignSelectedItemsRight ()

void	alignSelectedItemsTop ()

void	alignSelectedItemsVCenter ()

void	alignSelectedItemsBottom ()

void	lockSelectedItems ()
	Lock the selected items. More...

void	unlockAllItems ()
	Unlock all items. More...

void	sortZList ()
	Sorts the zList. More...

void	refreshZList ()
	Rebuilds the z order list based on current order of items in scene. More...

QPointF	snapPointToGrid (const QPointF &scenePoint) const
	Snaps a scene coordinate point to grid. More...

QList< QGraphicsLineItem * > *	snapLines ()
	Returns pointer to snap lines collection. More...

QgsComposerMouseHandles *	selectionHandles ()
	Returns pointer to selection handles. More...

QGraphicsLineItem *	addSnapLine ()
	Add a custom snap line (can be horizontal or vertical) More...

void	removeSnapLine (QGraphicsLineItem *line)
	Remove custom snap line (and delete the object) More...

QGraphicsLineItem *	nearestSnapLine (bool horizontal, double x, double y, double tolerance, QList< QPair< QgsComposerItem *, QgsComposerItem::ItemPositionMode > > &snappedItems)
	Get nearest snap line. More...

void	beginCommand (QgsComposerItem *item, const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
	Allocates new item command and saves initial state in it. More...

void	endCommand ()
	Saves end state of item and pushes command to the undo history. More...

void	cancelCommand ()
	Deletes current command. More...

void	beginMultiFrameCommand (QgsComposerMultiFrame *multiFrame, const QString &text)

void	endMultiFrameCommand ()

void	addMultiFrame (QgsComposerMultiFrame *multiFrame)
	Adds multiframe. More...

void	removeMultiFrame (QgsComposerMultiFrame *multiFrame)
	Removes multi frame (but does not delete it) More...

void	addComposerArrow (QgsComposerArrow *arrow)
	Adds an arrow item to the graphics scene and advices composer to create a widget for it (through signal) More...

void	addComposerLabel (QgsComposerLabel *label)
	Adds label to the graphics scene and advices composer to create a widget for it (through signal) More...

void	addComposerMap (QgsComposerMap *map, bool setDefaultPreviewStyle=true)
	Adds map to the graphics scene and advices composer to create a widget for it (through signal) More...

void	addComposerScaleBar (QgsComposerScaleBar *scaleBar)
	Adds scale bar to the graphics scene and advices composer to create a widget for it (through signal) More...

void	addComposerLegend (QgsComposerLegend *legend)
	Adds legend to the graphics scene and advices composer to create a widget for it (through signal) More...

void	addComposerPicture (QgsComposerPicture *picture)
	Adds picture to the graphics scene and advices composer to create a widget for it (through signal) More...

void	addComposerShape (QgsComposerShape *shape)
	Adds a composer shape to the graphics scene and advices composer to create a widget for it (through signal) More...

void	addComposerTable (QgsComposerAttributeTable *table)
	Adds a composer table to the graphics scene and advices composer to create a widget for it (through signal) More...

void	addComposerHtmlFrame (QgsComposerHtml html, QgsComposerFrame frame)
	Adds composer html frame and advices composer to create a widget for it (through signal) More...

void	removeComposerItem (QgsComposerItem *item, bool createCommand=true)
	Remove item from the graphics scene. More...

void	pushAddRemoveCommand (QgsComposerItem *item, const QString &text, QgsAddRemoveItemCommand::State state=QgsAddRemoveItemCommand::Added)
	Convenience function to create a QgsAddRemoveItemCommand, connect its signals and push it to the undo stack. More...

void	setPreventCursorChange (bool preventChange)
	If true, prevents any mouse cursor changes by the composition or by any composer items Used by QgsComposer and QgsComposerView to prevent unwanted cursor changes. More...

bool	preventCursorChange ()

void	beginPrint (QPrinter &printer)
	Prepare the printer for printing. More...

void	beginPrintAsPDF (QPrinter &printer, const QString &file)
	Prepare the printer for printing in a PDF. More...

void	doPrint (QPrinter &printer, QPainter &painter)
	Print on a preconfigured printer. More...

bool	print (QPrinter &printer)
	Convenience function that prepares the printer and prints. More...

bool	exportAsPDF (const QString &file)
	Convenience function that prepares the printer for printing in PDF and prints. More...

QImage	printPageAsRaster (int page)
	print composer page to image If the image does not fit into memory, a null image is returned More...

void	renderPage (QPainter *p, int page)
	Render a page to a paint device. More...

void	computeWorldFileParameters (double &a, double &b, double &c, double &d, double &e, double &f) const
	Compute world file parameters. More...

QgsAtlasComposition &	atlasComposition ()

QgsComposition::AtlasMode	atlasMode () const
	Returns the current atlas mode of the composition. More...

bool	setAtlasMode (QgsComposition::AtlasMode mode)
	Sets the current atlas mode of the composition. More...

QList< QgsPaperItem * >	pages ()
	Return pages in the correct order. More...

Static Public Member Functions
static void	relativeResizeRect (QRectF &rectToResize, const QRectF &boundsBefore, const QRectF &boundsAfter)
	Resizes a QRectF relative to the change from boundsBefore to boundsAfter. More...

static double	relativePosition (double position, double beforeMin, double beforeMax, double afterMin, double afterMax)
	Returns a scaled position given a before and after range. More...

Protected Member Functions
void	init ()

Private Member Functions
void	createDefaultPageStyleSymbol ()

	QgsComposition ()

QRectF	compositionBounds () const
	Calculates the bounds of all non-gui items in the composition. More...

void	updateZValues (bool addUndoCommands=true)
	Reset z-values of items based on position in z list. More...

int	boundingRectOfSelectedItems (QRectF &bRect)
	Returns the bounding rectangle of the selected items in scene coordinates. More...

void	loadDefaults ()
	Loads default composer settings. More...

void	loadSettings ()
	Loads composer settings which may change, eg grid color. More...

QPointF	minPointFromXml (const QDomElement &elem) const
	Calculates the item minimum position from an xml string. More...

void	connectAddRemoveCommandSignals (QgsAddRemoveItemCommand *c)

void	updatePaperItems ()

void	addPaperItem ()

void	removePaperItems ()

void	deleteAndRemoveMultiFrames ()

Static Private Member Functions
static QString	encodeStringForXML (const QString &str)

Private Attributes
QgsMapRenderer *	mMapRenderer
	Pointer to map renderer of QGIS main map. More...

const QgsMapSettings &	mMapSettings

QgsComposition::PlotStyle	mPlotStyle

double	mPageWidth

double	mPageHeight

QList< QgsPaperItem * >	mPages

double	mSpaceBetweenPages

QgsFillSymbolV2 *	mPageStyleSymbol
	Drawing style for page. More...

QLinkedList< QgsComposerItem * >	mItemZList
	Maintains z-Order of items. More...

QSet< QgsComposerMultiFrame * >	mMultiFrames
	List multiframe objects. More...

int	mPrintResolution
	Dpi for printout. More...

bool	mPrintAsRaster
	Flag if map should be printed as a raster (via QImage). More...

bool	mGenerateWorldFile
	Flag if a world file should be generated on raster export. More...

QgsComposerMap *	mWorldFileMap
	Composer map to use for the world file generation. More...

bool	mUseAdvancedEffects
	Flag if advanced visual effects such as blend modes should be used. More...

bool	mSnapToGrid
	Parameters for snap to grid function. More...

bool	mGridVisible

double	mSnapGridResolution

double	mSnapGridTolerance

double	mSnapGridOffsetX

double	mSnapGridOffsetY

QPen	mGridPen

GridStyle	mGridStyle

bool	mAlignmentSnap
	Parameters for alignment snap. More...

bool	mGuidesVisible

bool	mSmartGuides

double	mAlignmentSnapTolerance

QList< QGraphicsLineItem * >	mSnapLines
	Arbitraty snap lines (horizontal and vertical) More...

QgsComposerMouseHandles *	mSelectionHandles

QUndoStack	mUndoStack

QgsComposerItemCommand *	mActiveItemCommand

QgsComposerMultiFrameCommand *	mActiveMultiFrameCommand

QgsAtlasComposition	mAtlasComposition
	The atlas composition object. More...

QgsComposition::AtlasMode	mAtlasMode

bool	mPreventCursorChange

Detailed Description

Graphics scene for map printing.

The class manages the paper item which always is the item in the back (z-value 0). It maintains the z-Values of the items and stores them in a list in ascending z-Order. This list can be changed to lower/raise items one position or to bring them to front/back.

Definition at line 66 of file qgscomposition.h.

Member Enumeration Documentation

enum QgsComposition::AtlasMode

Composition atlas modes.

Enumerator
AtlasOff
PreviewAtlas
ExportAtlas

Definition at line 98 of file qgscomposition.h.

enum QgsComposition::GridStyle

Style to draw the snapping grid.

Enumerator
Solid
Dots
Crosses

Definition at line 80 of file qgscomposition.h.

enum QgsComposition::PlotStyle

Plot type.

Enumerator
Preview
Print
Postscript

Definition at line 72 of file qgscomposition.h.

enum QgsComposition::ZValueDirection

Enumerator
ZValueBelow
ZValueAbove

Definition at line 87 of file qgscomposition.h.

Constructor & Destructor Documentation

QgsComposition::QgsComposition ( QgsMapRenderer * mapRenderer )

Deprecated:: since 2.4 - use the constructor with QgsMapSettings

Definition at line 53 of file qgscomposition.cpp.

References init().

QgsComposition::QgsComposition ( const QgsMapSettings & mapSettings )

explicit

Definition at line 62 of file qgscomposition.cpp.

References init().

QgsComposition::~QgsComposition ( )

Definition at line 155 of file qgscomposition.cpp.

References deleteAndRemoveMultiFrames(), mActiveItemCommand, mActiveMultiFrameCommand, mPageStyleSymbol, and removePaperItems().

QgsComposition::QgsComposition ( )

private

Member Function Documentation

void QgsComposition::addComposerArrow ( QgsComposerArrow * arrow )

Adds an arrow item to the graphics scene and advices composer to create a widget for it (through signal)

Note: not available in python bindings

Definition at line 2118 of file qgscomposition.cpp.

References composerArrowAdded(), and updateBounds().

Referenced by addItemsFromXML(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::addComposerHtmlFrame	(	QgsComposerHtml *	html,
		QgsComposerFrame *	frame
	)

Adds composer html frame and advices composer to create a widget for it (through signal)

Definition at line 2208 of file qgscomposition.cpp.

References composerHtmlFrameAdded(), and updateBounds().

Referenced by QgsComposerHtml::addFrame().

void QgsComposition::addComposerLabel ( QgsComposerLabel * label )

Adds label to the graphics scene and advices composer to create a widget for it (through signal)

Definition at line 2128 of file qgscomposition.cpp.

References composerLabelAdded(), and updateBounds().

Referenced by addItemsFromXML(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::addComposerLegend ( QgsComposerLegend * legend )

Adds legend to the graphics scene and advices composer to create a widget for it (through signal)

Definition at line 2168 of file qgscomposition.cpp.

References composerLegendAdded(), and updateBounds().

Referenced by addItemsFromXML(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::addComposerMap	(	QgsComposerMap *	map,
		bool	setDefaultPreviewStyle = `true`
	)

Adds map to the graphics scene and advices composer to create a widget for it (through signal)

Definition at line 2138 of file qgscomposition.cpp.

References QgsComposerMap::Cache, QgsComposerMap::cache(), composerMapAdded(), QgsComposerMap::previewMode(), QgsComposerMap::Rectangle, QgsComposerMap::setPreviewMode(), and updateBounds().

Referenced by addItemsFromXML(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::addComposerPicture ( QgsComposerPicture * picture )

Adds picture to the graphics scene and advices composer to create a widget for it (through signal)

Definition at line 2178 of file qgscomposition.cpp.

References composerPictureAdded(), and updateBounds().

Referenced by addItemsFromXML(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::addComposerScaleBar ( QgsComposerScaleBar * scaleBar )

Adds scale bar to the graphics scene and advices composer to create a widget for it (through signal)

Definition at line 2158 of file qgscomposition.cpp.

References composerScaleBarAdded(), and updateBounds().

Referenced by addItemsFromXML(), and QgsComposerView::mousePressEvent().

void QgsComposition::addComposerShape ( QgsComposerShape * shape )

Adds a composer shape to the graphics scene and advices composer to create a widget for it (through signal)

Definition at line 2188 of file qgscomposition.cpp.

References composerShapeAdded(), and updateBounds().

Referenced by addItemsFromXML(), and QgsComposerView::addShape().

void QgsComposition::addComposerTable ( QgsComposerAttributeTable * table )

Adds a composer table to the graphics scene and advices composer to create a widget for it (through signal)

Definition at line 2198 of file qgscomposition.cpp.

References composerTableAdded(), and updateBounds().

Referenced by addItemsFromXML(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::addItemsFromXML	(	const QDomElement &	elem,
		const QDomDocument &	doc,
		QMap< QgsComposerMap , int >	mapsToRestore = `0`,
		bool	addUndoCommands = `false`,
		QPointF *	pos = `0`,
		bool	pasteInPlace = `false`
	)

Add items from XML representation to the graphics scene (for project file reading, pasting items from clipboard)

Parameters

elem	items parent element, e.g. <Composer> or <ComposerItemClipboard>
doc	xml document
mapsToRestore	for reading from project file: set preview move 'rectangle' to all maps and save the preview states to show composer maps on demand
addUndoCommands	insert AddItem commands if true (e.g. for copy/paste)
pos	item position. Optional, take position from xml if 0
pasteInPlace	whether the position should be kept but mapped to the page origin. (the page is the page under to the mouse cursor)

Note: not available in python bindings

Definition at line 877 of file qgscomposition.cpp.

Referenced by loadFromTemplate(), and QgsComposerView::pasteItems().

void QgsComposition::addItemToZList ( QgsComposerItem * item )

Adds item to z list.

Usually called from constructor of QgsComposerItem

Definition at line 1209 of file qgscomposition.cpp.

References mItemZList.

Referenced by QgsComposerItem::init().

void QgsComposition::addMultiFrame ( QgsComposerMultiFrame * multiFrame )

Adds multiframe.

The object is owned by QgsComposition until removeMultiFrame is called

Definition at line 2104 of file qgscomposition.cpp.

References mMultiFrames, and updateBounds().

Referenced by addItemsFromXML(), QgsComposerMultiFrame::QgsComposerMultiFrame(), and QgsAddRemoveMultiFrameCommand::switchState().

void QgsComposition::addPaperItem ( )

private

Definition at line 2395 of file qgscomposition.cpp.

References mPages, mSpaceBetweenPages, paperHeight(), paperWidth(), and QgsExpression::setSpecialColumn().

Referenced by init(), readXML(), and setNumPages().

QGraphicsLineItem * QgsComposition::addSnapLine ( )

Add a custom snap line (can be horizontal or vertical)

Definition at line 1767 of file qgscomposition.cpp.

References mGuidesVisible, and mSnapLines.

Referenced by QgsComposerRuler::mousePressEvent(), and readXML().

bool QgsComposition::alignmentSnap ( ) const

inline

Definition at line 160 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::collectAlignCoordinates(), and QgsComposerMouseHandles::snapPoint().

double QgsComposition::alignmentSnapTolerance ( ) const

inline

Definition at line 187 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::alignPos().

void QgsComposition::alignSelectedItemsBottom ( )

Definition at line 1567 of file qgscomposition.cpp.

References boundingRectOfSelectedItems(), QgsProject::dirty(), QgsProject::instance(), mUndoStack, QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), selectedComposerItems(), and tr.

void QgsComposition::alignSelectedItemsHCenter ( )

Definition at line 1450 of file qgscomposition.cpp.

References boundingRectOfSelectedItems(), QgsProject::dirty(), QgsProject::instance(), mUndoStack, QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), selectedComposerItems(), and tr.

void QgsComposition::alignSelectedItemsLeft ( )

Definition at line 1420 of file qgscomposition.cpp.

References boundingRectOfSelectedItems(), QgsProject::dirty(), QgsProject::instance(), mUndoStack, QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), selectedComposerItems(), and tr.

void QgsComposition::alignSelectedItemsRight ( )

Definition at line 1480 of file qgscomposition.cpp.

References boundingRectOfSelectedItems(), QgsProject::dirty(), QgsProject::instance(), mUndoStack, QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), selectedComposerItems(), and tr.

void QgsComposition::alignSelectedItemsTop ( )

Definition at line 1510 of file qgscomposition.cpp.

References boundingRectOfSelectedItems(), QgsProject::dirty(), QgsProject::instance(), mUndoStack, QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), selectedComposerItems(), and tr.

void QgsComposition::alignSelectedItemsVCenter ( )

Definition at line 1539 of file qgscomposition.cpp.

References boundingRectOfSelectedItems(), QgsProject::dirty(), QgsProject::instance(), mUndoStack, QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), selectedComposerItems(), and tr.

QgsAtlasComposition& QgsComposition::atlasComposition ( )

inline

Definition at line 448 of file qgscomposition.h.

Referenced by QgsComposerShape::drawShapeUsingSymbol(), QgsComposerPicture::evalPictureExpression(), QgsComposerPicture::init(), QgsPaperItem::initialize(), QgsComposerMap::layersToRender(), loadFromTemplate(), QgsPaperItem::paint(), QgsComposerAttributeTable::QgsComposerAttributeTable(), QgsComposerLabel::QgsComposerLabel(), QgsComposerShape::QgsComposerShape(), QgsComposerLabel::refreshExpressionContext(), and QgsComposerPicture::updatePictureExpression().

QgsComposition::AtlasMode QgsComposition::atlasMode ( ) const

inline

Returns the current atlas mode of the composition.

Definition at line 456 of file qgscomposition.h.

Referenced by QgsComposerMap::currentMapExtent(), QgsComposerShape::drawShapeUsingSymbol(), QgsComposerMap::layersToRender(), QgsPaperItem::paint(), QgsComposerLabel::QgsComposerLabel(), QgsComposerLabel::refreshExpressionContext(), QgsAtlasComposition::setHideCoverage(), QgsComposerMap::setNewScale(), QgsAtlasComposition::updateFeatures(), QgsAtlasComposition::updateFilenameExpression(), and QgsComposerMap::zoomContent().

void QgsComposition::beginCommand	(	QgsComposerItem *	item,
		const QString &	commandText,
		QgsComposerMergeCommand::Context	c = `QgsComposerMergeCommand::Unknown`
	)

Allocates new item command and saves initial state in it.

Parameters

item	target item
commandText	descriptive command text
c	context for merge commands (unknown for non-mergeable commands)

Definition at line 2035 of file qgscomposition.cpp.

References mActiveItemCommand, QgsComposerItemCommand::savePreviousState(), and QgsComposerMergeCommand::Unknown.

Referenced by QgsComposerItem::beginCommand(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::beginMultiFrameCommand	(	QgsComposerMultiFrame *	multiFrame,
		const QString &	text
	)

Definition at line 2079 of file qgscomposition.cpp.

References mActiveMultiFrameCommand, and QgsComposerMultiFrameCommand::savePreviousState().

Referenced by QgsComposerFrame::beginItemCommand(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::beginPrint ( QPrinter & printer )

Prepare the printer for printing.

Definition at line 2492 of file qgscomposition.cpp.

References printResolution().

Referenced by print().

void QgsComposition::beginPrintAsPDF	(	QPrinter &	printer,
		const QString &	file
	)

Prepare the printer for printing in a PDF.

Definition at line 2429 of file qgscomposition.cpp.

References QgsPaintEngineHack::fixEngineFlags(), paperHeight(), and paperWidth().

Referenced by exportAsPDF().

int QgsComposition::boundingRectOfSelectedItems ( QRectF & bRect )

private

Returns the bounding rectangle of the selected items in scene coordinates.

Returns: 0 in case of success

Definition at line 1906 of file qgscomposition.cpp.

References selectedComposerItems().

Referenced by alignSelectedItemsBottom(), alignSelectedItemsHCenter(), alignSelectedItemsLeft(), alignSelectedItemsRight(), alignSelectedItemsTop(), and alignSelectedItemsVCenter().

void QgsComposition::cancelCommand ( )

Deletes current command.

Definition at line 2073 of file qgscomposition.cpp.

References mActiveItemCommand.

Referenced by QgsComposerItem::cancelCommand().

void QgsComposition::clearSnapLines ( )

Removes all snap lines.

Definition at line 1790 of file qgscomposition.cpp.

References mSnapLines.

void QgsComposition::composerArrowAdded ( QgsComposerArrow * arrow )

signal

Is emitted when new composer arrow has been added to the view.

Referenced by addComposerArrow(), and sendItemAddedSignal().

void QgsComposition::composerHtmlFrameAdded	(	QgsComposerHtml *	html,
		QgsComposerFrame *	frame
	)

signal

Is emitted when a new composer html has been added to the view.

Referenced by addComposerHtmlFrame(), and sendItemAddedSignal().

QgsComposerItem * QgsComposition::composerItemAt ( const QPointF & position )

Returns the topmost composer item.

Ignores mPaperItem

Definition at line 377 of file qgscomposition.cpp.

Referenced by QgsComposerView::mousePressEvent(), and QgsComposerView::wheelEvent().

QgsComposerItem * QgsComposition::composerItemAt	(	const QPointF &	position,
		const QgsComposerItem *	belowItem
	)

Returns the highest composer item at a specified position which is below a specified item.

Ignores mPaperItem

Note: Added in QGIS 2.1

Definition at line 382 of file qgscomposition.cpp.

template<class T >

void QgsComposition::composerItems ( QList< T * > & itemList )

Return composer items of a specific type.

Note: not available in python bindings

Definition at line 623 of file qgscomposition.h.

Referenced by addItemsFromXML(), QgsAtlasComposition::composerMap(), QgsAtlasComposition::prepareForFeature(), QgsAtlasComposition::readXML(), setAtlasMode(), and QgsAtlasComposition::updateAtlasMaps().

void QgsComposition::composerLabelAdded ( QgsComposerLabel * label )

signal

Is emitted when new composer label has been added to the view.

Referenced by addComposerLabel(), and sendItemAddedSignal().

void QgsComposition::composerLegendAdded ( QgsComposerLegend * legend )

signal

Is emitted when a new composer legend has been added.

Referenced by addComposerLegend(), and sendItemAddedSignal().

void QgsComposition::composerMapAdded ( QgsComposerMap * map )

signal

Is emitted when new composer map has been added to the view.

Referenced by addComposerMap(), and sendItemAddedSignal().

QList< const QgsComposerMap * > QgsComposition::composerMapItems ( ) const

Returns pointers to all composer maps in the scene.

Note: available in python bindings only with PyQt >= 4.8.4

Definition at line 444 of file qgscomposition.cpp.

Referenced by QgsComposerMap::assignFreeId(), QgsComposerView::mousePressEvent(), QgsComposerView::mouseReleaseEvent(), and QgsComposerMap::QgsComposerMap().

void QgsComposition::composerPictureAdded ( QgsComposerPicture * picture )

signal

Is emitted when a new composer picture has been added.

Referenced by addComposerPicture(), and sendItemAddedSignal().

void QgsComposition::composerScaleBarAdded ( QgsComposerScaleBar * scalebar )

signal

Is emitted when new composer scale bar has been added.

Referenced by addComposerScaleBar(), and sendItemAddedSignal().

void QgsComposition::composerShapeAdded ( QgsComposerShape * shape )

signal

Is emitted when a new composer shape has been added.

Referenced by addComposerShape(), and sendItemAddedSignal().

void QgsComposition::composerTableAdded ( QgsComposerAttributeTable * table )

signal

Is emitted when a new composer table has been added.

Referenced by addComposerTable(), and sendItemAddedSignal().

QRectF QgsComposition::compositionBounds ( ) const

private

Calculates the bounds of all non-gui items in the composition.

Ignores snap lines and mouse handles

Definition at line 196 of file qgscomposition.cpp.

References mPageWidth.

Referenced by updateBounds().

void QgsComposition::computeWorldFileParameters	(	double &	a,
		double &	b,
		double &	c,
		double &	d,
		double &	e,
		double &	f
	)		const

Compute world file parameters.

Definition at line 2581 of file qgscomposition.cpp.

References QgsRectangle::center(), QgsComposerMap::currentMapExtent(), QgsRectangle::height(), M_PI, QgsComposerMap::mapRotation(), mWorldFileMap, paperHeight(), paperWidth(), printResolution(), QgsRectangle::width(), QgsPoint::x(), QgsRectangle::xMinimum(), QgsPoint::y(), QgsRectangle::yMaximum(), and QgsRectangle::yMinimum().

void QgsComposition::connectAddRemoveCommandSignals ( QgsAddRemoveItemCommand * c )

private

Definition at line 2300 of file qgscomposition.cpp.

References itemRemoved(), and sendItemAddedSignal().

Referenced by pushAddRemoveCommand(), and removeComposerItem().

void QgsComposition::createDefaultPageStyleSymbol ( )

private

Definition at line 336 of file qgscomposition.cpp.

References QgsFillSymbolV2::createSimple(), and mPageStyleSymbol.

Referenced by init().

void QgsComposition::deleteAndRemoveMultiFrames ( )

private

Definition at line 2419 of file qgscomposition.cpp.

References mMultiFrames.

Referenced by loadFromTemplate(), and ~QgsComposition().

void QgsComposition::doPrint	(	QPrinter &	printer,
		QPainter &	painter
	)

Print on a preconfigured printer.

Definition at line 2455 of file qgscomposition.cpp.

References mPrintAsRaster, numPages(), printPageAsRaster(), and renderPage().

Referenced by print().

QString QgsComposition::encodeStringForXML ( const QString & str )

staticprivate

Definition at line 2570 of file qgscomposition.cpp.

Referenced by loadFromTemplate().

void QgsComposition::endCommand ( )

Saves end state of item and pushes command to the undo history.

Definition at line 2055 of file qgscomposition.cpp.

References QgsComposerItemCommand::containsChange(), QgsProject::dirty(), QgsProject::instance(), mActiveItemCommand, mUndoStack, and QgsComposerItemCommand::saveAfterState().

Referenced by QgsComposerItem::endCommand(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::endMultiFrameCommand ( )

Definition at line 2086 of file qgscomposition.cpp.

References QgsComposerMultiFrameCommand::containsChange(), QgsProject::dirty(), QgsProject::instance(), mActiveMultiFrameCommand, mUndoStack, and QgsComposerMultiFrameCommand::saveAfterState().

Referenced by QgsComposerFrame::endItemCommand(), and QgsComposerView::mouseReleaseEvent().

bool QgsComposition::exportAsPDF ( const QString & file )

Convenience function that prepares the printer for printing in PDF and prints.

Returns: true if export was successful

Definition at line 2448 of file qgscomposition.cpp.

References beginPrintAsPDF(), and print().

bool QgsComposition::generateWorldFile ( ) const

inline

Definition at line 251 of file qgscomposition.h.

const QgsComposerHtml * QgsComposition::getComposerHtmlByItem ( QgsComposerItem * item ) const

Returns the composer html with specified id (a string as named in the composer user interface item properties).

Note: Added in QGIS 2.0

Parameters

item the item.

Returns: QgsComposerHtml pointer or 0 pointer if no such item exists.

Definition at line 480 of file qgscomposition.cpp.

References QgsComposerFrame::multiFrame().

QgsComposerItem * QgsComposition::getComposerItemAbove ( QgsComposerItem * item )

Definition at line 1264 of file qgscomposition.cpp.

References mItemZList.

Referenced by selectNextByZOrder().

QgsComposerItem * QgsComposition::getComposerItemBelow ( QgsComposerItem * item )

Definition at line 1279 of file qgscomposition.cpp.

References mItemZList.

Referenced by selectNextByZOrder().

const QgsComposerItem * QgsComposition::getComposerItemById ( QString theId ) const

Returns a composer item given its text identifier.

Ids are not necessarely unique, but this function returns only one element.

Note: added in 2.0

Parameters

theId - A QString representing the identifier of the item to retrieve.

Returns: QgsComposerItem pointer or 0 pointer if no such item exists.

Definition at line 499 of file qgscomposition.cpp.

References QgsComposerItem::id().

const QgsComposerItem * QgsComposition::getComposerItemByUuid ( QString theUuid ) const

Returns a composer item given its unique identifier.

Note: added in 2.0

Parameters

theUuid A QString representing the UUID of the item to

Definition at line 554 of file qgscomposition.cpp.

References QgsComposerItem::uuid().

const QgsComposerMap * QgsComposition::getComposerMapById ( int id ) const

Returns the composer map with specified id.

Returns: QgsComposerMap or 0 pointer if the composer map item does not exist

Definition at line 462 of file qgscomposition.cpp.

References QgsComposerMap::id().

Referenced by addItemsFromXML(), QgsComposerMap::assignFreeId(), QgsComposerMap::drawOverviewMapExtent(), QgsComposerMap::overviewExtentChanged(), QgsComposerAttributeTable::readXML(), QgsComposerPicture::readXML(), QgsComposerLegend::readXML(), QgsComposerScaleBar::readXML(), QgsComposerMap::setOverviewFrameMap(), and QgsComposerPicture::setRotationMap().

const QPen& QgsComposition::gridPen ( ) const

inline

Definition at line 181 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

GridStyle QgsComposition::gridStyle ( ) const

inline

Definition at line 184 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

bool QgsComposition::gridVisible ( ) const

inline

Definition at line 153 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

void QgsComposition::init ( )

protected

int QgsComposition::itemPageNumber ( const QgsComposerItem * item ) const

Returns on which page number (0-based) is displayed an item.

Definition at line 420 of file qgscomposition.cpp.

References pageNumberAt().

Referenced by QgsComposerLabel::displayText().

void QgsComposition::itemRemoved ( QgsComposerItem * )

signal

Is emitted when a composer item has been removed from the scene.

Referenced by connectAddRemoveCommandSignals(), loadFromTemplate(), and removeComposerItem().

void QgsComposition::loadDefaults ( )

private

Loads default composer settings.

Definition at line 169 of file qgscomposition.cpp.

References mAlignmentSnapTolerance, mSnapGridOffsetX, mSnapGridOffsetY, mSnapGridResolution, and mSnapGridTolerance.

Referenced by init().

bool QgsComposition::loadFromTemplate	(	const QDomDocument &	doc,
		QMap< QString, QString > *	substitutionMap = `0`,
		bool	addUndoCommands = `false`
	)

Load a template document.

Parameters

doc	template document
substitutionMap	map with text to replace. Text needs to be enclosed by brackets (e.g. '[text]' )
addUndoCommands	whether or not to add undo commands

Definition at line 770 of file qgscomposition.cpp.

References addItemsFromXML(), atlasComposition(), deleteAndRemoveMultiFrames(), encodeStringForXML(), itemRemoved(), mItemZList, mPages, mUndoStack, QgsAtlasComposition::readXML(), and readXML().

void QgsComposition::loadSettings ( )

private

Loads composer settings which may change, eg grid color.

Definition at line 2003 of file qgscomposition.cpp.

References Crosses, Dots, mGridPen, mGridStyle, and Solid.

Referenced by init(), and updateSettings().

void QgsComposition::lockSelectedItems ( )

Lock the selected items.

Definition at line 1595 of file qgscomposition.cpp.

References QgsProject::dirty(), QgsProject::instance(), mUndoStack, QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), selectedComposerItems(), and tr.

void QgsComposition::lowerItem ( QgsComposerItem * item )

Definition at line 1347 of file qgscomposition.cpp.

References mItemZList.

Referenced by lowerSelectedItems().

void QgsComposition::lowerSelectedItems ( )

Definition at line 1333 of file qgscomposition.cpp.

References lowerItem(), selectedComposerItems(), and updateZValues().

Q_DECL_DEPRECATED QgsMapRenderer* QgsComposition::mapRenderer ( )

inline

Returns pointer to map renderer of qgis map canvas.

Deprecated:: since 2.4 - use mapSettings() instead. May return null if not initialized with QgsMapRenderer

Definition at line 266 of file qgscomposition.h.

Referenced by QgsComposerMap::mapRenderer().

const QgsMapSettings& QgsComposition::mapSettings ( ) const

inline

Return setting of QGIS map canvas.

Note: added in 2.4

Definition at line 270 of file qgscomposition.h.

Referenced by QgsComposerMap::composerMapPosForItem(), QgsAtlasComposition::computeExtent(), QgsComposerMap::containsAdvancedEffects(), QgsComposerMap::containsWMSLayer(), QgsComposerMap::draw(), QgsComposerMap::drawGrid(), QgsComposerMap::drawOverviewMapExtent(), QgsComposerShape::drawShapeUsingSymbol(), QgsComposerAttributeTable::getFeatureAttributes(), QgsComposerMap::initGridAnnotationFormatFromProject(), QgsComposerLegend::layerIdList(), QgsComposerMap::layersToRender(), QgsComposerScaleBar::mapWidth(), QgsPaperItem::paint(), QgsComposerMap::QgsComposerMap(), QgsComposerMap::scale(), QgsComposerMap::setNewScale(), QgsComposerMap::storeCurrentLayerSet(), QgsComposerMap::syncLayerSet(), and QgsComposerMap::zoomContent().

QPointF QgsComposition::minPointFromXml ( const QDomElement & elem ) const

private

Calculates the item minimum position from an xml string.

Definition at line 848 of file qgscomposition.cpp.

References MathUtils::max().

Referenced by addItemsFromXML().

void QgsComposition::moveItemToBottom ( QgsComposerItem * item )

Definition at line 1409 of file qgscomposition.cpp.

References mItemZList.

Referenced by moveSelectedItemsToBottom().

void QgsComposition::moveItemToTop ( QgsComposerItem * item )

Definition at line 1384 of file qgscomposition.cpp.

References mItemZList.

Referenced by moveSelectedItemsToTop().

void QgsComposition::moveSelectedItemsToBottom ( )

Definition at line 1395 of file qgscomposition.cpp.

References moveItemToBottom(), selectedComposerItems(), and updateZValues().

void QgsComposition::moveSelectedItemsToTop ( )

Definition at line 1369 of file qgscomposition.cpp.

References moveItemToTop(), selectedComposerItems(), and updateZValues().

QGraphicsLineItem * QgsComposition::nearestSnapLine	(	bool	horizontal,
		double	x,
		double	y,
		double	tolerance,
		QList< QPair< QgsComposerItem *, QgsComposerItem::ItemPositionMode > > &	snappedItems
	)

Get nearest snap line.

Note: not available in python bindings

Definition at line 1818 of file qgscomposition.cpp.

References QgsComposerItem::ComposerPaper, QgsComposerItem::LowerMiddle, QgsComposerItem::Middle, QgsComposerItem::MiddleLeft, QgsComposerItem::MiddleRight, mSnapLines, qgsDoubleNear(), QgsComposerItem::type(), and QgsComposerItem::UpperMiddle.

Referenced by QgsComposerRuler::mousePressEvent().

void QgsComposition::nPagesChanged ( )

signal

Referenced by setNumPages().

int QgsComposition::numPages ( ) const

Note: added in version 1.9.

Definition at line 324 of file qgscomposition.cpp.

References mPages.

Referenced by QgsAtlasComposition::beginRender(), doPrint(), QgsComposerMultiFrame::handlePageChange(), QgsComposerRuler::paintEvent(), readXML(), QgsComposerMultiFrame::recalculateFrameSizes(), setNumPages(), setPaperSize(), QgsComposerRuler::setSnapLinePosition(), and QgsComposerMouseHandles::snapPoint().

int QgsComposition::pageNumberAt ( const QPointF & position ) const

Returns the page number (0-bsaed) given a coordinate.

Definition at line 415 of file qgscomposition.cpp.

References paperHeight(), and spaceBetweenPages().

Referenced by addItemsFromXML(), and itemPageNumber().

int QgsComposition::pageNumberForPoint ( const QPointF & position ) const

Returns the page number corresponding to a point in the composition.

Note: Added in QGIS 2.1

Definition at line 364 of file qgscomposition.cpp.

References mPages, paperHeight(), and spaceBetweenPages().

Referenced by setPaperSize().

QList< QgsPaperItem* > QgsComposition::pages ( )

inline

Return pages in the correct order.

Note: composerItems(QList< QgsPaperItem* > &) may not return pages in the correct order; added in version 2.4

Definition at line 463 of file qgscomposition.h.

QgsFillSymbolV2* QgsComposition::pageStyleSymbol ( )

inline

Note: added in version 2.1.

Definition at line 128 of file qgscomposition.h.

Referenced by QgsPaperItem::calculatePageMargin(), and QgsPaperItem::paint().

double QgsComposition::paperHeight ( ) const

Returns height of paper item.

Definition at line 270 of file qgscomposition.cpp.

References mPageHeight.

Referenced by QgsComposerItem::_readXML(), addItemsFromXML(), addPaperItem(), beginPrintAsPDF(), computeWorldFileParameters(), QgsComposerMultiFrame::handlePageChange(), QgsComposerItem::page(), pageNumberAt(), pageNumberForPoint(), QgsComposerItem::pagePos(), QgsComposerRuler::paintEvent(), positionOnPage(), printPageAsRaster(), QgsComposerMultiFrame::recalculateFrameSizes(), QgsComposerItem::setItemPosition(), QgsComposerRuler::setSnapLinePosition(), and QgsComposerMouseHandles::snapPoint().

void QgsComposition::paperSizeChanged ( )

signal

Referenced by readXML(), and setPaperSize().

double QgsComposition::paperWidth ( ) const

Returns width of paper item.

Definition at line 275 of file qgscomposition.cpp.

References mPageWidth.

Referenced by addPaperItem(), beginPrintAsPDF(), computeWorldFileParameters(), printPageAsRaster(), QgsComposerRuler::setSnapLinePosition(), and QgsComposerMouseHandles::snapPoint().

int QgsComposition::pixelFontSize ( double pointSize ) const

Returns the pixel font size for a font that has point size set.

The result depends on the resolution (dpi) and of the preview mode. Each item that sets a font should call this function before drawing text

Definition at line 597 of file qgscomposition.cpp.

QgsComposition::PlotStyle QgsComposition::plotStyle ( ) const

inline

Definition at line 272 of file qgscomposition.h.

Referenced by QgsComposerMap::draw(), QgsComposerItemGroup::drawFrame(), QgsComposerMap::drawOverviewMapExtent(), QgsComposerItem::drawSelectionBoxes(), QgsComposerArrow::drawSVGMarker(), QgsPaperGrid::paint(), QgsComposerLabel::paint(), QgsPaperItem::paint(), QgsComposerTable::paint(), QgsComposerMouseHandles::paint(), and QgsComposerMap::paint().

double QgsComposition::pointFontSize ( int pixelSize ) const

Does the inverse calculation and returns points for pixels (equals to mm in QgsComposition)

Definition at line 604 of file qgscomposition.cpp.

QPointF QgsComposition::positionOnPage ( const QPointF & position ) const

Returns the position within a page of a point in the composition.

Note: Added in QGIS 2.1

Definition at line 347 of file qgscomposition.cpp.

References mPages, paperHeight(), and spaceBetweenPages().

Referenced by setPaperSize().

bool QgsComposition::preventCursorChange ( )

inline

Definition at line 416 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::setViewportCursor().

bool QgsComposition::print ( QPrinter & printer )

Convenience function that prepares the printer and prints.

Returns: true if print was successful

Definition at line 2502 of file qgscomposition.cpp.

References beginPrint(), and doPrint().

Referenced by exportAsPDF().

bool QgsComposition::printAsRaster ( ) const

inline

Definition at line 248 of file qgscomposition.h.

QImage QgsComposition::printPageAsRaster ( int page )

print composer page to image If the image does not fit into memory, a null image is returned

Definition at line 2517 of file qgscomposition.cpp.

References paperHeight(), paperWidth(), printResolution(), and renderPage().

Referenced by doPrint().

int QgsComposition::printResolution ( ) const

inline

Definition at line 245 of file qgscomposition.h.

Referenced by beginPrint(), QgsPaperItem::calculatePageMargin(), QgsComposerPicture::clippedImageRect(), computeWorldFileParameters(), QgsComposerHtml::htmlUnitsToMM(), QgsComposerLabel::htmlUnitsToMM(), QgsComposerPicture::paint(), printPageAsRaster(), and QgsComposerPicture::setSceneRect().

void QgsComposition::printResolutionChanged ( )

signal

Is emitted when the compositions print resolution changes.

Referenced by setPrintResolution().

void QgsComposition::pushAddRemoveCommand	(	QgsComposerItem *	item,
		const QString &	text,
		QgsAddRemoveItemCommand::State	state = `QgsAddRemoveItemCommand::Added`
	)

Convenience function to create a QgsAddRemoveItemCommand, connect its signals and push it to the undo stack.

Definition at line 2292 of file qgscomposition.cpp.

References connectAddRemoveCommandSignals(), QgsProject::dirty(), QgsProject::instance(), and undoStack().

Referenced by addItemsFromXML(), QgsComposerView::addShape(), QgsComposerView::mousePressEvent(), QgsComposerView::mouseReleaseEvent(), and removeComposerItem().

void QgsComposition::raiseItem ( QgsComposerItem * item )

Definition at line 1242 of file qgscomposition.cpp.

References mItemZList.

Referenced by raiseSelectedItems().

void QgsComposition::raiseSelectedItems ( )

Definition at line 1228 of file qgscomposition.cpp.

References raiseItem(), selectedComposerItems(), and updateZValues().

bool QgsComposition::readXML	(	const QDomElement &	compositionElem,
		const QDomDocument &	doc
	)

Reads settings from xml file.

Definition at line 700 of file qgscomposition.cpp.

References addPaperItem(), addSnapLine(), QgsSymbolLayerV2Utils::loadSymbol(), mAlignmentSnap, mAlignmentSnapTolerance, mGenerateWorldFile, mGridVisible, mGuidesVisible, mPageHeight, mPageStyleSymbol, mPageWidth, mPrintAsRaster, mPrintResolution, mSmartGuides, mSnapGridOffsetX, mSnapGridOffsetY, mSnapGridResolution, mSnapGridTolerance, mSnapToGrid, numPages(), paperSizeChanged(), removePaperItems(), updateBounds(), and updatePaperItems().

Referenced by loadFromTemplate().

void QgsComposition::refreshItems ( )

slot

Forces items in the composition to refresh.

For instance, this causes maps to redraw and rebuild cached images, html items to reload their source url, and attribute tables to refresh their contents.

Note: added in version 2.3

Definition at line 184 of file qgscomposition.cpp.

References refreshItemsTriggered().

void QgsComposition::refreshItemsTriggered ( )

signal

Is emitted when item in the composition must be refreshed.

Referenced by refreshItems().

void QgsComposition::refreshZList ( )

Rebuilds the z order list based on current order of items in scene.

Definition at line 1705 of file qgscomposition.cpp.

References QgsComposerItem::ComposerFrame, QgsComposerItem::ComposerPaper, mItemZList, QgsComposerItem::type(), and updateZValues().

Referenced by addItemsFromXML().

double QgsComposition::relativePosition	(	double	position,
		double	beforeMin,
		double	beforeMax,
		double	afterMin,
		double	afterMax
	)

static

Returns a scaled position given a before and after range.

Definition at line 2689 of file qgscomposition.cpp.

Referenced by relativeResizeRect().

void QgsComposition::relativeResizeRect	(	QRectF &	rectToResize,
		const QRectF &	boundsBefore,
		const QRectF &	boundsAfter
	)

static

Resizes a QRectF relative to the change from boundsBefore to boundsAfter.

Definition at line 2678 of file qgscomposition.cpp.

References relativePosition().

Referenced by QgsComposerMouseHandles::drawSelectedItemBounds(), QgsComposerMouseHandles::mouseReleaseEvent(), and QgsComposerItemGroup::setSceneRect().

void QgsComposition::removeComposerItem	(	QgsComposerItem *	item,
		bool	createCommand = `true`
	)

Remove item from the graphics scene.

Additionally to QGraphicsScene::removeItem, this function considers undo/redo command

Definition at line 2218 of file qgscomposition.cpp.

References QgsComposerItem::beginItemCommand(), QgsComposerItem::ComposerFrame, connectAddRemoveCommandSignals(), QgsComposerItem::endItemCommand(), QgsComposerMultiFrame::frameCount(), QgsComposerMap::isDrawing(), itemRemoved(), QgsComposerItemGroup::items(), pushAddRemoveCommand(), QgsAddRemoveMultiFrameCommand::Removed, QgsAddRemoveItemCommand::Removed, removeMultiFrame(), tr, QgsComposerItem::type(), undoStack(), and updateBounds().

Referenced by QgsComposerView::copyItems(), QgsComposerMultiFrame::deleteFrames(), QgsComposerView::deleteSelectedItems(), and QgsComposerMultiFrame::removeFrame().

void QgsComposition::removeItemFromZList ( QgsComposerItem * item )

Removes item from z list.

Usually called from destructor of QgsComposerItem

Definition at line 1219 of file qgscomposition.cpp.

References mItemZList.

Referenced by QgsComposerItem::~QgsComposerItem().

void QgsComposition::removeMultiFrame ( QgsComposerMultiFrame * multiFrame )

Removes multi frame (but does not delete it)

Definition at line 2111 of file qgscomposition.cpp.

References mMultiFrames, and updateBounds().

Referenced by removeComposerItem(), and QgsAddRemoveMultiFrameCommand::switchState().

void QgsComposition::removePaperItems ( )

private

Definition at line 2409 of file qgscomposition.cpp.

References mPages, and QgsExpression::setSpecialColumn().

Referenced by readXML(), and ~QgsComposition().

void QgsComposition::removeSnapLine ( QGraphicsLineItem * line )

Remove custom snap line (and delete the object)

Definition at line 1783 of file qgscomposition.cpp.

References mSnapLines.

Referenced by QgsComposerRuler::mouseReleaseEvent().

void QgsComposition::renderPage	(	QPainter *	p,
		int	page
	)

Render a page to a paint device.

Note: added in version 1.9

Definition at line 2535 of file qgscomposition.cpp.

References mPages, mPlotStyle, Print, and setSnapLinesVisible().

Referenced by doPrint(), and printPageAsRaster().

QList< QgsComposerItem * > QgsComposition::selectedComposerItems ( )

Definition at line 425 of file qgscomposition.cpp.

Referenced by alignSelectedItemsBottom(), alignSelectedItemsHCenter(), alignSelectedItemsLeft(), alignSelectedItemsRight(), alignSelectedItemsTop(), alignSelectedItemsVCenter(), boundingRectOfSelectedItems(), QgsComposerView::copyItems(), QgsComposerView::deleteSelectedItems(), QgsComposerMouseHandles::drawSelectedItemBounds(), QgsComposerView::endMarqueeSelect(), QgsComposerView::groupItems(), QgsComposerView::keyPressEvent(), lockSelectedItems(), lowerSelectedItems(), QgsComposerView::mousePressEvent(), QgsComposerMouseHandles::mouseReleaseEvent(), moveSelectedItemsToBottom(), moveSelectedItemsToTop(), raiseSelectedItems(), QgsComposerMouseHandles::resetStatusBar(), QgsComposerMouseHandles::selectionBounds(), QgsComposerMouseHandles::selectionRotation(), selectNextByZOrder(), QgsComposerView::ungroupItems(), and QgsComposerMouseHandles::updateHandles().

void QgsComposition::selectedItemChanged ( QgsComposerItem * selected )

signal

Is emitted when selected item changed.

If 0, no item is selected

Referenced by addItemsFromXML(), selectNextByZOrder(), sendItemAddedSignal(), setSelectedItem(), and unlockAllItems().

QgsComposerMouseHandles* QgsComposition::selectionHandles ( )

inline

Returns pointer to selection handles.

Note: not available in python bindings

Definition at line 358 of file qgscomposition.h.

Referenced by QgsComposerView::mousePressEvent(), and QgsComposerView::mouseReleaseEvent().

void QgsComposition::selectNextByZOrder ( ZValueDirection direction )

Definition at line 1296 of file qgscomposition.cpp.

References getComposerItemAbove(), getComposerItemBelow(), selectedComposerItems(), selectedItemChanged(), QgsComposerItem::setSelected(), ZValueAbove, and ZValueBelow.

void QgsComposition::sendItemAddedSignal ( QgsComposerItem * item )

slot

Casts object to the proper subclass type and calls corresponding itemAdded signal.

Definition at line 2311 of file qgscomposition.cpp.

References composerArrowAdded(), composerHtmlFrameAdded(), composerLabelAdded(), composerLegendAdded(), composerMapAdded(), composerPictureAdded(), composerScaleBarAdded(), composerShapeAdded(), composerTableAdded(), QgsComposerFrame::multiFrame(), selectedItemChanged(), and QgsComposerItem::setSelected().

Referenced by connectAddRemoveCommandSignals().

void QgsComposition::setAlignmentSnap ( bool s )

inline

Definition at line 159 of file qgscomposition.h.

void QgsComposition::setAlignmentSnapTolerance ( double t )

inline

Definition at line 186 of file qgscomposition.h.

bool QgsComposition::setAtlasMode ( QgsComposition::AtlasMode mode )

Sets the current atlas mode of the composition.

Returns false if the mode could not be changed.

Definition at line 2643 of file qgscomposition.cpp.

References QgsComposerMap::atlasDriven(), AtlasOff, QgsAtlasComposition::beginRender(), composerItems(), QgsAtlasComposition::endRender(), mAtlasComposition, mAtlasMode, and QgsComposerMap::toggleAtlasPreview().

Referenced by QgsAtlasComposition::setEnabled().

void QgsComposition::setGenerateWorldFile ( bool enabled )

inline

Definition at line 252 of file qgscomposition.h.

void QgsComposition::setGridPen ( const QPen & p )

Definition at line 1981 of file qgscomposition.cpp.

References mGridPen, and updatePaperItems().

void QgsComposition::setGridStyle ( GridStyle s )

Definition at line 1989 of file qgscomposition.cpp.

References mGridStyle, and updatePaperItems().

void QgsComposition::setGridVisible ( bool b )

Definition at line 1952 of file qgscomposition.cpp.

References mGridVisible, and updatePaperItems().

void QgsComposition::setNumPages ( int pages )

Note: added in version 1.9.

Definition at line 280 of file qgscomposition.cpp.

References addPaperItem(), QgsProject::dirty(), QgsProject::instance(), mPageHeight, mPages, nPagesChanged(), numPages(), QgsExpression::setSpecialColumn(), snapLines(), spaceBetweenPages(), and updateBounds().

Referenced by QgsComposerMultiFrame::recalculateFrameSizes().

void QgsComposition::setPageStyleSymbol ( QgsFillSymbolV2 * symbol )

Note: added in version 2.1.

Definition at line 329 of file qgscomposition.cpp.

References QgsProject::dirty(), QgsProject::instance(), and mPageStyleSymbol.

void QgsComposition::setPaperSize	(	double	width,
		double	height
	)

Changes size of paper item.

Also moves all items so that they retain their same relative position to the top left corner of their current page.

Definition at line 221 of file qgscomposition.cpp.

References QgsProject::dirty(), QgsProject::instance(), mPageHeight, mPages, mPageWidth, mSpaceBetweenPages, numPages(), pageNumberForPoint(), paperSizeChanged(), positionOnPage(), snapLines(), spaceBetweenPages(), updateBounds(), and QgsComposerItem::updatePagePos().

void QgsComposition::setPlotStyle ( QgsComposition::PlotStyle style )

inline

Definition at line 273 of file qgscomposition.h.

void QgsComposition::setPreventCursorChange ( bool preventChange )

inline

If true, prevents any mouse cursor changes by the composition or by any composer items Used by QgsComposer and QgsComposerView to prevent unwanted cursor changes.

Definition at line 415 of file qgscomposition.h.

Referenced by QgsComposerView::keyPressEvent(), QgsComposerView::keyReleaseEvent(), QgsComposerView::mousePressEvent(), QgsComposerView::mouseReleaseEvent(), and QgsComposerView::setCurrentTool().

void QgsComposition::setPrintAsRaster ( bool enabled )

inline

Definition at line 249 of file qgscomposition.h.

void QgsComposition::setPrintResolution ( int dpi )

Definition at line 573 of file qgscomposition.cpp.

References QgsProject::dirty(), QgsProject::instance(), mPrintResolution, and printResolutionChanged().

void QgsComposition::setSelectedItem ( QgsComposerItem * item )

slot

Clears any selected items and sets an item as the current selection.

Parameters

item	item to set as selected

Note: added in version 2.3

Definition at line 189 of file qgscomposition.cpp.

References selectedItemChanged(), and QgsComposerItem::setSelected().

void QgsComposition::setSmartGuidesEnabled ( bool b )

inline

Definition at line 162 of file qgscomposition.h.

void QgsComposition::setSnapGridOffsetX ( double offset )

Definition at line 1969 of file qgscomposition.cpp.

References mSnapGridOffsetX, and updatePaperItems().

void QgsComposition::setSnapGridOffsetY ( double offset )

Definition at line 1975 of file qgscomposition.cpp.

References mSnapGridOffsetY, and updatePaperItems().

void QgsComposition::setSnapGridResolution ( double r )

Definition at line 1958 of file qgscomposition.cpp.

References mSnapGridResolution, and updatePaperItems().

void QgsComposition::setSnapGridTolerance ( double tolerance )

Definition at line 1964 of file qgscomposition.cpp.

References mSnapGridTolerance.

void QgsComposition::setSnapLinesVisible ( bool visible )

Hides / shows custom snap lines.

Definition at line 1801 of file qgscomposition.cpp.

References mGuidesVisible, and mSnapLines.

Referenced by renderPage().

void QgsComposition::setSnapToGridEnabled ( bool b )

Definition at line 1946 of file qgscomposition.cpp.

References mSnapToGrid, and updatePaperItems().

void QgsComposition::setStatusMessage ( const QString & message )

Sets the status bar message for the composer window.

Note: Added in QGIS 2.1

Definition at line 372 of file qgscomposition.cpp.

References statusMsgChanged().

Referenced by QgsComposerMouseHandles::dragMouseMove(), QgsComposerMouseHandles::resetStatusBar(), and QgsComposerMouseHandles::resizeMouseMove().

void QgsComposition::setUseAdvancedEffects ( bool effectsEnabled )

Used to enable or disable advanced effects such as blend modes in a composition.

Note: : added in version 1.9

Definition at line 580 of file qgscomposition.cpp.

References mUseAdvancedEffects, and QgsComposerItem::setEffectsEnabled().

void QgsComposition::setWorldFileMap ( QgsComposerMap * map )

inline

Definition at line 255 of file qgscomposition.h.

bool QgsComposition::smartGuidesEnabled ( ) const

inline

Definition at line 163 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::collectAlignCoordinates(), and QgsComposerMouseHandles::snapPoint().

double QgsComposition::snapGridOffsetX ( ) const

inline

Definition at line 175 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

double QgsComposition::snapGridOffsetY ( ) const

inline

Definition at line 178 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

double QgsComposition::snapGridResolution ( ) const

inline

Definition at line 169 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

double QgsComposition::snapGridTolerance ( ) const

inline

Definition at line 172 of file qgscomposition.h.

QList< QGraphicsLineItem* >* QgsComposition::snapLines ( )

inline

Returns pointer to snap lines collection.

Definition at line 353 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::collectAlignCoordinates(), setNumPages(), and setPaperSize().

bool QgsComposition::snapLinesVisible ( ) const

inline

Definition at line 157 of file qgscomposition.h.

QPointF QgsComposition::snapPointToGrid ( const QPointF & scenePoint ) const

Snaps a scene coordinate point to grid.

Definition at line 1734 of file qgscomposition.cpp.

References mPageHeight, mSnapGridOffsetX, mSnapGridOffsetY, mSnapGridResolution, mSnapGridTolerance, mSnapToGrid, and mSpaceBetweenPages.

Referenced by QgsComposerView::mousePressEvent(), QgsComposerView::mouseReleaseEvent(), and QgsComposerMouseHandles::snapPoint().

bool QgsComposition::snapToGridEnabled ( ) const

inline

Definition at line 150 of file qgscomposition.h.

void QgsComposition::sortZList ( )

Sorts the zList.

The only time where this function needs to be called is from QgsComposer after reading all the items from xml file

Definition at line 1679 of file qgscomposition.cpp.

References mItemZList.

double QgsComposition::spaceBetweenPages ( ) const

inline

Definition at line 118 of file qgscomposition.h.

Referenced by QgsComposerItem::_readXML(), addItemsFromXML(), QgsComposerMultiFrame::handlePageChange(), QgsComposerItem::page(), pageNumberAt(), pageNumberForPoint(), QgsComposerItem::pagePos(), QgsComposerRuler::paintEvent(), positionOnPage(), QgsComposerMultiFrame::recalculateFrameSizes(), QgsComposerItem::setItemPosition(), setNumPages(), setPaperSize(), QgsComposerRuler::setSnapLinePosition(), and QgsComposerMouseHandles::snapPoint().

void QgsComposition::statusMsgChanged ( QString message )

signal

Is emitted when the composition has an updated status bar message for the composer window.

Referenced by setStatusMessage().

QUndoStack* QgsComposition::undoStack ( )

inline

Returns pointer to undo/redo command storage.

Definition at line 190 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::mouseReleaseEvent(), QgsComposerView::mouseReleaseEvent(), pushAddRemoveCommand(), and removeComposerItem().

void QgsComposition::unlockAllItems ( )

Unlock all items.

Definition at line 1613 of file qgscomposition.cpp.

References QgsProject::dirty(), QgsProject::instance(), mUndoStack, QgsComposerItem::positionLock(), QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), selectedItemChanged(), QgsComposerItem::setPositionLock(), QgsComposerItem::setSelected(), and tr.

void QgsComposition::updateBounds ( )

slot

Updates the scene bounds of the composition.

Note: added in version 2.2

Definition at line 179 of file qgscomposition.cpp.

References compositionBounds().

Referenced by addComposerArrow(), addComposerHtmlFrame(), addComposerLabel(), addComposerLegend(), addComposerMap(), addComposerPicture(), addComposerScaleBar(), addComposerShape(), addComposerTable(), addMultiFrame(), init(), readXML(), removeComposerItem(), removeMultiFrame(), setNumPages(), and setPaperSize().

void QgsComposition::updatePaperItems ( )

private

Definition at line 2386 of file qgscomposition.cpp.

References mPages.

Referenced by readXML(), setGridPen(), setGridStyle(), setGridVisible(), setSnapGridOffsetX(), setSnapGridOffsetY(), setSnapGridResolution(), setSnapToGridEnabled(), and updateSettings().

void QgsComposition::updateSettings ( )

Refreshes the composition when composer related options change Note: added in version 2.1.

Definition at line 1995 of file qgscomposition.cpp.

References loadSettings(), and updatePaperItems().

void QgsComposition::updateZValues ( bool addUndoCommands = true )

private

Reset z-values of items based on position in z list.

Definition at line 1642 of file qgscomposition.cpp.

References QgsProject::dirty(), QgsProject::instance(), mItemZList, mUndoStack, QgsComposerItemCommand::saveAfterState(), QgsComposerItemCommand::savePreviousState(), and tr.

Referenced by lowerSelectedItems(), moveSelectedItemsToBottom(), moveSelectedItemsToTop(), raiseSelectedItems(), and refreshZList().

bool QgsComposition::useAdvancedEffects ( ) const

inline

Returns true if a composition should use advanced effects such as blend modes.

Note: added in 1.9

Definition at line 259 of file qgscomposition.h.

Referenced by QgsComposerMap::draw(), and QgsComposerLegend::drawSymbolV2().

QgsComposerMap* QgsComposition::worldFileMap ( ) const

inline

Definition at line 254 of file qgscomposition.h.

bool QgsComposition::writeXML	(	QDomElement &	composerElem,
		QDomDocument &	doc
	)

Writes settings to xml (paper dimension)

Definition at line 610 of file qgscomposition.cpp.

References QgsComposerItem::ComposerFrame, QgsComposerItem::ComposerPaper, QgsComposerMap::id(), mAlignmentSnap, mAlignmentSnapTolerance, mGenerateWorldFile, mGridVisible, mGuidesVisible, mMultiFrames, mPageHeight, mPages, mPageStyleSymbol, mPageWidth, mPrintAsRaster, mPrintResolution, mSmartGuides, mSnapGridOffsetX, mSnapGridOffsetY, mSnapGridResolution, mSnapGridTolerance, mSnapLines, mSnapToGrid, mWorldFileMap, QgsSymbolLayerV2Utils::saveSymbol(), QgsComposerItem::type(), and QgsComposerItem::writeXML().

Member Data Documentation

QgsComposerItemCommand* QgsComposition::mActiveItemCommand

private

Definition at line 546 of file qgscomposition.h.

Referenced by beginCommand(), cancelCommand(), endCommand(), init(), and ~QgsComposition().

QgsComposerMultiFrameCommand* QgsComposition::mActiveMultiFrameCommand

private

Definition at line 547 of file qgscomposition.h.

Referenced by beginMultiFrameCommand(), endMultiFrameCommand(), init(), and ~QgsComposition().

bool QgsComposition::mAlignmentSnap

private

Parameters for alignment snap.

Definition at line 534 of file qgscomposition.h.

Referenced by init(), readXML(), and writeXML().

double QgsComposition::mAlignmentSnapTolerance

private

Definition at line 537 of file qgscomposition.h.

Referenced by init(), loadDefaults(), readXML(), and writeXML().

QgsAtlasComposition QgsComposition::mAtlasComposition

private

The atlas composition object.

It is held by the QgsComposition

Definition at line 550 of file qgscomposition.h.

Referenced by setAtlasMode().

QgsComposition::AtlasMode QgsComposition::mAtlasMode

private

Definition at line 552 of file qgscomposition.h.

Referenced by init(), and setAtlasMode().

bool QgsComposition::mGenerateWorldFile

private

Flag if a world file should be generated on raster export.

Definition at line 516 of file qgscomposition.h.

Referenced by init(), readXML(), and writeXML().

QPen QgsComposition::mGridPen

private

Definition at line 530 of file qgscomposition.h.

Referenced by loadSettings(), and setGridPen().

GridStyle QgsComposition::mGridStyle

private

Definition at line 531 of file qgscomposition.h.

Referenced by loadSettings(), and setGridStyle().

bool QgsComposition::mGridVisible

private

Definition at line 525 of file qgscomposition.h.

Referenced by init(), readXML(), setGridVisible(), and writeXML().

bool QgsComposition::mGuidesVisible

private

Definition at line 535 of file qgscomposition.h.

Referenced by addSnapLine(), init(), readXML(), setSnapLinesVisible(), and writeXML().

QLinkedList<QgsComposerItem*> QgsComposition::mItemZList

private

Maintains z-Order of items.

Starts with item at position 1 (position 0 is always paper item)

Definition at line 504 of file qgscomposition.h.

Referenced by addItemsFromXML(), addItemToZList(), getComposerItemAbove(), getComposerItemBelow(), loadFromTemplate(), lowerItem(), moveItemToBottom(), moveItemToTop(), raiseItem(), refreshZList(), removeItemFromZList(), sortZList(), and updateZValues().

QgsMapRenderer* QgsComposition::mMapRenderer

private

Pointer to map renderer of QGIS main map.

Definition at line 490 of file qgscomposition.h.

const QgsMapSettings& QgsComposition::mMapSettings

private

Definition at line 491 of file qgscomposition.h.

QSet<QgsComposerMultiFrame*> QgsComposition::mMultiFrames

private

List multiframe objects.

Definition at line 507 of file qgscomposition.h.

Referenced by addMultiFrame(), deleteAndRemoveMultiFrames(), removeMultiFrame(), and writeXML().

double QgsComposition::mPageHeight

private

Definition at line 495 of file qgscomposition.h.

Referenced by addItemsFromXML(), init(), paperHeight(), readXML(), setNumPages(), setPaperSize(), snapPointToGrid(), and writeXML().

QList< QgsPaperItem* > QgsComposition::mPages

private

Definition at line 496 of file qgscomposition.h.

Referenced by addPaperItem(), loadFromTemplate(), numPages(), pageNumberForPoint(), positionOnPage(), removePaperItems(), renderPage(), setNumPages(), setPaperSize(), updatePaperItems(), and writeXML().

QgsFillSymbolV2* QgsComposition::mPageStyleSymbol

private

Drawing style for page.

Definition at line 500 of file qgscomposition.h.

Referenced by createDefaultPageStyleSymbol(), init(), readXML(), setPageStyleSymbol(), writeXML(), and ~QgsComposition().

double QgsComposition::mPageWidth

private

Definition at line 494 of file qgscomposition.h.

Referenced by compositionBounds(), init(), paperWidth(), readXML(), setPaperSize(), and writeXML().

QgsComposition::PlotStyle QgsComposition::mPlotStyle

private

Definition at line 493 of file qgscomposition.h.

Referenced by init(), and renderPage().

bool QgsComposition::mPreventCursorChange

private

Definition at line 584 of file qgscomposition.h.

Referenced by init().

bool QgsComposition::mPrintAsRaster

private

Flag if map should be printed as a raster (via QImage).

False by default

Definition at line 513 of file qgscomposition.h.

Referenced by doPrint(), init(), readXML(), and writeXML().

int QgsComposition::mPrintResolution

private

Dpi for printout.

Definition at line 510 of file qgscomposition.h.

Referenced by init(), readXML(), setPrintResolution(), and writeXML().

QgsComposerMouseHandles* QgsComposition::mSelectionHandles

private

Definition at line 542 of file qgscomposition.h.

Referenced by init().

bool QgsComposition::mSmartGuides

private

Definition at line 536 of file qgscomposition.h.

Referenced by init(), readXML(), and writeXML().

double QgsComposition::mSnapGridOffsetX

private

Definition at line 528 of file qgscomposition.h.

Referenced by init(), loadDefaults(), readXML(), setSnapGridOffsetX(), snapPointToGrid(), and writeXML().

double QgsComposition::mSnapGridOffsetY

private

Definition at line 529 of file qgscomposition.h.

Referenced by init(), loadDefaults(), readXML(), setSnapGridOffsetY(), snapPointToGrid(), and writeXML().

double QgsComposition::mSnapGridResolution

private

Definition at line 526 of file qgscomposition.h.

Referenced by init(), loadDefaults(), readXML(), setSnapGridResolution(), snapPointToGrid(), and writeXML().

double QgsComposition::mSnapGridTolerance

private

Definition at line 527 of file qgscomposition.h.

Referenced by init(), loadDefaults(), readXML(), setSnapGridTolerance(), snapPointToGrid(), and writeXML().

QList< QGraphicsLineItem* > QgsComposition::mSnapLines

private

Arbitraty snap lines (horizontal and vertical)

Definition at line 540 of file qgscomposition.h.

Referenced by addSnapLine(), clearSnapLines(), nearestSnapLine(), removeSnapLine(), setSnapLinesVisible(), and writeXML().

bool QgsComposition::mSnapToGrid

private

Parameters for snap to grid function.

Definition at line 524 of file qgscomposition.h.

Referenced by init(), readXML(), setSnapToGridEnabled(), snapPointToGrid(), and writeXML().

double QgsComposition::mSpaceBetweenPages

private

Definition at line 497 of file qgscomposition.h.

Referenced by addItemsFromXML(), addPaperItem(), init(), setPaperSize(), and snapPointToGrid().

QUndoStack QgsComposition::mUndoStack

private

Definition at line 544 of file qgscomposition.h.

Referenced by alignSelectedItemsBottom(), alignSelectedItemsHCenter(), alignSelectedItemsLeft(), alignSelectedItemsRight(), alignSelectedItemsTop(), alignSelectedItemsVCenter(), endCommand(), endMultiFrameCommand(), loadFromTemplate(), lockSelectedItems(), unlockAllItems(), and updateZValues().

bool QgsComposition::mUseAdvancedEffects

private

Flag if advanced visual effects such as blend modes should be used.

True by default

Definition at line 521 of file qgscomposition.h.

Referenced by init(), and setUseAdvancedEffects().

QgsComposerMap* QgsComposition::mWorldFileMap

private

Composer map to use for the world file generation.

Definition at line 518 of file qgscomposition.h.

Referenced by computeWorldFileParameters(), init(), and writeXML().

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

/tmp/buildd/qgis-2.4.0+unstable1/src/core/composer/qgscomposition.h
/tmp/buildd/qgis-2.4.0+unstable1/src/core/composer/qgscomposition.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation