QGIS API Documentation  2.99.0-Master (e077efd)
Public Slots | Public Member Functions | List of all members
QgsComposerLegend Class Reference

A legend that can be placed onto a map composition. More...

#include <qgscomposerlegend.h>

Inheritance diagram for QgsComposerLegend:
Inheritance graph
[legend]

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=nullptr) 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...
 
- Public Slots inherited from QgsComposerObject
virtual void refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties, const QgsExpressionContext *context=nullptr)
 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 QgsComposerMapcomposerMap () 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...
 
bool legendFilterOutAtlas () const
 Whether to filter out legend elements outside of the current atlas feature. More...
 
QgsLegendModelV2model ()
 Returns the legend model. More...
 
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. If painter is 0, only size is calculated. 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...
 
bool resizeToContents () const
 Returns whether the legend should automatically resize to fit its contents. More...
 
QgsComposerLegendStylerstyle (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 setLegendFilterOutAtlas (bool doFilter)
 When set to true, during an atlas rendering, it will filter out legend elements where features are outside the current atlas feature. 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 setResizeToContents (bool enabled)
 Sets whether the legend should automatically resize to fit its contents. 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...
 
virtual void updateItem () override
 Update() overloading. 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. Usually called from readXml methods of subclasses. More...
 
bool _writeXml (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. Usually called from writeXml methods of subclasses. 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 item's current state. 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...
 
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...
 
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 ()
 
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...
 
int transparency () const
 Returns the item's transparency. 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 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 QgsCompositioncomposition () const
 Returns the composition the item is attached to. More...
 
QgsCompositioncomposition ()
 
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...
 
QgsDataDefineddataDefinedProperty (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 QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()
 

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, ComposerPolygon, ComposerPolyline,
  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...
 
- Protected Member Functions inherited from QgsComposerItem
void deleteAlignItems ()
 
void deleteHAlignSnapItem ()
 
void deleteVAlignSnapItem ()
 
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=nullptr)
 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. Creates a new graphics line if 0. More...
 
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view. 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...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
QGraphicsLineItem * vAlignSnapItem ()
 Return vertical align snap item. Creates a new graphics line if 0. 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 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
 
QgsComposerEffectmEffect
 
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
QgsCompositionmComposition
 
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...
 

Detailed Description

A legend that can be placed onto a map composition.

Definition at line 55 of file qgscomposerlegend.h.

Constructor & Destructor Documentation

§ QgsComposerLegend()

QgsComposerLegend::QgsComposerLegend ( QgsComposition composition)

Definition at line 38 of file qgscomposerlegend.cpp.

§ ~QgsComposerLegend()

QgsComposerLegend::~QgsComposerLegend ( )

Definition at line 78 of file qgscomposerlegend.cpp.

Member Function Documentation

§ adjustBoxSize()

void QgsComposerLegend::adjustBoxSize ( )

Sets item box to the whole content.

Definition at line 193 of file qgscomposerlegend.cpp.

§ autoUpdateModel()

bool QgsComposerLegend::autoUpdateModel ( ) const
Note
added in 2.6

Definition at line 257 of file qgscomposerlegend.cpp.

§ boxSpace()

double QgsComposerLegend::boxSpace ( ) const

Definition at line 293 of file qgscomposerlegend.cpp.

§ columnCount()

int QgsComposerLegend::columnCount ( ) const

Definition at line 317 of file qgscomposerlegend.cpp.

§ columnSpace()

double QgsComposerLegend::columnSpace ( ) const

Definition at line 296 of file qgscomposerlegend.cpp.

§ composerMap()

const QgsComposerMap* QgsComposerLegend::composerMap ( ) const
inline

Definition at line 242 of file qgscomposerlegend.h.

§ displayName()

QString QgsComposerLegend::displayName ( ) const
overridevirtual

Get item display name.

This is the item's id if set, and if not, a user-friendly string identifying item type.

Returns
display name for item
See also
id
setId
Note
added in version 2.5

Reimplemented from QgsComposerItem.

Definition at line 591 of file qgscomposerlegend.cpp.

§ drawRasterBorder()

bool QgsComposerLegend::drawRasterBorder ( ) const

Returns whether a border will be drawn around raster symbol items.

See also
setDrawRasterBorder()
rasterBorderColor()
rasterBorderWidth()
Note
added in QGIS 2.12

Definition at line 326 of file qgscomposerlegend.cpp.

§ equalColumnWidth()

bool QgsComposerLegend::equalColumnWidth ( ) const

Definition at line 323 of file qgscomposerlegend.cpp.

§ fontColor()

QColor QgsComposerLegend::fontColor ( ) const

Definition at line 299 of file qgscomposerlegend.cpp.

§ invalidateCurrentMap

void QgsComposerLegend::invalidateCurrentMap ( )
slot

Sets mCompositionMap to 0 if the map is deleted.

Definition at line 637 of file qgscomposerlegend.cpp.

§ legendFilterByMapEnabled()

bool QgsComposerLegend::legendFilterByMapEnabled ( ) const
inline

Find out whether legend items are filtered to show just the ones visible in the associated map.

Note
added in 2.6

Definition at line 105 of file qgscomposerlegend.h.

§ legendFilterOutAtlas()

bool QgsComposerLegend::legendFilterOutAtlas ( ) const

Whether to filter out legend elements outside of the current atlas feature.

See also
setLegendFilterOutAtlas()
Note
added in 2.14

Definition at line 719 of file qgscomposerlegend.cpp.

§ model()

QgsLegendModelV2* QgsComposerLegend::model ( )
inline

Returns the legend model.

Definition at line 93 of file qgscomposerlegend.h.

§ paint()

void QgsComposerLegend::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)
override

Reimplementation of QCanvasItem::paint.

Definition at line 84 of file qgscomposerlegend.cpp.

§ paintAndDetermineSize()

QSizeF QgsComposerLegend::paintAndDetermineSize ( QPainter *  painter)

Paints the legend and calculates its size. If painter is 0, only size is calculated.

Definition at line 177 of file qgscomposerlegend.cpp.

§ rasterBorderColor()

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.

See also
setRasterBorderColor()
drawRasterBorder()
rasterBorderWidth()
Note
added in QGIS 2.12

Definition at line 329 of file qgscomposerlegend.cpp.

§ rasterBorderWidth()

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.

See also
setRasterBorderWidth()
drawRasterBorder()
rasterBorderColor()
Note
added in QGIS 2.12

Definition at line 332 of file qgscomposerlegend.cpp.

§ readXml()

bool QgsComposerLegend::readXml ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
overridevirtual

Sets state from Dom document.

Parameters
itemElemis Dom node corresponding to item tag
docis Dom document

Reimplemented from QgsComposerObject.

Definition at line 455 of file qgscomposerlegend.cpp.

§ resizeToContents()

bool QgsComposerLegend::resizeToContents ( ) const

Returns whether the legend should automatically resize to fit its contents.

See also
setResizeToContents()
Note
added in QGIS 3.0

Definition at line 223 of file qgscomposerlegend.cpp.

§ rstyle()

QgsComposerLegendStyle & QgsComposerLegend::rstyle ( QgsComposerLegendStyle::Style  s)

Returns reference to modifiable style.

Definition at line 283 of file qgscomposerlegend.cpp.

§ setAutoUpdateModel()

void QgsComposerLegend::setAutoUpdateModel ( bool  autoUpdate)
Note
added in 2.6

Definition at line 237 of file qgscomposerlegend.cpp.

§ setBoxSpace()

void QgsComposerLegend::setBoxSpace ( double  s)

Definition at line 294 of file qgscomposerlegend.cpp.

§ setColumnCount()

void QgsComposerLegend::setColumnCount ( int  c)

Definition at line 318 of file qgscomposerlegend.cpp.

§ setColumnSpace()

void QgsComposerLegend::setColumnSpace ( double  s)

Definition at line 297 of file qgscomposerlegend.cpp.

§ setComposerMap()

void QgsComposerLegend::setComposerMap ( const QgsComposerMap map)

Definition at line 614 of file qgscomposerlegend.cpp.

§ setDrawRasterBorder()

void QgsComposerLegend::setDrawRasterBorder ( bool  enabled)

Sets whether a border will be drawn around raster symbol items.

Parameters
enabledset to true to draw borders
See also
drawRasterBorder()
setRasterBorderColor()
setRasterBorderWidth()
Note
added in QGIS 2.12

Definition at line 327 of file qgscomposerlegend.cpp.

§ setEqualColumnWidth()

void QgsComposerLegend::setEqualColumnWidth ( bool  s)

Definition at line 324 of file qgscomposerlegend.cpp.

§ setFontColor()

void QgsComposerLegend::setFontColor ( const QColor &  c)

Definition at line 300 of file qgscomposerlegend.cpp.

§ setLegendFilterByMapEnabled()

void QgsComposerLegend::setLegendFilterByMapEnabled ( bool  enabled)

Set whether legend items should be filtered to show just the ones visible in the associated map.

Note
added in 2.6

Definition at line 262 of file qgscomposerlegend.cpp.

§ setLegendFilterOutAtlas()

void QgsComposerLegend::setLegendFilterOutAtlas ( bool  doFilter)

When set to true, during an atlas rendering, it will filter out legend elements where features are outside the current atlas feature.

Note
added in 2.14

Definition at line 714 of file qgscomposerlegend.cpp.

§ setRasterBorderColor()

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.

Parameters
colorborder color
See also
rasterBorderColor()
setDrawRasterBorder()
setRasterBorderWidth()
Note
added in QGIS 2.12

Definition at line 330 of file qgscomposerlegend.cpp.

§ setRasterBorderWidth()

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.

Parameters
widthborder width in millimeters
See also
rasterBorderWidth()
setDrawRasterBorder()
setRasterBorderColor()
Note
added in QGIS 2.12

Definition at line 333 of file qgscomposerlegend.cpp.

§ setResizeToContents()

void QgsComposerLegend::setResizeToContents ( bool  enabled)

Sets whether the legend should automatically resize to fit its contents.

Parameters
enabledset to false to disable automatic resizing. The legend frame will not be expanded to fit legend items, and items may be cropped from display.
See also
resizeToContents()
Note
added in QGIS 3.0

Definition at line 218 of file qgscomposerlegend.cpp.

§ setSplitLayer()

void QgsComposerLegend::setSplitLayer ( bool  s)

Definition at line 321 of file qgscomposerlegend.cpp.

§ setStyle()

void QgsComposerLegend::setStyle ( QgsComposerLegendStyle::Style  s,
const QgsComposerLegendStyle style 
)

Definition at line 285 of file qgscomposerlegend.cpp.

§ setStyleFont()

void QgsComposerLegend::setStyleFont ( QgsComposerLegendStyle::Style  s,
const QFont &  f 
)

Set style font.

Definition at line 288 of file qgscomposerlegend.cpp.

§ setStyleMargin() [1/2]

void QgsComposerLegend::setStyleMargin ( QgsComposerLegendStyle::Style  s,
double  margin 
)

Set style margin.

Definition at line 290 of file qgscomposerlegend.cpp.

§ setStyleMargin() [2/2]

void QgsComposerLegend::setStyleMargin ( QgsComposerLegendStyle::Style  s,
QgsComposerLegendStyle::Side  side,
double  margin 
)

Definition at line 291 of file qgscomposerlegend.cpp.

§ setSymbolHeight()

void QgsComposerLegend::setSymbolHeight ( double  h)

Definition at line 306 of file qgscomposerlegend.cpp.

§ setSymbolWidth()

void QgsComposerLegend::setSymbolWidth ( double  w)

Definition at line 303 of file qgscomposerlegend.cpp.

§ setTitle()

void QgsComposerLegend::setTitle ( const QString &  t)

Definition at line 268 of file qgscomposerlegend.cpp.

§ setTitleAlignment()

void QgsComposerLegend::setTitleAlignment ( Qt::AlignmentFlag  alignment)

Sets the alignment of the legend title.

Parameters
alignmentText alignment for drawing the legend title
Note
added in 2.3
See also
titleAlignment

Definition at line 281 of file qgscomposerlegend.cpp.

§ setWmsLegendHeight()

void QgsComposerLegend::setWmsLegendHeight ( double  h)

Definition at line 312 of file qgscomposerlegend.cpp.

§ setWmsLegendWidth()

void QgsComposerLegend::setWmsLegendWidth ( double  w)

Definition at line 309 of file qgscomposerlegend.cpp.

§ setWrapChar()

void QgsComposerLegend::setWrapChar ( const QString &  t)

Definition at line 314 of file qgscomposerlegend.cpp.

§ splitLayer()

bool QgsComposerLegend::splitLayer ( ) const

Definition at line 320 of file qgscomposerlegend.cpp.

§ style()

QgsComposerLegendStyle QgsComposerLegend::style ( QgsComposerLegendStyle::Style  s) const

Returns style.

Definition at line 284 of file qgscomposerlegend.cpp.

§ styleFont()

QFont QgsComposerLegend::styleFont ( QgsComposerLegendStyle::Style  s) const

Definition at line 287 of file qgscomposerlegend.cpp.

§ symbolHeight()

double QgsComposerLegend::symbolHeight ( ) const

Definition at line 305 of file qgscomposerlegend.cpp.

§ symbolWidth()

double QgsComposerLegend::symbolWidth ( ) const

Definition at line 302 of file qgscomposerlegend.cpp.

§ synchronizeWithModel

void QgsComposerLegend::synchronizeWithModel ( )
slot

Data changed.

Definition at line 335 of file qgscomposerlegend.cpp.

§ title()

QString QgsComposerLegend::title ( ) const

Definition at line 278 of file qgscomposerlegend.cpp.

§ titleAlignment()

Qt::AlignmentFlag QgsComposerLegend::titleAlignment ( ) const

Returns the alignment of the legend title.

Returns
Qt::AlignmentFlag for the legend title
Note
added in 2.3
See also
setTitleAlignment

Definition at line 280 of file qgscomposerlegend.cpp.

§ type()

virtual int QgsComposerLegend::type ( ) const
inlineoverridevirtual

Return correct graphics item type.

Reimplemented from QgsComposerItem.

Definition at line 64 of file qgscomposerlegend.h.

§ updateItem()

void QgsComposerLegend::updateItem ( )
overridevirtual

Update() overloading.

Use it rather than update()

Note
added in 2.12

Reimplemented from QgsComposerItem.

Definition at line 347 of file qgscomposerlegend.cpp.

§ updateLegend()

void QgsComposerLegend::updateLegend ( )

Updates the model and all legend entries.

Definition at line 341 of file qgscomposerlegend.cpp.

§ wmsLegendHeight()

double QgsComposerLegend::wmsLegendHeight ( ) const

Definition at line 311 of file qgscomposerlegend.cpp.

§ wmsLegendWidth()

double QgsComposerLegend::wmsLegendWidth ( ) const

Definition at line 308 of file qgscomposerlegend.cpp.

§ wrapChar()

QString QgsComposerLegend::wrapChar ( ) const

Definition at line 315 of file qgscomposerlegend.cpp.

§ writeXml()

bool QgsComposerLegend::writeXml ( QDomElement &  elem,
QDomDocument &  doc 
) const
overridevirtual

Stores state in Dom node.

Parameters
elemis Dom element corresponding to 'Composer' tag
docDom document

Reimplemented from QgsComposerObject.

Definition at line 353 of file qgscomposerlegend.cpp.


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