QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
QgsComposition Class Reference

Graphics scene for map printing. More...

#include <qgscomposition.h>

Inheritance diagram for QgsComposition:
Inheritance graph
[legend]

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  PaperOrientation { Portrait, Landscape }
 
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...
 
void setAllUnselected ()
 Clears any selected items in the composition. More...
 
void refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties)
 Refreshes a data defined property for the composition by reevaluating the property's value and redrawing the composition with this new value. 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 composerTableFrameAdded (QgsComposerAttributeTableV2 *table, QgsComposerFrame *frame)
 Is emitted when a new composer table frame has been added to the view. 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 (const double width, const double height)
 Changes size of paper item. More...
 
double paperHeight () const
 Height of paper item. More...
 
double paperWidth () const
 Width of paper item. More...
 
double spaceBetweenPages () const
 Returns the vertical space between pages in a composer view. More...
 
void setNumPages (const int pages)
 Sets the number of pages for the composition. More...
 
int numPages () const
 Returns the number of pages in the composition. More...
 
bool pageIsEmpty (const int page) const
 Returns whether a page is empty, ie, it contains no items except for the background paper item. More...
 
bool shouldExportPage (const int page) const
 Returns whether a specified page number should be included in exports of the composition. More...
 
void setPageStyleSymbol (QgsFillSymbolV2 *symbol)
 Note: added in version 2.1. More...
 
QgsFillSymbolV2pageStyleSymbol ()
 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. More...
 
void setSnapToGridEnabled (const bool b)
 
bool snapToGridEnabled () const
 
void setGridVisible (const bool b)
 
bool gridVisible () const
 
void setSnapLinesVisible (const bool visible)
 Hides / shows custom snap lines. More...
 
bool snapLinesVisible () const
 
void setAlignmentSnap (const bool s)
 
bool alignmentSnap () const
 
void setSmartGuidesEnabled (const bool b)
 
bool smartGuidesEnabled () const
 
void clearSnapLines ()
 Removes all snap lines. More...
 
void setSnapGridResolution (const double r)
 
double snapGridResolution () const
 
void setSnapGridOffsetX (const double offset)
 
double snapGridOffsetX () const
 
void setSnapGridOffsetY (const double offset)
 
double snapGridOffsetY () const
 
void setGridPen (const QPen &p)
 
const QPen & gridPen () const
 
void setGridStyle (const GridStyle s)
 
GridStyle gridStyle () const
 
Q_DECL_DEPRECATED void setSnapGridTolerance (double tolerance)
 Sets the snap tolerance to use when automatically snapping items during movement and resizing to the composition grid. More...
 
Q_DECL_DEPRECATED double snapGridTolerance () const
 Returns the snap tolerance to use when automatically snapping items during movement and resizing to the composition grid. More...
 
Q_DECL_DEPRECATED void setAlignmentSnapTolerance (double t)
 Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides and the edges and centers of other items. More...
 
Q_DECL_DEPRECATED double alignmentSnapTolerance () const
 Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides and the edges and centers of other items. More...
 
void setSnapTolerance (const int snapTolerance)
 Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides and the edges and centers of other items. More...
 
int snapTolerance () const
 Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides and the edges and centers of other items. More...
 
QUndoStack * undoStack ()
 Returns pointer to undo/redo command storage. More...
 
QgsComposerItemcomposerItemAt (const QPointF &position, const bool ignoreLocked=false) const
 Returns the topmost composer item at a specified position. More...
 
QgsComposerItemcomposerItemAt (const QPointF &position, const QgsComposerItem *belowItem, const bool ignoreLocked=false) const
 Returns the topmost composer item at a specified position which is below a specified item. More...
 
int pageNumberAt (const QPointF &position) const
 Returns the page number (0-based) given a coordinate. More...
 
int itemPageNumber (const QgsComposerItem *) const
 Returns on which page number (0-based) is displayed an item. More...
 
QList< QgsComposerItem * > selectedComposerItems (const bool includeLockedItems=true)
 Returns list of selected composer items. More...
 
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...
 
template<class T >
void composerItemsOnPage (QList< T * > &itemList, const int pageNumber) const
 Return composer items of a specific type on a specified page. More...
 
const QgsComposerMapgetComposerMapById (const int id) const
 Returns the composer map with specified id. More...
 
Q_DECL_DEPRECATED 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 QgsComposerItemgetComposerItemById (const QString theId) const
 Returns a composer item given its text identifier. More...
 
const QgsComposerItemgetComposerItemByUuid (const QString theUuid) const
 Returns a composer item given its unique identifier. More...
 
int printResolution () const
 
void setPrintResolution (const int dpi)
 
bool printAsRaster () const
 
void setPrintAsRaster (const bool enabled)
 
bool generateWorldFile () const
 
void setGenerateWorldFile (const bool enabled)
 
QgsComposerMapworldFileMap () const
 
void setWorldFileMap (QgsComposerMap *map)
 
bool useAdvancedEffects () const
 Returns true if a composition should use advanced effects such as blend modes. More...
 
void setUseAdvancedEffects (const bool effectsEnabled)
 Used to enable or disable advanced effects such as blend modes in a composition. More...
 
Q_DECL_DEPRECATED QgsMapRenderermapRenderer ()
 Returns pointer to map renderer of qgis map canvas. More...
 
const QgsMapSettingsmapSettings () const
 Return setting of QGIS map canvas. More...
 
QgsComposition::PlotStyle plotStyle () const
 
void setPlotStyle (const QgsComposition::PlotStyle style)
 
Q_DECL_DEPRECATED int pixelFontSize (double pointSize) const
 Returns the mm font size for a font that has point size set. More...
 
Q_DECL_DEPRECATED double pointFontSize (int pixelSize) const
 Does the inverse calculation and returns points for mm. 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, const bool clearComposition=true)
 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 ()
 
bool raiseItem (QgsComposerItem *item)
 
void lowerSelectedItems ()
 
bool lowerItem (QgsComposerItem *item)
 
void moveSelectedItemsToTop ()
 
bool moveItemToTop (QgsComposerItem *item)
 
void moveSelectedItemsToBottom ()
 
bool moveItemToBottom (QgsComposerItem *item)
 
void selectNextByZOrder (const ZValueDirection direction)
 
QgsComposerItemgetComposerItemBelow (QgsComposerItem *item) const
 
QgsComposerItemgetComposerItemAbove (QgsComposerItem *item) const
 
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...
 
QgsComposerItemGroupgroupItems (QList< QgsComposerItem * > items)
 Creates a new group from a list of composer items and adds it to the composition. More...
 
QList< QgsComposerItem * > ungroupItems (QgsComposerItemGroup *group)
 Ungroups items by removing them from an item group and removing the group from the composition. More...
 
Q_DECL_DEPRECATED void sortZList ()
 Sorts the zList. More...
 
void refreshZList ()
 Rebuilds the z order list by adding any item which are present in the composition but missing from the z order list. 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...
 
QgsComposerMouseHandlesselectionHandles ()
 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 (const bool horizontal, const double x, const double y, const double tolerance, QList< QPair< QgsComposerItem *, QgsComposerItem::ItemPositionMode > > &snappedItems) const
 Get nearest snap line. More...
 
void beginCommand (QgsComposerItem *item, const QString &commandText, const 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, const QgsComposerMultiFrameMergeCommand::Context c=QgsComposerMultiFrameMergeCommand::Unknown)
 
void endMultiFrameCommand ()
 
void cancelMultiFrameCommand ()
 Deletes current multi frame command. More...
 
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, const 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 advises composer to create a widget for it (through signal) More...
 
void addComposerTableFrame (QgsComposerAttributeTableV2 *table, QgsComposerFrame *frame)
 Adds composer tablev2 frame and advises composer to create a widget for it (through signal) More...
 
void removeComposerItem (QgsComposerItem *item, const bool createCommand=true, const bool removeGroupItems=true)
 Remove item from the graphics scene. More...
 
void pushAddRemoveCommand (QgsComposerItem *item, const QString &text, const QgsAddRemoveItemCommand::State state=QgsAddRemoveItemCommand::Added)
 Convenience function to create a QgsAddRemoveItemCommand, connect its signals and push it to the undo stack. More...
 
void setPreventCursorChange (const 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 () const
 
void beginPrint (QPrinter &printer, const bool evaluateDDPageSize=false)
 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, bool startNewPage=false)
 Print on a preconfigured printer. More...
 
bool print (QPrinter &printer, const bool evaluateDDPageSize=false)
 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...
 
QgsAtlasCompositionatlasComposition ()
 
QgsComposition::AtlasMode atlasMode () const
 Returns the current atlas mode of the composition. More...
 
bool setAtlasMode (const QgsComposition::AtlasMode mode)
 Sets the current atlas mode of the composition. More...
 
QList< QgsPaperItem * > pages ()
 Return pages in the correct order. More...
 
QgsDataDefineddataDefinedProperty (const QgsComposerObject::DataDefinedProperty property)
 Returns a reference to the data defined settings for one of the composition's data defined properties. More...
 
void setDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property, bool active, bool useExpression, const QString &expression, const QString &field)
 Sets parameters for a data defined property for the composition. More...
 
QgsComposerModelitemsModel ()
 Returns the items model attached to the composition. More...
 

Static Public Member Functions

static Q_DECL_DEPRECATED void relativeResizeRect (QRectF &rectToResize, const QRectF &boundsBefore, const QRectF &boundsAfter)
 Resizes a QRectF relative to the change from boundsBefore to boundsAfter. More...
 
static Q_DECL_DEPRECATED 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 ()
 

Friends

class QgsComposerObject
 
class QgsComposerModel
 

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.

Constructor & Destructor Documentation

QgsComposition::QgsComposition ( QgsMapRenderer mapRenderer)
Deprecated:
since 2.4 - use the constructor with QgsMapSettings
QgsComposition::QgsComposition ( const QgsMapSettings mapSettings)
explicit
QgsComposition::~QgsComposition ( )

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
void QgsComposition::addComposerHtmlFrame ( QgsComposerHtml html,
QgsComposerFrame frame 
)

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

void QgsComposition::addComposerLabel ( QgsComposerLabel label)

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

void QgsComposition::addComposerLegend ( QgsComposerLegend legend)

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

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

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

void QgsComposition::addComposerPicture ( QgsComposerPicture picture)

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

void QgsComposition::addComposerScaleBar ( QgsComposerScaleBar scaleBar)

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

void QgsComposition::addComposerShape ( QgsComposerShape shape)

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

void QgsComposition::addComposerTable ( QgsComposerAttributeTable table)

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

void QgsComposition::addComposerTableFrame ( QgsComposerAttributeTableV2 table,
QgsComposerFrame frame 
)

Adds composer tablev2 frame and advises composer to create a widget for it (through signal)

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
elemitems parent element, e.g.
<Composer> 
or
<ComposerItemClipboard> 
docxml document
mapsToRestorefor reading from project file: set preview move 'rectangle' to all maps and save the preview states to show composer maps on demand
addUndoCommandsinsert AddItem commands if true (e.g. for copy/paste)
positem position. Optional, take position from xml if 0
pasteInPlacewhether the position should be kept but mapped to the page origin. (the page is the page under to the mouse cursor)
Note
parameters mapsToRestore, addUndoCommands pos and pasteInPlace not available in python bindings
void QgsComposition::addItemToZList ( QgsComposerItem item)

Adds item to z list.

Usually called from constructor of QgsComposerItem

void QgsComposition::addMultiFrame ( QgsComposerMultiFrame multiFrame)

Adds multiframe.

The object is owned by QgsComposition until removeMultiFrame is called

QGraphicsLineItem * QgsComposition::addSnapLine ( )

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

bool QgsComposition::alignmentSnap ( ) const
inline
Q_DECL_DEPRECATED double QgsComposition::alignmentSnapTolerance ( ) const
inline

Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides and the edges and centers of other items.

Returns
snap tolerance in pixels
See also
setAlignmentSnapTolerance
Deprecated:
Use snapTolerance instead
void QgsComposition::alignSelectedItemsBottom ( )
void QgsComposition::alignSelectedItemsHCenter ( )
void QgsComposition::alignSelectedItemsLeft ( )
void QgsComposition::alignSelectedItemsRight ( )
void QgsComposition::alignSelectedItemsTop ( )
void QgsComposition::alignSelectedItemsVCenter ( )
QgsAtlasComposition& QgsComposition::atlasComposition ( )
inline
QgsComposition::AtlasMode QgsComposition::atlasMode ( ) const
inline

Returns the current atlas mode of the composition.

Returns
current atlas mode
See also
setAtlasMode
void QgsComposition::beginCommand ( QgsComposerItem item,
const QString &  commandText,
const QgsComposerMergeCommand::Context  c = QgsComposerMergeCommand::Unknown 
)

Allocates new item command and saves initial state in it.

Parameters
itemtarget item
commandTextdescriptive command text
ccontext for merge commands (unknown for non-mergeable commands)
void QgsComposition::beginMultiFrameCommand ( QgsComposerMultiFrame multiFrame,
const QString &  text,
const QgsComposerMultiFrameMergeCommand::Context  c = QgsComposerMultiFrameMergeCommand::Unknown 
)
void QgsComposition::beginPrint ( QPrinter &  printer,
const bool  evaluateDDPageSize = false 
)

Prepare the printer for printing.

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

Prepare the printer for printing in a PDF.

void QgsComposition::cancelCommand ( )

Deletes current command.

void QgsComposition::cancelMultiFrameCommand ( )

Deletes current multi frame command.

void QgsComposition::clearSnapLines ( )

Removes all snap lines.

void QgsComposition::composerArrowAdded ( QgsComposerArrow arrow)
signal

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

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

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

QgsComposerItem * QgsComposition::composerItemAt ( const QPointF &  position,
const bool  ignoreLocked = false 
) const

Returns the topmost composer item at a specified position.

Ignores paper items.

Parameters
positionpoint to search for item at
ignoreLockedset to true to ignore locked items
Returns
composer item at position
QgsComposerItem * QgsComposition::composerItemAt ( const QPointF &  position,
const QgsComposerItem belowItem,
const bool  ignoreLocked = false 
) const

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

Ignores paper items.

Parameters
positionpoint to search for item at
belowItemitem to search below
ignoreLockedset to true to ignore locked items
Returns
composer item at position which is below specified item
template<class T >
void QgsComposition::composerItems ( QList< T * > &  itemList)

Return composer items of a specific type.

Parameters
itemListlist of item type to store matching items in
Note
not available in python bindings
template<class T >
void QgsComposition::composerItemsOnPage ( QList< T * > &  itemList,
const int  pageNumber 
) const

Return composer items of a specific type on a specified page.

Parameters
itemListlist of item type to store matching items in
pageNumberpage number (0 based)
Note
not available in python bindings
added in QGIS 2.5
void QgsComposition::composerLabelAdded ( QgsComposerLabel label)
signal

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

void QgsComposition::composerLegendAdded ( QgsComposerLegend legend)
signal

Is emitted when a new composer legend has been added.

void QgsComposition::composerMapAdded ( QgsComposerMap map)
signal

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

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
void QgsComposition::composerPictureAdded ( QgsComposerPicture picture)
signal

Is emitted when a new composer picture has been added.

void QgsComposition::composerScaleBarAdded ( QgsComposerScaleBar scalebar)
signal

Is emitted when new composer scale bar has been added.

void QgsComposition::composerShapeAdded ( QgsComposerShape shape)
signal

Is emitted when a new composer shape has been added.

void QgsComposition::composerTableAdded ( QgsComposerAttributeTable table)
signal

Is emitted when a new composer table has been added.

void QgsComposition::composerTableFrameAdded ( QgsComposerAttributeTableV2 table,
QgsComposerFrame frame 
)
signal

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

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

Compute world file parameters.

QgsDataDefined * QgsComposition::dataDefinedProperty ( const QgsComposerObject::DataDefinedProperty  property)

Returns a reference to the data defined settings for one of the composition's data defined properties.

Parameters
propertydata defined property to return
Note
this method was added in version 2.5
void QgsComposition::doPrint ( QPrinter &  printer,
QPainter &  painter,
bool  startNewPage = false 
)

Print on a preconfigured printer.

Parameters
printerQPrinter destination
painterQPainter source
startNewPageset to true to begin the print on a new page
void QgsComposition::endCommand ( )

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

void QgsComposition::endMultiFrameCommand ( )
bool QgsComposition::exportAsPDF ( const QString &  file)

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

Returns
true if export was successful
bool QgsComposition::generateWorldFile ( ) const
inline
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).

Parameters
itemthe item.
Returns
QgsComposerHtml pointer or 0 pointer if no such item exists.
QgsComposerItem * QgsComposition::getComposerItemAbove ( QgsComposerItem item) const
QgsComposerItem * QgsComposition::getComposerItemBelow ( QgsComposerItem item) const
const QgsComposerItem * QgsComposition::getComposerItemById ( const QString  theId) const

Returns a composer item given its text identifier.

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

Parameters
theId- A QString representing the identifier of the item to retrieve.
Returns
QgsComposerItem pointer or 0 pointer if no such item exists.
const QgsComposerItem * QgsComposition::getComposerItemByUuid ( const QString  theUuid) const

Returns a composer item given its unique identifier.

Parameters
theUuidA QString representing the UUID of the item to
const QgsComposerMap * QgsComposition::getComposerMapById ( const int  id) const

Returns the composer map with specified id.

Returns
QgsComposerMap or 0 pointer if the composer map item does not exist
const QPen& QgsComposition::gridPen ( ) const
inline
GridStyle QgsComposition::gridStyle ( ) const
inline
bool QgsComposition::gridVisible ( ) const
inline
QgsComposerItemGroup * QgsComposition::groupItems ( QList< QgsComposerItem * >  items)

Creates a new group from a list of composer items and adds it to the composition.

Parameters
itemsitems to include in group
Returns
QgsComposerItemGroup of grouped items, if grouping was possible
Note
added in QGIS 2.6
void QgsComposition::init ( )
protected
int QgsComposition::itemPageNumber ( const QgsComposerItem item) const

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

void QgsComposition::itemRemoved ( QgsComposerItem )
signal

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

QgsComposerModel* QgsComposition::itemsModel ( )
inline

Returns the items model attached to the composition.

Returns
QgsComposerModel for composition
Note
this method was added in version 2.5
bool QgsComposition::loadFromTemplate ( const QDomDocument &  doc,
QMap< QString, QString > *  substitutionMap = 0,
bool  addUndoCommands = false,
const bool  clearComposition = true 
)

Load a template document.

Parameters
doctemplate document
substitutionMapmap with text to replace. Text needs to be enclosed by brackets (e.g. '[text]' )
addUndoCommandswhether or not to add undo commands
clearCompositionset to true to clear the existing composition and read all composition and atlas properties from the template. Set to false to only add new items from the template, without overwriting the existing items or composition settings.
void QgsComposition::lockSelectedItems ( )

Lock the selected items.

bool QgsComposition::lowerItem ( QgsComposerItem item)
void QgsComposition::lowerSelectedItems ( )
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
const QgsMapSettings& QgsComposition::mapSettings ( ) const
inline

Return setting of QGIS map canvas.

Note
added in 2.4
bool QgsComposition::moveItemToBottom ( QgsComposerItem item)
bool QgsComposition::moveItemToTop ( QgsComposerItem item)
void QgsComposition::moveSelectedItemsToBottom ( )
void QgsComposition::moveSelectedItemsToTop ( )
QGraphicsLineItem * QgsComposition::nearestSnapLine ( const bool  horizontal,
const double  x,
const double  y,
const double  tolerance,
QList< QPair< QgsComposerItem *, QgsComposerItem::ItemPositionMode > > &  snappedItems 
) const

Get nearest snap line.

Note
not available in python bindings
void QgsComposition::nPagesChanged ( )
signal
int QgsComposition::numPages ( ) const

Returns the number of pages in the composition.

Returns
number of pages
See also
setNumPages
bool QgsComposition::pageIsEmpty ( const int  page) const

Returns whether a page is empty, ie, it contains no items except for the background paper item.

Parameters
pagepage number, starting with 1
Returns
true if page is empty
Note
added in QGIS 2.5
See also
numPages
setNumPages
shouldExportPage
int QgsComposition::pageNumberAt ( const QPointF &  position) const

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

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

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

Note
Added in QGIS 2.1
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
QgsFillSymbolV2* QgsComposition::pageStyleSymbol ( )
inline

Note: added in version 2.1.

double QgsComposition::paperHeight ( ) const

Height of paper item.

Returns
height in mm
See also
paperWidth
setPaperSize
void QgsComposition::paperSizeChanged ( )
signal
double QgsComposition::paperWidth ( ) const

Width of paper item.

Returns
width in mm
See also
paperHeight
setPaperSize
int QgsComposition::pixelFontSize ( double  pointSize) const

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

Each item that sets a font should call this function before drawing text

Deprecated:
use QgsComposerUtils::pointsToMM instead
QgsComposition::PlotStyle QgsComposition::plotStyle ( ) const
inline
double QgsComposition::pointFontSize ( int  pixelSize) const

Does the inverse calculation and returns points for mm.

Deprecated:
use QgsComposerUtils::mmToPoints instead
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
bool QgsComposition::preventCursorChange ( ) const
inline
bool QgsComposition::print ( QPrinter &  printer,
const bool  evaluateDDPageSize = false 
)

Convenience function that prepares the printer and prints.

Returns
true if print was successful
bool QgsComposition::printAsRaster ( ) const
inline
QImage QgsComposition::printPageAsRaster ( int  page)

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

int QgsComposition::printResolution ( ) const
inline
void QgsComposition::printResolutionChanged ( )
signal

Is emitted when the compositions print resolution changes.

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

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

bool QgsComposition::raiseItem ( QgsComposerItem item)
void QgsComposition::raiseSelectedItems ( )
bool QgsComposition::readXML ( const QDomElement &  compositionElem,
const QDomDocument &  doc 
)

Reads settings from xml file.

void QgsComposition::refreshDataDefinedProperty ( const QgsComposerObject::DataDefinedProperty  property = QgsComposerObject::AllProperties)
slot

Refreshes a data defined property for the composition by reevaluating the property's value and redrawing the composition with this new value.

Parameters
propertydata defined property to refresh. If property is set to QgsComposerItem::AllProperties then all data defined properties for the composition will be refreshed.
Note
this method was added in version 2.5
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. Calling this also triggers a recalculation of all data defined attributes within the composition.

Note
added in version 2.3
void QgsComposition::refreshItemsTriggered ( )
signal

Is emitted when item in the composition must be refreshed.

void QgsComposition::refreshZList ( )

Rebuilds the z order list by adding any item which are present in the composition but missing from the z order list.

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

Returns a scaled position given a before and after range.

Deprecated:
use QgsComposerUtils::relativePosition instead
void QgsComposition::relativeResizeRect ( QRectF &  rectToResize,
const QRectF &  boundsBefore,
const QRectF &  boundsAfter 
)
static

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

Deprecated:
use QgsComposerUtils::relativeResizeRect instead
void QgsComposition::removeComposerItem ( QgsComposerItem item,
const bool  createCommand = true,
const bool  removeGroupItems = true 
)

Remove item from the graphics scene.

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

void QgsComposition::removeItemFromZList ( QgsComposerItem item)

Removes item from z list.

Usually called from destructor of QgsComposerItem

void QgsComposition::removeMultiFrame ( QgsComposerMultiFrame multiFrame)

Removes multi frame (but does not delete it)

void QgsComposition::removeSnapLine ( QGraphicsLineItem *  line)

Remove custom snap line (and delete the object)

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

Render a page to a paint device.

Parameters
pdestination painter
pagepage number, 0 based such that the first page is page 0
QList< QgsComposerItem * > QgsComposition::selectedComposerItems ( const bool  includeLockedItems = true)

Returns list of selected composer items.

Parameters
includeLockedItemsset to true to include locked items in list
Returns
list of selected items
void QgsComposition::selectedItemChanged ( QgsComposerItem selected)
signal

Is emitted when selected item changed.

If 0, no item is selected

QgsComposerMouseHandles* QgsComposition::selectionHandles ( )
inline

Returns pointer to selection handles.

Note
not available in python bindings
void QgsComposition::selectNextByZOrder ( const ZValueDirection  direction)
void QgsComposition::sendItemAddedSignal ( QgsComposerItem item)
slot

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

void QgsComposition::setAlignmentSnap ( const bool  s)
inline
Q_DECL_DEPRECATED void QgsComposition::setAlignmentSnapTolerance ( double  t)
inline

Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides and the edges and centers of other items.

Parameters
tsnap tolerance in pixels
See also
alignmentSnapTolerance
Deprecated:
Use setSnapTolerance instead
void QgsComposition::setAllUnselected ( )
slot

Clears any selected items in the composition.

Call this method rather than QGraphicsScene::clearSelection, as the latter does not correctly emit signals to allow the composition's model to update.

Note
added in version 2.5
bool QgsComposition::setAtlasMode ( const QgsComposition::AtlasMode  mode)

Sets the current atlas mode of the composition.

Parameters
modeatlas mode to switch to
Returns
false if the mode could not be changed.
See also
atlasMode
void QgsComposition::setDataDefinedProperty ( const QgsComposerObject::DataDefinedProperty  property,
bool  active,
bool  useExpression,
const QString &  expression,
const QString &  field 
)

Sets parameters for a data defined property for the composition.

Parameters
propertydata defined property to set
activetrue if data defined property is active, false if it is disabled
useExpressiontrue if the expression should be used
expressionexpression for data defined property
fieldfield name if the data defined property should take its value from a field
Note
this method was added in version 2.5
void QgsComposition::setGenerateWorldFile ( const bool  enabled)
inline
void QgsComposition::setGridPen ( const QPen &  p)
void QgsComposition::setGridStyle ( const GridStyle  s)
void QgsComposition::setGridVisible ( const bool  b)
void QgsComposition::setNumPages ( const int  pages)

Sets the number of pages for the composition.

Parameters
pagesnumber of pages
See also
numPages
void QgsComposition::setPageStyleSymbol ( QgsFillSymbolV2 symbol)

Note: added in version 2.1.

void QgsComposition::setPaperSize ( const double  width,
const 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.

Parameters
widthpage width in mm
heightpage height in mm
See also
paperHeight
paperWidth
void QgsComposition::setPlotStyle ( const QgsComposition::PlotStyle  style)
inline
void QgsComposition::setPreventCursorChange ( const 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.

void QgsComposition::setPrintAsRaster ( const bool  enabled)
inline
void QgsComposition::setPrintResolution ( const int  dpi)
void QgsComposition::setSelectedItem ( QgsComposerItem item)
slot

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

Parameters
itemitem to set as selected
Note
added in version 2.3
void QgsComposition::setSmartGuidesEnabled ( const bool  b)
inline
void QgsComposition::setSnapGridOffsetX ( const double  offset)
void QgsComposition::setSnapGridOffsetY ( const double  offset)
void QgsComposition::setSnapGridResolution ( const double  r)
Q_DECL_DEPRECATED void QgsComposition::setSnapGridTolerance ( double  tolerance)
inline

Sets the snap tolerance to use when automatically snapping items during movement and resizing to the composition grid.

Parameters
tolerancesnap tolerance in pixels
See also
snapGridTolerance
Deprecated:
Use setSnapTolerance instead
void QgsComposition::setSnapLinesVisible ( const bool  visible)

Hides / shows custom snap lines.

void QgsComposition::setSnapToGridEnabled ( const bool  b)
void QgsComposition::setSnapTolerance ( const int  snapTolerance)
inline

Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides and the edges and centers of other items.

Parameters
snapTolerancesnap tolerance in pixels
See also
alignmentSnapTolerance
Note
Added in QGIS 2.5
void QgsComposition::setStatusMessage ( const QString &  message)

Sets the status bar message for the composer window.

Note
Added in QGIS 2.1
void QgsComposition::setUseAdvancedEffects ( const bool  effectsEnabled)

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

void QgsComposition::setWorldFileMap ( QgsComposerMap map)
inline
bool QgsComposition::shouldExportPage ( const int  page) const

Returns whether a specified page number should be included in exports of the composition.

Parameters
pagepage number, starting with 1
Returns
true if page should be exported
Note
added in QGIS 2.5
See also
numPages
pageIsEmpty
bool QgsComposition::smartGuidesEnabled ( ) const
inline
double QgsComposition::snapGridOffsetX ( ) const
inline
double QgsComposition::snapGridOffsetY ( ) const
inline
double QgsComposition::snapGridResolution ( ) const
inline
Q_DECL_DEPRECATED double QgsComposition::snapGridTolerance ( ) const
inline

Returns the snap tolerance to use when automatically snapping items during movement and resizing to the composition grid.

Returns
snap tolerance in pixels
See also
setSnapGridTolerance
Deprecated:
Use snapTolerance instead
QList< QGraphicsLineItem* >* QgsComposition::snapLines ( )
inline

Returns pointer to snap lines collection.

bool QgsComposition::snapLinesVisible ( ) const
inline
QPointF QgsComposition::snapPointToGrid ( const QPointF &  scenePoint) const

Snaps a scene coordinate point to grid.

bool QgsComposition::snapToGridEnabled ( ) const
inline
int QgsComposition::snapTolerance ( ) const
inline

Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides and the edges and centers of other items.

Returns
snap tolerance in pixels
See also
setAlignmentSnapTolerance
Note
Added in QGIS 2.5
Q_DECL_DEPRECATED void QgsComposition::sortZList ( )
inline

Sorts the zList.

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

Deprecated:
use refreshZList instead
double QgsComposition::spaceBetweenPages ( ) const
inline

Returns the vertical space between pages in a composer view.

Returns
space between pages in mm
void QgsComposition::statusMsgChanged ( QString  message)
signal

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

QUndoStack* QgsComposition::undoStack ( )
inline

Returns pointer to undo/redo command storage.

QList< QgsComposerItem * > QgsComposition::ungroupItems ( QgsComposerItemGroup group)

Ungroups items by removing them from an item group and removing the group from the composition.

Parameters
groupitem group to ungroup
Returns
list of items removed from the group, or an empty list if ungrouping was not successful
Note
added in QGIS 2.6
void QgsComposition::unlockAllItems ( )

Unlock all items.

void QgsComposition::updateBounds ( )
slot

Updates the scene bounds of the composition.

Note
added in version 2.2
void QgsComposition::updateSettings ( )

Refreshes the composition when composer related options change.

Note
added in version 2.1
bool QgsComposition::useAdvancedEffects ( ) const
inline

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

QgsComposerMap* QgsComposition::worldFileMap ( ) const
inline
bool QgsComposition::writeXML ( QDomElement &  composerElem,
QDomDocument &  doc 
)

Writes settings to xml (paper dimension)

Friends And Related Function Documentation

friend class QgsComposerModel
friend
friend class QgsComposerObject
friend

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