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

Graphics scene for map printing. More...

#include <qgscomposition.h>

Inheritance diagram for QgsComposition:
Inheritance graph
[legend]
Collaboration diagram for QgsComposition:
Collaboration 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  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...
 

Signals

void paperSizeChanged ()
 
void nPagesChanged ()
 
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 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...
 
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 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...
 
QgsComposerItemcomposerItemAt (const QPointF &position)
 Returns the topmost composer item. More...
 
QgsComposerItemcomposerItemAt (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 QgsComposerMapgetComposerMapById (int id) const
 Returns the composer map with specified id. More...
 
const QgsComposerHtmlgetComposerHtmlByItem (QgsComposerItem *item) const
 
const QgsComposerItemgetComposerItemById (QString theId) const
 Returns a composer item given its text identifier. More...
 
const QgsComposerItemgetComposerItemByUuid (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)
 
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 (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 (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)
 
QgsComposerItemgetComposerItemBelow (QgsComposerItem *item)
 
QgsComposerItemgetComposerItemAbove (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...
 
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 (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...
 
void print (QPrinter &printer)
 Convenience function that prepares the printer and prints. More...
 
void 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 (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

QgsMapRenderermMapRenderer
 Pointer to map renderer of QGIS main map. More...
 
const QgsMapSettingsmMapSettings
 
QgsComposition::PlotStyle mPlotStyle
 
double mPageWidth
 
double mPageHeight
 
QList< QgsPaperItem * > mPages
 
double mSpaceBetweenPages
 
QgsFillSymbolV2mPageStyleSymbol
 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...
 
QgsComposerMapmWorldFileMap
 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...
 
QgsComposerMouseHandlesmSelectionHandles
 
QUndoStack mUndoStack
 
QgsComposerItemCommandmActiveItemCommand
 
QgsComposerMultiFrameCommandmActiveMultiFrameCommand
 
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

Composition atlas modes.

Enumerator
AtlasOff 
PreviewAtlas 
ExportAtlas 

Definition at line 98 of file qgscomposition.h.

Style to draw the snapping grid.

Enumerator
Solid 
Dots 
Crosses 

Definition at line 80 of file qgscomposition.h.

Plot type.

Enumerator
Preview 
Print 
Postscript 

Definition at line 72 of file qgscomposition.h.

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 ( )
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 2027 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 2117 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 2037 of file qgscomposition.cpp.

References composerLabelAdded(), and updateBounds().

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

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 2077 of file qgscomposition.cpp.

References composerLegendAdded(), and updateBounds().

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

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 2047 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 2087 of file qgscomposition.cpp.

References composerPictureAdded(), and updateBounds().

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

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 2067 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 2097 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 2107 of file qgscomposition.cpp.

References composerTableAdded(), and updateBounds().

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

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
not available in python bindings

Definition at line 808 of file qgscomposition.cpp.

References addComposerArrow(), addComposerLabel(), addComposerLegend(), addComposerMap(), addComposerPicture(), addComposerScaleBar(), addComposerShape(), addComposerTable(), addMultiFrame(), QgsComposerMap::assignFreeId(), composerItems(), getComposerMapById(), minPointFromXml(), mItemZList, QgsComposerItem::move(), mPageHeight, mSpaceBetweenPages, pageNumberAt(), paperHeight(), QgsComposerMap::previewMode(), pushAddRemoveCommand(), QgsComposerHtml::readXML(), QgsComposerAttributeTable::readXML(), QgsComposerItemGroup::readXML(), QgsComposerShape::readXML(), QgsComposerPicture::readXML(), QgsComposerArrow::readXML(), QgsComposerLabel::readXML(), QgsComposerLegend::readXML(), QgsComposerScaleBar::readXML(), QgsComposerMap::readXML(), QgsComposerMap::Rectangle, refreshZList(), selectedItemChanged(), QgsComposerMultiFrame::setCreateUndoCommands(), QgsComposerItem::setItemPosition(), QgsComposerMap::setPreviewMode(), QgsComposerItem::setSelected(), QgsComposerMap::setUpdatesEnabled(), QgsComposerShape::setUseSymbolV2(), spaceBetweenPages(), and tr.

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 1140 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 2013 of file qgscomposition.cpp.

References mMultiFrames, and updateBounds().

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

void QgsComposition::addPaperItem ( )
private
QGraphicsLineItem * QgsComposition::addSnapLine ( )

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

Definition at line 1676 of file qgscomposition.cpp.

References mGuidesVisible, and mSnapLines.

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

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

Definition at line 185 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::alignPos().

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
void QgsComposition::beginCommand ( QgsComposerItem item,
const QString &  commandText,
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)

Definition at line 1944 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 
)
void QgsComposition::beginPrint ( QPrinter &  printer)

Prepare the printer for printing.

Definition at line 2391 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 2338 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 1815 of file qgscomposition.cpp.

References selectedComposerItems().

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

void QgsComposition::cancelCommand ( )

Deletes current command.

Definition at line 1982 of file qgscomposition.cpp.

References mActiveItemCommand.

Referenced by QgsComposerItem::cancelCommand().

void QgsComposition::clearSnapLines ( )

Removes all snap lines.

Definition at line 1699 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 314 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 319 of file qgscomposition.cpp.

template<class T >
void QgsComposition::composerItems ( QList< T * > &  itemList)
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 381 of file qgscomposition.cpp.

Referenced by QgsComposerMap::assignFreeId(), QgsComposerView::mousePressEvent(), 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 184 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
void QgsComposition::connectAddRemoveCommandSignals ( QgsAddRemoveItemCommand c)
private

Definition at line 2209 of file qgscomposition.cpp.

References itemRemoved(), and sendItemAddedSignal().

Referenced by pushAddRemoveCommand(), and removeComposerItem().

void QgsComposition::createDefaultPageStyleSymbol ( )
private

Definition at line 273 of file qgscomposition.cpp.

References QgsFillSymbolV2::createSimple(), and mPageStyleSymbol.

Referenced by init().

void QgsComposition::deleteAndRemoveMultiFrames ( )
private

Definition at line 2328 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 2354 of file qgscomposition.cpp.

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

Referenced by print().

QString QgsComposition::encodeStringForXML ( const QString &  str)
staticprivate

Definition at line 2461 of file qgscomposition.cpp.

Referenced by loadFromTemplate().

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

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

Definition at line 2347 of file qgscomposition.cpp.

References beginPrintAsPDF(), and print().

bool QgsComposition::generateWorldFile ( ) const
inline

Definition at line 249 of file qgscomposition.h.

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

Definition at line 417 of file qgscomposition.cpp.

References QgsComposerFrame::multiFrame().

QgsComposerItem * QgsComposition::getComposerItemAbove ( QgsComposerItem item)

Definition at line 1188 of file qgscomposition.cpp.

References mItemZList.

Referenced by selectNextByZOrder().

QgsComposerItem * QgsComposition::getComposerItemBelow ( QgsComposerItem item)

Definition at line 1203 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 436 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
theUuidA QString representing the UUID of the item to

Definition at line 491 of file qgscomposition.cpp.

References QgsComposerItem::uuid().

const QgsComposerMap * QgsComposition::getComposerMapById ( int  id) const
const QPen& QgsComposition::gridPen ( ) const
inline

Definition at line 179 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

GridStyle QgsComposition::gridStyle ( ) const
inline

Definition at line 182 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

bool QgsComposition::gridVisible ( ) const
inline

Definition at line 151 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 357 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
doctemplate document
substitutionMapmap with text to replace. Text needs to be enclosed by brackets (e.g. '[text]' )
addUndoCommandswhether or not to add undo commands

Definition at line 701 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 1912 of file qgscomposition.cpp.

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

Referenced by init(), and updateSettings().

void QgsComposition::lockSelectedItems ( )
void QgsComposition::lowerItem ( QgsComposerItem item)

Definition at line 1271 of file qgscomposition.cpp.

References mItemZList.

Referenced by lowerSelectedItems().

void QgsComposition::lowerSelectedItems ( )

Definition at line 1257 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 264 of file qgscomposition.h.

Referenced by QgsComposerMap::mapRenderer().

const QgsMapSettings& QgsComposition::mapSettings ( ) const
inline
QPointF QgsComposition::minPointFromXml ( const QDomElement &  elem) const
private

Calculates the item minimum position from an xml string.

Definition at line 779 of file qgscomposition.cpp.

References MathUtils::max().

Referenced by addItemsFromXML().

void QgsComposition::moveItemToBottom ( QgsComposerItem item)

Definition at line 1327 of file qgscomposition.cpp.

References mItemZList.

Referenced by moveSelectedItemsToBottom().

void QgsComposition::moveItemToTop ( QgsComposerItem item)

Definition at line 1302 of file qgscomposition.cpp.

References mItemZList.

Referenced by moveSelectedItemsToTop().

void QgsComposition::moveSelectedItemsToBottom ( )

Definition at line 1313 of file qgscomposition.cpp.

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

void QgsComposition::moveSelectedItemsToTop ( )

Definition at line 1287 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 
)
void QgsComposition::nPagesChanged ( )
signal

Referenced by setNumPages().

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

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

Definition at line 352 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 301 of file qgscomposition.cpp.

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

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 457 of file qgscomposition.h.

QgsFillSymbolV2* QgsComposition::pageStyleSymbol ( )
inline

Note: added in version 2.1.

Definition at line 126 of file qgscomposition.h.

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

double QgsComposition::paperHeight ( ) const
void QgsComposition::paperSizeChanged ( )
signal

Referenced by readXML(), and setPaperSize().

double QgsComposition::paperWidth ( ) const
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 528 of file qgscomposition.cpp.

QgsComposition::PlotStyle QgsComposition::plotStyle ( ) const
inline
double QgsComposition::pointFontSize ( int  pixelSize) const

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

Definition at line 535 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 284 of file qgscomposition.cpp.

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

bool QgsComposition::preventCursorChange ( )
inline

Definition at line 414 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::setViewportCursor().

void QgsComposition::print ( QPrinter &  printer)

Convenience function that prepares the printer and prints.

Definition at line 2401 of file qgscomposition.cpp.

References beginPrint(), and doPrint().

Referenced by exportAsPDF().

bool QgsComposition::printAsRaster ( ) const
inline

Definition at line 246 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 2408 of file qgscomposition.cpp.

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

Referenced by doPrint().

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

Definition at line 1173 of file qgscomposition.cpp.

References mItemZList.

Referenced by raiseSelectedItems().

void QgsComposition::raiseSelectedItems ( )

Definition at line 1159 of file qgscomposition.cpp.

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

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

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

Definition at line 1614 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 2580 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 2569 of file qgscomposition.cpp.

References relativePosition().

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

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

Removes item from z list.

Usually called from destructor of QgsComposerItem

Definition at line 1150 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 2020 of file qgscomposition.cpp.

References mMultiFrames, and updateBounds().

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

void QgsComposition::removePaperItems ( )
private

Definition at line 2318 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 1692 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 2426 of file qgscomposition.cpp.

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

Referenced by doPrint(), and printPageAsRaster().

QList< QgsComposerItem * > QgsComposition::selectedComposerItems ( )
void QgsComposition::selectedItemChanged ( QgsComposerItem selected)
signal

Is emitted when selected item changed.

If 0, no item is selected

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

QgsComposerMouseHandles* QgsComposition::selectionHandles ( )
inline

Returns pointer to selection handles.

Note
not available in python bindings

Definition at line 356 of file qgscomposition.h.

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

void QgsComposition::selectNextByZOrder ( ZValueDirection  direction)
void QgsComposition::sendItemAddedSignal ( QgsComposerItem item)
slot
void QgsComposition::setAlignmentSnap ( bool  s)
inline

Definition at line 157 of file qgscomposition.h.

void QgsComposition::setAlignmentSnapTolerance ( double  t)
inline

Definition at line 184 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 2534 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 250 of file qgscomposition.h.

void QgsComposition::setGridPen ( const QPen &  p)

Definition at line 1890 of file qgscomposition.cpp.

References mGridPen, and updatePaperItems().

void QgsComposition::setGridStyle ( GridStyle  s)

Definition at line 1898 of file qgscomposition.cpp.

References mGridStyle, and updatePaperItems().

void QgsComposition::setGridVisible ( bool  b)

Definition at line 1861 of file qgscomposition.cpp.

References mGridVisible, and updatePaperItems().

void QgsComposition::setNumPages ( int  pages)
void QgsComposition::setPageStyleSymbol ( QgsFillSymbolV2 symbol)

Note: added in version 2.1.

Definition at line 267 of file qgscomposition.cpp.

References mPageStyleSymbol.

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

Changes size of paper item.

Definition at line 209 of file qgscomposition.cpp.

References mPageHeight, mPages, mPageWidth, mSpaceBetweenPages, paperSizeChanged(), and updateBounds().

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

Definition at line 271 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 413 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 247 of file qgscomposition.h.

void QgsComposition::setPrintResolution ( int  dpi)
inline

Definition at line 244 of file qgscomposition.h.

void QgsComposition::setSmartGuidesEnabled ( bool  b)
inline

Definition at line 160 of file qgscomposition.h.

void QgsComposition::setSnapGridOffsetX ( double  offset)

Definition at line 1878 of file qgscomposition.cpp.

References mSnapGridOffsetX, and updatePaperItems().

void QgsComposition::setSnapGridOffsetY ( double  offset)

Definition at line 1884 of file qgscomposition.cpp.

References mSnapGridOffsetY, and updatePaperItems().

void QgsComposition::setSnapGridResolution ( double  r)

Definition at line 1867 of file qgscomposition.cpp.

References mSnapGridResolution, and updatePaperItems().

void QgsComposition::setSnapGridTolerance ( double  tolerance)

Definition at line 1873 of file qgscomposition.cpp.

References mSnapGridTolerance.

void QgsComposition::setSnapLinesVisible ( bool  visible)

Hides / shows custom snap lines.

Definition at line 1710 of file qgscomposition.cpp.

References mGuidesVisible, and mSnapLines.

Referenced by renderPage().

void QgsComposition::setSnapToGridEnabled ( bool  b)

Definition at line 1855 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 309 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 511 of file qgscomposition.cpp.

References mUseAdvancedEffects, and QgsComposerItem::setEffectsEnabled().

void QgsComposition::setWorldFileMap ( QgsComposerMap map)
inline

Definition at line 253 of file qgscomposition.h.

bool QgsComposition::smartGuidesEnabled ( ) const
inline
double QgsComposition::snapGridOffsetX ( ) const
inline

Definition at line 173 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

double QgsComposition::snapGridOffsetY ( ) const
inline

Definition at line 176 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

double QgsComposition::snapGridResolution ( ) const
inline

Definition at line 167 of file qgscomposition.h.

Referenced by QgsPaperGrid::paint().

double QgsComposition::snapGridTolerance ( ) const
inline

Definition at line 170 of file qgscomposition.h.

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

Returns pointer to snap lines collection.

Definition at line 351 of file qgscomposition.h.

Referenced by QgsComposerMouseHandles::collectAlignCoordinates().

bool QgsComposition::snapLinesVisible ( ) const
inline

Definition at line 155 of file qgscomposition.h.

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

Definition at line 148 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 1588 of file qgscomposition.cpp.

References mItemZList.

double QgsComposition::spaceBetweenPages ( ) const
inline
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 188 of file qgscomposition.h.

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

void QgsComposition::unlockAllItems ( )
void QgsComposition::updateBounds ( )
slot
void QgsComposition::updatePaperItems ( )
private
void QgsComposition::updateSettings ( )

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

Definition at line 1904 of file qgscomposition.cpp.

References loadSettings(), and updatePaperItems().

void QgsComposition::updateZValues ( bool  addUndoCommands = true)
private
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 257 of file qgscomposition.h.

Referenced by QgsComposerMap::draw().

QgsComposerMap* QgsComposition::worldFileMap ( ) const
inline

Definition at line 252 of file qgscomposition.h.

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

Member Data Documentation

QgsComposerItemCommand* QgsComposition::mActiveItemCommand
private

Definition at line 529 of file qgscomposition.h.

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

QgsComposerMultiFrameCommand* QgsComposition::mActiveMultiFrameCommand
private
bool QgsComposition::mAlignmentSnap
private

Parameters for alignment snap.

Definition at line 517 of file qgscomposition.h.

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

double QgsComposition::mAlignmentSnapTolerance
private

Definition at line 520 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 533 of file qgscomposition.h.

Referenced by setAtlasMode().

QgsComposition::AtlasMode QgsComposition::mAtlasMode
private

Definition at line 535 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 499 of file qgscomposition.h.

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

QPen QgsComposition::mGridPen
private

Definition at line 513 of file qgscomposition.h.

Referenced by loadSettings(), and setGridPen().

GridStyle QgsComposition::mGridStyle
private

Definition at line 514 of file qgscomposition.h.

Referenced by loadSettings(), and setGridStyle().

bool QgsComposition::mGridVisible
private

Definition at line 508 of file qgscomposition.h.

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

bool QgsComposition::mGuidesVisible
private

Definition at line 518 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 487 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 473 of file qgscomposition.h.

const QgsMapSettings& QgsComposition::mMapSettings
private

Definition at line 474 of file qgscomposition.h.

QSet<QgsComposerMultiFrame*> QgsComposition::mMultiFrames
private

List multiframe objects.

Definition at line 490 of file qgscomposition.h.

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

double QgsComposition::mPageHeight
private
QList< QgsPaperItem* > QgsComposition::mPages
private
QgsFillSymbolV2* QgsComposition::mPageStyleSymbol
private

Drawing style for page.

Definition at line 483 of file qgscomposition.h.

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

double QgsComposition::mPageWidth
private

Definition at line 477 of file qgscomposition.h.

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

QgsComposition::PlotStyle QgsComposition::mPlotStyle
private

Definition at line 476 of file qgscomposition.h.

Referenced by init(), and renderPage().

bool QgsComposition::mPreventCursorChange
private

Definition at line 567 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 496 of file qgscomposition.h.

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

int QgsComposition::mPrintResolution
private

Dpi for printout.

Definition at line 493 of file qgscomposition.h.

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

QgsComposerMouseHandles* QgsComposition::mSelectionHandles
private

Definition at line 525 of file qgscomposition.h.

Referenced by init().

bool QgsComposition::mSmartGuides
private

Definition at line 519 of file qgscomposition.h.

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

double QgsComposition::mSnapGridOffsetX
private
double QgsComposition::mSnapGridOffsetY
private
double QgsComposition::mSnapGridResolution
private
double QgsComposition::mSnapGridTolerance
private
QList< QGraphicsLineItem* > QgsComposition::mSnapLines
private

Arbitraty snap lines (horizontal and vertical)

Definition at line 523 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 507 of file qgscomposition.h.

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

double QgsComposition::mSpaceBetweenPages
private

Definition at line 480 of file qgscomposition.h.

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

QUndoStack QgsComposition::mUndoStack
private
bool QgsComposition::mUseAdvancedEffects
private

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

True by default

Definition at line 504 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 501 of file qgscomposition.h.

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


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