QGIS API Documentation
2.12.0-Lyon
|
A legend that can be placed onto a map composition. More...
#include <qgscomposerlegend.h>
Public Slots | |
void | invalidateCurrentMap () |
Sets mCompositionMap to 0 if the map is deleted. More... | |
void | synchronizeWithModel () |
Data changed. More... | |
Public Slots inherited from QgsComposerItem | |
virtual void | refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties, const QgsExpressionContext *context=0) override |
Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More... | |
void | repaint () override |
virtual void | setItemRotation (const double r, const bool adjustPosition=false) |
Sets the item rotation. More... | |
virtual void | setRotation (double r) |
Sets the item rotation. More... | |
Public Slots inherited from QgsComposerObject | |
virtual void | refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties, const QgsExpressionContext *context=0) |
Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More... | |
virtual void | repaint () |
Triggers a redraw for the item. More... | |
Public Member Functions | |
QgsComposerLegend (QgsComposition *composition) | |
~QgsComposerLegend () | |
void | adjustBoxSize () |
Sets item box to the whole content. More... | |
bool | autoUpdateModel () const |
double | boxSpace () const |
int | columnCount () const |
double | columnSpace () const |
const QgsComposerMap * | composerMap () const |
virtual QString | displayName () const override |
Get item display name. More... | |
bool | drawRasterBorder () const |
Returns whether a border will be drawn around raster symbol items. More... | |
bool | equalColumnWidth () const |
QColor | fontColor () const |
bool | legendFilterByMapEnabled () const |
Find out whether legend items are filtered to show just the ones visible in the associated map. More... | |
Q_DECL_DEPRECATED QgsLegendModel * | model () |
Returns pointer to the legend model. More... | |
QgsLegendModelV2 * | modelV2 () |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override |
Reimplementation of QCanvasItem::paint. More... | |
QSizeF | paintAndDetermineSize (QPainter *painter) |
Paints the legend and calculates its size. More... | |
QColor | rasterBorderColor () const |
Returns the border color for the border drawn around raster symbol items. More... | |
double | rasterBorderWidth () const |
Returns the border width (in millimeters) for the border drawn around raster symbol items. More... | |
bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) override |
Sets state from Dom document. More... | |
QgsComposerLegendStyle & | rstyle (QgsComposerLegendStyle::Style s) |
Returns reference to modifiable style. More... | |
void | setAutoUpdateModel (bool autoUpdate) |
void | setBoxSpace (double s) |
void | setColumnCount (int c) |
void | setColumnSpace (double s) |
void | setComposerMap (const QgsComposerMap *map) |
void | setDrawRasterBorder (bool enabled) |
Sets whether a border will be drawn around raster symbol items. More... | |
void | setEqualColumnWidth (bool s) |
void | setFontColor (const QColor &c) |
void | setLegendFilterByMapEnabled (bool enabled) |
Set whether legend items should be filtered to show just the ones visible in the associated map. More... | |
void | setRasterBorderColor (const QColor &color) |
Sets the border color for the border drawn around raster symbol items. More... | |
void | setRasterBorderWidth (double width) |
Sets the border width for the border drawn around raster symbol items. More... | |
void | setSplitLayer (bool s) |
void | setStyle (QgsComposerLegendStyle::Style s, const QgsComposerLegendStyle &style) |
void | setStyleFont (QgsComposerLegendStyle::Style s, const QFont &f) |
Set style font. More... | |
void | setStyleMargin (QgsComposerLegendStyle::Style s, double margin) |
Set style margin. More... | |
void | setStyleMargin (QgsComposerLegendStyle::Style s, QgsComposerLegendStyle::Side side, double margin) |
void | setSymbolHeight (double h) |
void | setSymbolWidth (double w) |
void | setTitle (const QString &t) |
void | setTitleAlignment (Qt::AlignmentFlag alignment) |
Sets the alignment of the legend title. More... | |
void | setWmsLegendHeight (double h) |
void | setWmsLegendWidth (double w) |
void | setWrapChar (const QString &t) |
bool | splitLayer () const |
QgsComposerLegendStyle | style (QgsComposerLegendStyle::Style s) const |
Returns style. More... | |
QFont | styleFont (QgsComposerLegendStyle::Style s) const |
double | symbolHeight () const |
double | symbolWidth () const |
QString | title () const |
Qt::AlignmentFlag | titleAlignment () const |
Returns the alignment of the legend title. More... | |
virtual int | type () const override |
Return correct graphics item type. More... | |
void | updateLegend () |
Updates the model and all legend entries. More... | |
double | wmsLegendHeight () const |
double | wmsLegendWidth () const |
QString | wrapChar () const |
bool | writeXML (QDomElement &elem, QDomDocument &doc) const override |
Stores state in Dom node. More... | |
Public Member Functions inherited from QgsComposerItem | |
QgsComposerItem (QgsComposition *composition, bool manageZValue=true) | |
Constructor. More... | |
QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true) | |
Constructor with box position and composer object. More... | |
virtual | ~QgsComposerItem () |
bool | _readXML (const QDomElement &itemElem, const QDomDocument &doc) |
Reads parameter that are not subclass specific in document. More... | |
bool | _writeXML (QDomElement &itemElem, QDomDocument &doc) const |
Writes parameter that are not subclass specific in document. More... | |
virtual void | addItem (QgsComposerItem *item) |
Composite operations for item groups do nothing per default. More... | |
QColor | backgroundColor () const |
Gets the background color for this item. More... | |
void | beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown) |
Starts new composer undo command. More... | |
virtual void | beginItemCommand (const QString &text) |
QPainter::CompositionMode | blendMode () const |
Returns the item's composition blending mode. More... | |
void | cancelCommand () |
virtual QgsExpressionContext * | createExpressionContext () const override |
Creates an expression context relating to the objects's current state. More... | |
Q_DECL_DEPRECATED void | drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const |
Draws Text. More... | |
Q_DECL_DEPRECATED void | drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop, int flags=Qt::TextWordWrap) const |
Like the above, but with a rectangle for multiline text. More... | |
bool | effectsEnabled () const |
Returns whether effects (eg blend modes) are enabled for the item. More... | |
void | endCommand () |
Finish current command and push it onto the undo stack. More... | |
virtual void | endItemCommand () |
virtual double | estimatedFrameBleed () const |
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More... | |
bool | excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) |
Returns whether the item should be excluded from composer exports and prints. More... | |
Q_DECL_DEPRECATED double | fontAscentMillimeters (const QFont &font) const |
Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More... | |
Q_DECL_DEPRECATED double | fontDescentMillimeters (const QFont &font) const |
Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More... | |
Q_DECL_DEPRECATED double | fontHeightCharacterMM (const QFont &font, const QChar &c) const |
Returns the font height of a character in millimeters. More... | |
Q_DECL_DEPRECATED double | fontHeightMillimeters (const QFont &font) const |
Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More... | |
Qt::PenJoinStyle | frameJoinStyle () const |
Returns the join style used for drawing the item's frame. More... | |
QColor | frameOutlineColor () const |
Returns the frame's outline color. More... | |
double | frameOutlineWidth () const |
Returns the frame's outline width. More... | |
bool | hasBackground () const |
Whether this item has a Background or not. More... | |
bool | hasFrame () const |
Whether this item has a frame or not. More... | |
QString | id () const |
Get item's id (which is not necessarly unique) More... | |
bool | isGroupMember () const |
Returns whether this item is part of a group. More... | |
virtual bool | isRemoved () const |
Returns whether this item has been removed from the composition. More... | |
double | itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const |
Returns the current rotation for the composer item. More... | |
ItemPositionMode | lastUsedPositionMode () |
Returns item's last used position mode. More... | |
void | move (double dx, double dy) |
Moves item in canvas coordinates. More... | |
virtual void | moveContent (double dx, double dy) |
Move Content of item. More... | |
virtual int | numberExportLayers () const |
Get the number of layers that this item requires for exporting as layers. More... | |
int | page () const |
Gets the page the item is currently on. More... | |
QPointF | pagePos () const |
Returns the item's position relative to its current page. More... | |
Q_DECL_DEPRECATED double | pixelFontSize (double pointSize) const |
Calculates font size in mm from a font point size. More... | |
bool | positionLock () const |
Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. More... | |
virtual QRectF | rectWithFrame () const |
Returns the item's rectangular bounds, including any bleed caused by the item's frame. More... | |
virtual void | removeItems () |
Q_DECL_DEPRECATED double | rotation () const |
Returns the rotation for the composer item. More... | |
Q_DECL_DEPRECATED QFont | scaledFontPixelSize (const QFont &font) const |
Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. More... | |
virtual bool | selected () const |
Is selected. More... | |
void | setBackgroundColor (const QColor &backgroundColor) |
Sets the background color for this item. More... | |
void | setBackgroundEnabled (const bool drawBackground) |
Set whether this item has a Background drawn around it or not. More... | |
void | setBlendMode (const QPainter::CompositionMode blendMode) |
Sets the item's composition blending mode. More... | |
virtual void | setCurrentExportLayer (const int layerIdx=-1) |
Sets the current layer to draw for exporting. More... | |
void | setEffectsEnabled (const bool effectsEnabled) |
Sets whether effects (eg blend modes) are enabled for the item. More... | |
virtual void | setExcludeFromExports (const bool exclude) |
Sets whether the item should be excluded from composer exports and prints. More... | |
virtual void | setFrameEnabled (const bool drawFrame) |
Set whether this item has a frame drawn around it or not. More... | |
void | setFrameJoinStyle (const Qt::PenJoinStyle style) |
Sets join style used when drawing the item's frame. More... | |
virtual void | setFrameOutlineColor (const QColor &color) |
Sets frame outline color. More... | |
virtual void | setFrameOutlineWidth (const double outlineWidth) |
Sets frame outline width. More... | |
virtual void | setId (const QString &id) |
Set item's id (which is not necessarly unique) More... | |
void | setIsGroupMember (const bool isGroupMember) |
Sets whether this item is part of a group. More... | |
void | setIsRemoved (const bool removed) |
Sets whether this item has been removed from the composition. More... | |
void | setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1) |
Moves the item to a new position (in canvas coordinates) More... | |
void | setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft, bool posIncludesFrame=false, int page=-1) |
Sets item position and width / height in one go. More... | |
void | setPositionLock (const bool lock) |
Locks / unlocks the item position for mouse drags. More... | |
virtual void | setSceneRect (const QRectF &rectangle) |
Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit. More... | |
virtual void | setSelected (bool s) |
Set selected, selected item should be highlighted. More... | |
void | setTransparency (const int transparency) |
Sets the item's transparency. More... | |
virtual void | setVisibility (const bool visible) |
Sets visibility for item. More... | |
Q_DECL_DEPRECATED double | textWidthMillimeters (const QFont &font, const QString &text) const |
Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More... | |
int | transparency () const |
Returns the item's transparency. More... | |
virtual void | updateItem () |
Updates item, with the possibility to do custom update for subclasses. More... | |
void | updatePagePos (double newPageWidth, double newPageHeight) |
Moves the item so that it retains its relative position on the page when the paper size changes. More... | |
QString | uuid () const |
Get item identification name. More... | |
virtual Q_DECL_DEPRECATED void | zoomContent (int delta, double x, double y) |
Zoom content of item. More... | |
virtual void | zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom) |
Zoom content of item. More... | |
Public Member Functions inherited from QgsComposerObject | |
QgsComposerObject (QgsComposition *composition) | |
Constructor. More... | |
virtual | ~QgsComposerObject () |
const QgsComposition * | composition () const |
Returns the composition the item is attached to. More... | |
QgsComposition * | composition () |
QStringList | customProperties () const |
Return list of keys stored in custom properties for the object. More... | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from the object. More... | |
QgsDataDefined * | dataDefinedProperty (const DataDefinedProperty property) const |
Returns a reference to the data defined settings for one of the item's data defined properties. More... | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from the object. More... | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the object. More... | |
void | setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field) |
Sets parameters for a data defined property for the item. More... | |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
const QObjectList & | children () const |
const char * | className () const |
bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const QObject *receiver, const char *method) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
void | dumpObjectInfo () |
void | dumpObjectTree () |
QList< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) const |
QList< T > | findChildren (const QString &name) const |
bool | inherits (const char *className) const |
void | insertChild (QObject *object) |
void | installEventFilter (QObject *filterObj) |
bool | isA (const char *className) const |
bool | isWidgetType () const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () const |
QVariant | property (const char *name) const |
void | removeChild (QObject *object) |
void | removeEventFilter (QObject *obj) |
void | setName (const char *name) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const |
int | startTimer (int interval) |
QThread * | thread () const |
Public Member Functions inherited from QGraphicsRectItem | |
QGraphicsRectItem (QGraphicsItem *parent) | |
QGraphicsRectItem (const QRectF &rect, QGraphicsItem *parent) | |
QGraphicsRectItem (qreal x, qreal y, qreal width, qreal height, QGraphicsItem *parent) | |
~QGraphicsRectItem () | |
virtual QRectF | boundingRect () const |
virtual bool | contains (const QPointF &point) const |
virtual bool | isObscuredBy (const QGraphicsItem *item) const |
virtual QPainterPath | opaqueArea () const |
QRectF | rect () const |
void | setRect (const QRectF &rectangle) |
void | setRect (qreal x, qreal y, qreal width, qreal height) |
virtual QPainterPath | shape () const |
Public Member Functions inherited from QAbstractGraphicsShapeItem | |
QAbstractGraphicsShapeItem (QGraphicsItem *parent) | |
~QAbstractGraphicsShapeItem () | |
QBrush | brush () const |
QPen | pen () const |
void | setBrush (const QBrush &brush) |
void | setPen (const QPen &pen) |
Public Member Functions inherited from QGraphicsItem | |
QGraphicsItem (QGraphicsItem *parent) | |
virtual | ~QGraphicsItem () |
bool | acceptDrops () const |
Qt::MouseButtons | acceptedMouseButtons () const |
bool | acceptHoverEvents () const |
bool | acceptsHoverEvents () const |
bool | acceptTouchEvents () const |
virtual void | advance (int phase) |
virtual QRectF | boundingRect () const =0 |
QRegion | boundingRegion (const QTransform &itemToDeviceTransform) const |
qreal | boundingRegionGranularity () const |
CacheMode | cacheMode () const |
QList< QGraphicsItem * > | childItems () const |
QList< QGraphicsItem * > | children () const |
QRectF | childrenBoundingRect () const |
void | clearFocus () |
QPainterPath | clipPath () const |
virtual bool | collidesWithItem (const QGraphicsItem *other, Qt::ItemSelectionMode mode) const |
virtual bool | collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode) const |
QList< QGraphicsItem * > | collidingItems (Qt::ItemSelectionMode mode) const |
QGraphicsItem * | commonAncestorItem (const QGraphicsItem *other) const |
QCursor | cursor () const |
QVariant | data (int key) const |
QTransform | deviceTransform (const QTransform &viewportTransform) const |
qreal | effectiveOpacity () const |
void | ensureVisible (const QRectF &rect, int xmargin, int ymargin) |
void | ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin, int ymargin) |
bool | filtersChildEvents () const |
GraphicsItemFlags | flags () const |
QGraphicsItem * | focusItem () const |
QGraphicsItem * | focusProxy () const |
void | grabKeyboard () |
void | grabMouse () |
QGraphicsEffect * | graphicsEffect () const |
QGraphicsItemGroup * | group () const |
bool | handlesChildEvents () const |
bool | hasCursor () const |
bool | hasFocus () const |
void | hide () |
Qt::InputMethodHints | inputMethodHints () const |
void | installSceneEventFilter (QGraphicsItem *filterItem) |
bool | isActive () const |
bool | isAncestorOf (const QGraphicsItem *child) const |
bool | isBlockedByModalPanel (QGraphicsItem **blockingPanel) const |
bool | isClipped () const |
bool | isEnabled () const |
bool | isObscured () const |
bool | isObscured (const QRectF &rect) const |
bool | isObscured (qreal x, qreal y, qreal w, qreal h) const |
bool | isPanel () const |
bool | isSelected () const |
bool | isUnderMouse () const |
bool | isVisible () const |
bool | isVisibleTo (const QGraphicsItem *parent) const |
bool | isWidget () const |
bool | isWindow () const |
QTransform | itemTransform (const QGraphicsItem *other, bool *ok) const |
QPointF | mapFromItem (const QGraphicsItem *item, const QPointF &point) const |
QPolygonF | mapFromItem (const QGraphicsItem *item, const QRectF &rect) const |
QPolygonF | mapFromItem (const QGraphicsItem *item, const QPolygonF &polygon) const |
QPainterPath | mapFromItem (const QGraphicsItem *item, const QPainterPath &path) const |
QPointF | mapFromItem (const QGraphicsItem *item, qreal x, qreal y) const |
QPolygonF | mapFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const |
QPointF | mapFromParent (const QPointF &point) const |
QPolygonF | mapFromParent (const QRectF &rect) const |
QPolygonF | mapFromParent (const QPolygonF &polygon) const |
QPainterPath | mapFromParent (const QPainterPath &path) const |
QPointF | mapFromParent (qreal x, qreal y) const |
QPolygonF | mapFromParent (qreal x, qreal y, qreal w, qreal h) const |
QPolygonF | mapFromScene (const QPolygonF &polygon) const |
QPointF | mapFromScene (const QPointF &point) const |
QPolygonF | mapFromScene (const QRectF &rect) const |
QPainterPath | mapFromScene (const QPainterPath &path) const |
QPointF | mapFromScene (qreal x, qreal y) const |
QPolygonF | mapFromScene (qreal x, qreal y, qreal w, qreal h) const |
QRectF | mapRectFromItem (const QGraphicsItem *item, const QRectF &rect) const |
QRectF | mapRectFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const |
QRectF | mapRectFromParent (const QRectF &rect) const |
QRectF | mapRectFromParent (qreal x, qreal y, qreal w, qreal h) const |
QRectF | mapRectFromScene (qreal x, qreal y, qreal w, qreal h) const |
QRectF | mapRectFromScene (const QRectF &rect) const |
QRectF | mapRectToItem (const QGraphicsItem *item, const QRectF &rect) const |
QRectF | mapRectToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const |
QRectF | mapRectToParent (const QRectF &rect) const |
QRectF | mapRectToParent (qreal x, qreal y, qreal w, qreal h) const |
QRectF | mapRectToScene (const QRectF &rect) const |
QRectF | mapRectToScene (qreal x, qreal y, qreal w, qreal h) const |
QPointF | mapToItem (const QGraphicsItem *item, const QPointF &point) const |
QPolygonF | mapToItem (const QGraphicsItem *item, const QRectF &rect) const |
QPolygonF | mapToItem (const QGraphicsItem *item, const QPolygonF &polygon) const |
QPainterPath | mapToItem (const QGraphicsItem *item, const QPainterPath &path) const |
QPointF | mapToItem (const QGraphicsItem *item, qreal x, qreal y) const |
QPolygonF | mapToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const |
QPointF | mapToParent (const QPointF &point) const |
QPolygonF | mapToParent (const QRectF &rect) const |
QPainterPath | mapToParent (const QPainterPath &path) const |
QPointF | mapToParent (qreal x, qreal y) const |
QPolygonF | mapToParent (qreal x, qreal y, qreal w, qreal h) const |
QPolygonF | mapToParent (const QPolygonF &polygon) const |
QPolygonF | mapToScene (const QRectF &rect) const |
QPainterPath | mapToScene (const QPainterPath &path) const |
QPointF | mapToScene (qreal x, qreal y) const |
QPolygonF | mapToScene (qreal x, qreal y, qreal w, qreal h) const |
QPolygonF | mapToScene (const QPolygonF &polygon) const |
QPointF | mapToScene (const QPointF &point) const |
QMatrix | matrix () const |
void | moveBy (qreal dx, qreal dy) |
qreal | opacity () const |
virtual void | paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)=0 |
QGraphicsItem * | panel () const |
PanelModality | panelModality () const |
QGraphicsItem * | parentItem () const |
QGraphicsObject * | parentObject () const |
QGraphicsWidget * | parentWidget () const |
QPointF | pos () const |
void | removeSceneEventFilter (QGraphicsItem *filterItem) |
void | resetMatrix () |
void | resetTransform () |
void | rotate (qreal angle) |
qreal | rotation () const |
void | scale (qreal sx, qreal sy) |
qreal | scale () const |
QGraphicsScene * | scene () const |
QRectF | sceneBoundingRect () const |
QMatrix | sceneMatrix () const |
QPointF | scenePos () const |
QTransform | sceneTransform () const |
void | scroll (qreal dx, qreal dy, const QRectF &rect) |
void | setAcceptDrops (bool on) |
void | setAcceptedMouseButtons (QFlags< Qt::MouseButton > buttons) |
void | setAcceptHoverEvents (bool enabled) |
void | setAcceptsHoverEvents (bool enabled) |
void | setAcceptTouchEvents (bool enabled) |
void | setActive (bool active) |
void | setBoundingRegionGranularity (qreal granularity) |
void | setCacheMode (CacheMode mode, const QSize &logicalCacheSize) |
void | setCursor (const QCursor &cursor) |
void | setData (int key, const QVariant &value) |
void | setEnabled (bool enabled) |
void | setFiltersChildEvents (bool enabled) |
void | setFlag (GraphicsItemFlag flag, bool enabled) |
void | setFlags (QFlags< QGraphicsItem::GraphicsItemFlag > flags) |
void | setFocus (Qt::FocusReason focusReason) |
void | setFocusProxy (QGraphicsItem *item) |
void | setGraphicsEffect (QGraphicsEffect *effect) |
void | setGroup (QGraphicsItemGroup *group) |
void | setHandlesChildEvents (bool enabled) |
void | setInputMethodHints (QFlags< Qt::InputMethodHint > hints) |
void | setMatrix (const QMatrix &matrix, bool combine) |
void | setOpacity (qreal opacity) |
void | setPanelModality (PanelModality panelModality) |
void | setParentItem (QGraphicsItem *newParent) |
void | setPos (const QPointF &pos) |
void | setPos (qreal x, qreal y) |
void | setRotation (qreal angle) |
void | setScale (qreal factor) |
void | setSelected (bool selected) |
void | setToolTip (const QString &toolTip) |
void | setTransform (const QTransform &matrix, bool combine) |
void | setTransformations (const QList< QGraphicsTransform * > &transformations) |
void | setTransformOriginPoint (qreal x, qreal y) |
void | setTransformOriginPoint (const QPointF &origin) |
void | setVisible (bool visible) |
void | setX (qreal x) |
void | setY (qreal y) |
void | setZValue (qreal z) |
void | shear (qreal sh, qreal sv) |
void | show () |
void | stackBefore (const QGraphicsItem *sibling) |
QGraphicsObject * | toGraphicsObject () |
const QGraphicsObject * | toGraphicsObject () const |
QString | toolTip () const |
QGraphicsItem * | topLevelItem () const |
QGraphicsWidget * | topLevelWidget () const |
QTransform | transform () const |
QList< QGraphicsTransform * > | transformations () const |
QPointF | transformOriginPoint () const |
void | translate (qreal dx, qreal dy) |
void | ungrabKeyboard () |
void | ungrabMouse () |
void | unsetCursor () |
void | update (qreal x, qreal y, qreal width, qreal height) |
void | update (const QRectF &rect) |
QGraphicsWidget * | window () const |
qreal | x () const |
qreal | y () const |
qreal | zValue () const |
Additional Inherited Members | |
Public Types inherited from QgsComposerItem | |
enum | ItemPositionMode { UpperLeft, UpperMiddle, UpperRight, MiddleLeft, Middle, MiddleRight, LowerLeft, LowerMiddle, LowerRight } |
enum | ItemType { ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel, ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture, ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable, ComposerTextTable, ComposerFrame } |
enum | MouseMoveAction { MoveItem, ResizeUp, ResizeDown, ResizeLeft, ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown, ResizeRightDown, NoAction } |
Describes the action (move or resize in different directon) to be done during mouse move. More... | |
enum | ZoomMode { Zoom = 0, ZoomRecenter, ZoomToPoint, NoZoom } |
Modes for zooming item content. More... | |
Public Types inherited from QgsComposerObject | |
enum | DataDefinedProperty { NoProperty = 0, AllProperties, TestProperty, PresetPaperSize, PaperWidth, PaperHeight, NumPages, PaperOrientation, PageNumber, PositionX, PositionY, ItemWidth, ItemHeight, ItemRotation, Transparency, BlendMode, ExcludeFromExports, MapRotation, MapScale, MapXMin, MapYMin, MapXMax, MapYMax, MapAtlasMargin, MapLayers, MapStylePreset, PictureSource, SourceUrl } |
Data defined properties for different item types. More... | |
enum | PropertyValueType { EvaluatedValue = 0, OriginalValue } |
Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More... | |
Signals inherited from QgsComposerItem | |
void | frameChanged () |
Emitted if the item's frame style changes. More... | |
void | itemRotationChanged (double newRotation) |
Is emitted on item rotation change. More... | |
void | lockChanged () |
Emitted if the item's lock status changes. More... | |
void | sizeChanged () |
Emitted if the rectangle changes. More... | |
Signals inherited from QgsComposerObject | |
void | itemChanged () |
Emitted when the item changes. More... | |
Static Public Member Functions inherited from QObject | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Public Attributes inherited from QGraphicsItem | |
typedef | GraphicsItemFlags |
Protected Member Functions inherited from QgsComposerItem | |
Q_DECL_DEPRECATED double | angle (const QPointF &p1, const QPointF &p2) const |
Returns angle of the line from p1 to p2 (clockwise, starting at N) More... | |
Q_DECL_DEPRECATED bool | cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const |
Calculates corner point after rotation and scaling. More... | |
Q_DECL_DEPRECATED bool | cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const |
Calculates corner point after rotation and scaling. More... | |
void | deleteAlignItems () |
void | deleteHAlignSnapItem () |
void | deleteVAlignSnapItem () |
Q_DECL_DEPRECATED void | drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const |
Draws arrowhead. More... | |
virtual void | drawBackground (QPainter *p) |
Draw background. More... | |
virtual void | drawFrame (QPainter *p) |
Draw black frame around item. More... | |
virtual void | drawSelectionBoxes (QPainter *p) |
Draws additional graphics on selected items. More... | |
QRectF | evalItemRect (const QRectF &newRect, const bool resizeOnly=false, const QgsExpressionContext *context=0) |
Evaluates an item's bounding rect to consider data defined position and size of item and reference point. More... | |
QGraphicsLineItem * | hAlignSnapItem () |
Return horizontal align snap item. More... | |
double | horizontalViewScaleFactor () const |
Returns the zoom factor of the graphics view. More... | |
Q_DECL_DEPRECATED bool | imageSizeConsideringRotation (double &width, double &height, double rotation) const |
Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More... | |
Q_DECL_DEPRECATED bool | imageSizeConsideringRotation (double &width, double &height) const |
Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More... | |
Q_DECL_DEPRECATED QRectF | largestRotatedRectWithinBounds (const QRectF &originalRect, const QRectF &boundsRect, double rotation) const |
Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount. More... | |
Q_DECL_DEPRECATED double | lockSymbolSize () const |
Returns the size of the lock symbol depending on the composer zoom level and the item size. More... | |
double | rectHandlerBorderTolerance () const |
Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. More... | |
Q_DECL_DEPRECATED void | rotate (double angle, double &x, double &y) const |
Rotates a point / vector. More... | |
bool | shouldDrawItem () const |
Returns whether the item should be drawn in the current context. More... | |
Q_DECL_DEPRECATED void | sizeChangedByRotation (double &width, double &height, double rotation) |
Calculates width / height of the bounding box of a rotated rectangle. More... | |
Q_DECL_DEPRECATED void | sizeChangedByRotation (double &width, double &height) |
Calculates width / height of the bounding box of a rotated rectangle. More... | |
QGraphicsLineItem * | vAlignSnapItem () |
Return vertical align snap item. More... | |
Protected Member Functions inherited from QgsComposerObject | |
bool | dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue, const QgsExpressionContext &context=QgsExpressionContext()) const |
Evaluate a data defined property and return the calculated value. More... | |
Protected Member Functions inherited from QObject | |
bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const char *signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const char *signal) |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Protected Member Functions inherited from QGraphicsItem | |
virtual void | contextMenuEvent (QGraphicsSceneContextMenuEvent *event) |
virtual void | dragEnterEvent (QGraphicsSceneDragDropEvent *event) |
virtual void | dragLeaveEvent (QGraphicsSceneDragDropEvent *event) |
virtual void | dragMoveEvent (QGraphicsSceneDragDropEvent *event) |
virtual void | dropEvent (QGraphicsSceneDragDropEvent *event) |
virtual void | focusInEvent (QFocusEvent *event) |
virtual void | focusOutEvent (QFocusEvent *event) |
virtual void | hoverEnterEvent (QGraphicsSceneHoverEvent *event) |
virtual void | hoverLeaveEvent (QGraphicsSceneHoverEvent *event) |
virtual void | hoverMoveEvent (QGraphicsSceneHoverEvent *event) |
virtual void | inputMethodEvent (QInputMethodEvent *event) |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery query) const |
virtual QVariant | itemChange (GraphicsItemChange change, const QVariant &value) |
virtual void | keyPressEvent (QKeyEvent *event) |
virtual void | keyReleaseEvent (QKeyEvent *event) |
virtual void | mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event) |
virtual void | mouseMoveEvent (QGraphicsSceneMouseEvent *event) |
virtual void | mousePressEvent (QGraphicsSceneMouseEvent *event) |
virtual void | mouseReleaseEvent (QGraphicsSceneMouseEvent *event) |
void | prepareGeometryChange () |
virtual bool | sceneEvent (QEvent *event) |
virtual bool | sceneEventFilter (QGraphicsItem *watched, QEvent *event) |
void | updateMicroFocus () |
virtual void | wheelEvent (QGraphicsSceneWheelEvent *event) |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Protected Attributes inherited from QgsComposerItem | |
bool | mBackground |
True if item background needs to be painted. More... | |
QColor | mBackgroundColor |
Background color. More... | |
QPainter::CompositionMode | mBlendMode |
Composition blend mode for item. More... | |
QGraphicsRectItem * | mBoundingResizeRectangle |
Rectangle used during move and resize actions. More... | |
int | mCurrentExportLayer |
The layer that needs to be exported. More... | |
QgsComposerItem::MouseMoveAction | mCurrentMouseMoveAction |
QgsComposerEffect * | mEffect |
bool | mEffectsEnabled |
bool | mEvaluatedExcludeFromExports |
Temporary evaluated item exclusion. More... | |
double | mEvaluatedItemRotation |
Temporary evaluated item rotation in degrees, clockwise. More... | |
bool | mExcludeFromExports |
Whether item should be excluded in exports. More... | |
bool | mFrame |
True if item fram needs to be painted. More... | |
Qt::PenJoinStyle | mFrameJoinStyle |
Frame join style. More... | |
QGraphicsLineItem * | mHAlignSnapItem |
bool | mIsGroupMember |
Whether or not this item is part of a group. More... | |
bool | mItemPositionLocked |
True if item position and size cannot be changed with mouse move. More... | |
double | mItemRotation |
Item rotation in degrees, clockwise. More... | |
QPointF | mLastMouseEventPos |
Position of the last mouse move event (in scene coordinates) More... | |
ItemPositionMode | mLastUsedPositionMode |
The item's position mode. More... | |
double | mLastValidViewScaleFactor |
Backup to restore item appearance if no view scale factor is available. More... | |
QPointF | mMouseMoveStartPos |
Start point of the last mouse move action (in scene coordinates) More... | |
bool | mRemovedFromComposition |
True if item has been removed from the composition. More... | |
int | mTransparency |
Item transparency. More... | |
QGraphicsLineItem * | mVAlignSnapItem |
Protected Attributes inherited from QgsComposerObject | |
QgsComposition * | mComposition |
QgsObjectCustomProperties | mCustomProperties |
Custom properties for object. More... | |
QMap< QgsComposerObject::DataDefinedProperty, QString > | mDataDefinedNames |
Map of data defined properties for the item to string name to use when exporting item to xml. More... | |
Properties inherited from QObject | |
objectName | |
A legend that can be placed onto a map composition.
Definition at line 56 of file qgscomposerlegend.h.
QgsComposerLegend::QgsComposerLegend | ( | QgsComposition * | composition | ) |
Definition at line 36 of file qgscomposerlegend.cpp.
QgsComposerLegend::~QgsComposerLegend | ( | ) |
Definition at line 59 of file qgscomposerlegend.cpp.
void QgsComposerLegend::adjustBoxSize | ( | ) |
Sets item box to the whole content.
Definition at line 144 of file qgscomposerlegend.cpp.
bool QgsComposerLegend::autoUpdateModel | ( | ) | const |
Definition at line 176 of file qgscomposerlegend.cpp.
double QgsComposerLegend::boxSpace | ( | ) | const |
Definition at line 212 of file qgscomposerlegend.cpp.
int QgsComposerLegend::columnCount | ( | ) | const |
Definition at line 236 of file qgscomposerlegend.cpp.
double QgsComposerLegend::columnSpace | ( | ) | const |
Definition at line 215 of file qgscomposerlegend.cpp.
|
inline |
Definition at line 215 of file qgscomposerlegend.h.
|
overridevirtual |
Get item display name.
This is the item's id if set, and if not, a user-friendly string identifying item type.
Reimplemented from QgsComposerItem.
Definition at line 501 of file qgscomposerlegend.cpp.
bool QgsComposerLegend::drawRasterBorder | ( | ) | const |
Returns whether a border will be drawn around raster symbol items.
Definition at line 245 of file qgscomposerlegend.cpp.
bool QgsComposerLegend::equalColumnWidth | ( | ) | const |
Definition at line 242 of file qgscomposerlegend.cpp.
QColor QgsComposerLegend::fontColor | ( | ) | const |
Definition at line 218 of file qgscomposerlegend.cpp.
|
slot |
Sets mCompositionMap to 0 if the map is deleted.
Definition at line 547 of file qgscomposerlegend.cpp.
|
inline |
Find out whether legend items are filtered to show just the ones visible in the associated map.
Definition at line 93 of file qgscomposerlegend.h.
|
inline |
Returns pointer to the legend model.
Definition at line 78 of file qgscomposerlegend.h.
|
inline |
Definition at line 81 of file qgscomposerlegend.h.
|
overridevirtual |
Reimplementation of QCanvasItem::paint.
Reimplemented from QGraphicsRectItem.
Definition at line 65 of file qgscomposerlegend.cpp.
Paints the legend and calculates its size.
If painter is 0, only size is calculated
Definition at line 134 of file qgscomposerlegend.cpp.
QColor QgsComposerLegend::rasterBorderColor | ( | ) | const |
Returns the border color for the border drawn around raster symbol items.
The border is only drawn if drawRasterBorder() is true.
Definition at line 248 of file qgscomposerlegend.cpp.
double QgsComposerLegend::rasterBorderWidth | ( | ) | const |
Returns the border width (in millimeters) for the border drawn around raster symbol items.
The border is only drawn if drawRasterBorder() is true.
Definition at line 251 of file qgscomposerlegend.cpp.
|
overridevirtual |
Sets state from Dom document.
itemElem | is Dom node corresponding to item tag |
doc | is Dom document |
Reimplemented from QgsComposerObject.
Definition at line 367 of file qgscomposerlegend.cpp.
QgsComposerLegendStyle & QgsComposerLegend::rstyle | ( | QgsComposerLegendStyle::Style | s | ) |
Returns reference to modifiable style.
Definition at line 202 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setAutoUpdateModel | ( | bool | autoUpdate | ) |
Definition at line 167 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setBoxSpace | ( | double | s | ) |
Definition at line 213 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setColumnCount | ( | int | c | ) |
Definition at line 237 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setColumnSpace | ( | double | s | ) |
Definition at line 216 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setComposerMap | ( | const QgsComposerMap * | map | ) |
Definition at line 524 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setDrawRasterBorder | ( | bool | enabled | ) |
Sets whether a border will be drawn around raster symbol items.
enabled | set to true to draw borders |
Definition at line 246 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setEqualColumnWidth | ( | bool | s | ) |
Definition at line 243 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setFontColor | ( | const QColor & | c | ) |
Definition at line 219 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setLegendFilterByMapEnabled | ( | bool | enabled | ) |
Set whether legend items should be filtered to show just the ones visible in the associated map.
Definition at line 181 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setRasterBorderColor | ( | const QColor & | color | ) |
Sets the border color for the border drawn around raster symbol items.
The border is only drawn if drawRasterBorder() is true.
color | border color |
Definition at line 249 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setRasterBorderWidth | ( | double | width | ) |
Sets the border width for the border drawn around raster symbol items.
The border is only drawn if drawRasterBorder() is true.
width | border width in millimeters |
Definition at line 252 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setSplitLayer | ( | bool | s | ) |
Definition at line 240 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setStyle | ( | QgsComposerLegendStyle::Style | s, |
const QgsComposerLegendStyle & | style | ||
) |
Definition at line 204 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setStyleFont | ( | QgsComposerLegendStyle::Style | s, |
const QFont & | f | ||
) |
Set style font.
Definition at line 207 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setStyleMargin | ( | QgsComposerLegendStyle::Style | s, |
double | margin | ||
) |
Set style margin.
Definition at line 209 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setStyleMargin | ( | QgsComposerLegendStyle::Style | s, |
QgsComposerLegendStyle::Side | side, | ||
double | margin | ||
) |
Definition at line 210 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setSymbolHeight | ( | double | h | ) |
Definition at line 225 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setSymbolWidth | ( | double | w | ) |
Definition at line 222 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setTitle | ( | const QString & | t | ) |
Definition at line 187 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setTitleAlignment | ( | Qt::AlignmentFlag | alignment | ) |
Sets the alignment of the legend title.
alignment | Text alignment for drawing the legend title |
Definition at line 200 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setWmsLegendHeight | ( | double | h | ) |
Definition at line 231 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setWmsLegendWidth | ( | double | w | ) |
Definition at line 228 of file qgscomposerlegend.cpp.
void QgsComposerLegend::setWrapChar | ( | const QString & | t | ) |
Definition at line 233 of file qgscomposerlegend.cpp.
bool QgsComposerLegend::splitLayer | ( | ) | const |
Definition at line 239 of file qgscomposerlegend.cpp.
QgsComposerLegendStyle QgsComposerLegend::style | ( | QgsComposerLegendStyle::Style | s | ) | const |
Returns style.
Definition at line 203 of file qgscomposerlegend.cpp.
QFont QgsComposerLegend::styleFont | ( | QgsComposerLegendStyle::Style | s | ) | const |
Definition at line 206 of file qgscomposerlegend.cpp.
double QgsComposerLegend::symbolHeight | ( | ) | const |
Definition at line 224 of file qgscomposerlegend.cpp.
double QgsComposerLegend::symbolWidth | ( | ) | const |
Definition at line 221 of file qgscomposerlegend.cpp.
|
slot |
Data changed.
Definition at line 254 of file qgscomposerlegend.cpp.
QString QgsComposerLegend::title | ( | ) | const |
Definition at line 197 of file qgscomposerlegend.cpp.
Qt::AlignmentFlag QgsComposerLegend::titleAlignment | ( | ) | const |
Returns the alignment of the legend title.
Definition at line 199 of file qgscomposerlegend.cpp.
|
inlineoverridevirtual |
Return correct graphics item type.
Reimplemented from QgsComposerItem.
Definition at line 65 of file qgscomposerlegend.h.
void QgsComposerLegend::updateLegend | ( | ) |
Updates the model and all legend entries.
Definition at line 261 of file qgscomposerlegend.cpp.
double QgsComposerLegend::wmsLegendHeight | ( | ) | const |
Definition at line 230 of file qgscomposerlegend.cpp.
double QgsComposerLegend::wmsLegendWidth | ( | ) | const |
Definition at line 227 of file qgscomposerlegend.cpp.
QString QgsComposerLegend::wrapChar | ( | ) | const |
Definition at line 234 of file qgscomposerlegend.cpp.
|
overridevirtual |
Stores state in Dom node.
elem | is Dom element corresponding to 'Composer' tag |
doc | Dom document |
Reimplemented from QgsComposerObject.
Definition at line 269 of file qgscomposerlegend.cpp.