QGIS API Documentation  3.9.0-Master (8986ea2301)
Public Slots | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
QgsLayoutItemLegend Class Reference

A layout item subclass for map legends. More...

#include <qgslayoutitemlegend.h>

Inheritance diagram for QgsLayoutItemLegend:
Inheritance graph
[legend]

Public Slots

void refresh () override
 
void refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::AllProperties) override
 
- Public Slots inherited from QgsLayoutItem
virtual void invalidateCache ()
 Forces a deferred update of any cached image the item uses. More...
 
virtual void redraw ()
 Triggers a redraw (update) of the item. More...
 
void refresh () override
 Refreshes the item, causing a recalculation of any property overrides and recalculation of its position and size. More...
 
virtual void refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::AllProperties)
 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 rotateItem (double angle, QPointF transformOrigin)
 Rotates the item by a specified angle in degrees clockwise around a specified reference point. More...
 
virtual void setItemRotation (double rotation, bool adjustPosition=true)
 Sets the layout item's rotation, in degrees clockwise. More...
 
- Public Slots inherited from QgsLayoutObject
virtual void refresh ()
 Refreshes the object, causing a recalculation of any property overrides. More...
 

Public Member Functions

 QgsLayoutItemLegend (QgsLayout *layout)
 Constructor for QgsLayoutItemLegend, with the specified parent layout. More...
 
void adjustBoxSize ()
 Sets the legend's item bounds to fit the whole legend content. More...
 
bool autoUpdateModel () const
 Returns whether the legend content should auto update to reflect changes in the project's layer tree. More...
 
double boxSpace () const
 Returns the legend box space. More...
 
int columnCount () const
 Returns the legend column count. More...
 
double columnSpace () const
 Returns the legend column spacing. More...
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
QString displayName () const override
 Gets item display name. More...
 
bool drawRasterStroke () const
 Returns whether a stroke will be drawn around raster symbol items. More...
 
bool equalColumnWidth () const
 Returns whether column widths should be equalized. More...
 
void finalizeRestoreFromXml () override
 Called after all pending items have been restored from XML. More...
 
QColor fontColor () const
 Returns the legend font color. More...
 
QIcon icon () const override
 Returns the item's icon. More...
 
QgsLayoutItem::Flags itemFlags () const override
 Returns the item's flags, which indicate how the item behaves. More...
 
bool legendFilterByMapEnabled () const
 Find out whether legend items are filtered to show just the ones visible in the associated map. More...
 
bool legendFilterOutAtlas () const
 Returns whether to filter out legend elements outside of the current atlas feature. More...
 
const QgsLegendSettingslegendSettings () const
 Returns the legend's renderer settings object. More...
 
double lineSpacing () const
 Returns the spacing in-between lines in layout units. More...
 
QgsLayoutItemMaplinkedMap () const
 Returns the associated map. More...
 
QgsLegendModelmodel ()
 Returns the legend model. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override
 
QColor rasterStrokeColor () const
 Returns the stroke color for the stroke drawn around raster symbol items. More...
 
double rasterStrokeWidth () const
 Returns the stroke width (in layout units) for the stroke drawn around raster symbol items. More...
 
bool resizeToContents () const
 Returns whether the legend should automatically resize to fit its contents. More...
 
QgsLegendStylerstyle (QgsLegendStyle::Style s)
 Returns reference to modifiable legend style. More...
 
void setAutoUpdateModel (bool autoUpdate)
 Sets whether the legend content should auto update to reflect changes in the project's layer tree. More...
 
void setBoxSpace (double space)
 Sets the legend box space. More...
 
void setColumnCount (int count)
 Sets the legend column count. More...
 
void setColumnSpace (double spacing)
 Sets the legend column spacing. More...
 
void setDrawRasterStroke (bool enabled)
 Sets whether a stroke will be drawn around raster symbol items. More...
 
void setEqualColumnWidth (bool equalize)
 Sets whether column widths should be equalized. More...
 
void setFontColor (const QColor &color)
 Sets the legend font color. More...
 
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 setLineSpacing (double spacing)
 Sets the spacing in-between multiple lines. More...
 
void setLinkedMap (QgsLayoutItemMap *map)
 Sets the map to associate with the legend. More...
 
void setRasterStrokeColor (const QColor &color)
 Sets the stroke color for the stroke drawn around raster symbol items. More...
 
void setRasterStrokeWidth (double width)
 Sets the stroke width for the stroke 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 enabled)
 Sets whether the legend items from a single layer can be split over multiple columns. More...
 
void setStyle (QgsLegendStyle::Style component, const QgsLegendStyle &style)
 Sets the style of component to style for the legend. More...
 
void setStyleFont (QgsLegendStyle::Style component, const QFont &font)
 Sets the style font for a legend component. More...
 
void setStyleMargin (QgsLegendStyle::Style component, double margin)
 Set the margin for a legend component. More...
 
void setStyleMargin (QgsLegendStyle::Style component, QgsLegendStyle::Side side, double margin)
 Set the margin for a particular side of a legend component. More...
 
void setSymbolAlignment (Qt::AlignmentFlag alignment)
 Sets the alignment for placement of legend symbols. More...
 
void setSymbolHeight (double height)
 Sets the legend symbol height. More...
 
void setSymbolWidth (double width)
 Sets the legend symbol width. More...
 
void setTitle (const QString &title)
 Sets the legend title. More...
 
void setTitleAlignment (Qt::AlignmentFlag alignment)
 Sets the alignment of the legend title. More...
 
void setWmsLegendHeight (double height)
 Sets the WMS legend height. More...
 
void setWmsLegendWidth (double width)
 Sets the WMS legend width. More...
 
void setWrapString (const QString &string)
 Sets the legend text wrapping string. More...
 
bool splitLayer () const
 Returns whether the legend items from a single layer can be split over multiple columns. More...
 
QgsLegendStyle style (QgsLegendStyle::Style s) const
 Returns legend style. More...
 
QFont styleFont (QgsLegendStyle::Style component) const
 Returns the font settings for a legend component. More...
 
Qt::AlignmentFlag symbolAlignment () const
 Returns the alignment for placement of legend symbols. More...
 
double symbolHeight () const
 Returns the legend symbol height. More...
 
double symbolWidth () const
 Returns the legend symbol width. More...
 
QString title () const
 Returns the legend title. More...
 
Qt::AlignmentFlag titleAlignment () const
 Returns the alignment of the legend title. More...
 
int type () const override
 
void updateFilterByMap (bool redraw=true)
 Updates the legend content when filtered by map. More...
 
void updateLegend ()
 Updates the model and all legend entries. More...
 
double wmsLegendHeight () const
 Returns the WMS legend height. More...
 
double wmsLegendWidth () const
 Returns the WMS legend width. More...
 
QString wrapString () const
 Returns the legend text wrapping string. More...
 
- Public Member Functions inherited from QgsLayoutItem
 QgsLayoutItem (QgsLayout *layout, bool manageZValue=true)
 Constructor for QgsLayoutItem, with the specified parent layout. More...
 
 ~QgsLayoutItem () override
 
virtual bool accept (QgsStyleEntityVisitorInterface *visitor) const
 Accepts the specified style entity visitor, causing it to visit all style entities associated with the layout item. More...
 
virtual void attemptMove (const QgsLayoutPoint &point, bool useReferencePoint=true, bool includesFrame=false, int page=-1)
 Attempts to move the item to a specified point. More...
 
void attemptMoveBy (double deltaX, double deltaY)
 Attempts to shift the item's position by a specified deltaX and deltaY, in layout units. More...
 
virtual void attemptResize (const QgsLayoutSize &size, bool includesFrame=false)
 Attempts to resize the item to a specified target size. More...
 
void attemptSetSceneRect (const QRectF &rect, bool includesFrame=false)
 Attempts to update the item's position and size to match the passed rect in layout coordinates. More...
 
QColor backgroundColor () const
 Returns the background color for this item. More...
 
void beginCommand (const QString &commandText, UndoCommand command=UndoNone)
 Starts new undo command for this item. More...
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void cancelCommand ()
 Cancels the current item command and discards it. More...
 
virtual void cleanup ()
 Called just before a batch of items are deleted, allowing them to run cleanup tasks. More...
 
virtual bool containsAdvancedEffects () const
 Returns true if the item contains contents with blend modes or transparency effects which can only be reproduced by rastering the item. More...
 
QgsAbstractLayoutUndoCommandcreateCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override
 Creates a new layout undo command with the specified text and parent. More...
 
void endCommand ()
 Completes the current item command and push it onto the layout's undo stack. More...
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
bool excludeFromExports () const
 Returns whether the item should be excluded from layout exports and prints. More...
 
virtual QgsLayoutSize fixedSize () const
 Returns the fixed size of the item, if applicable, or an empty size if item can be freely resized. More...
 
bool frameEnabled () const
 Returns true if the item includes a frame. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
QColor frameStrokeColor () const
 Returns the frame's stroke color. More...
 
QgsLayoutMeasurement frameStrokeWidth () const
 Returns the frame's stroke width. More...
 
bool hasBackground () const
 Returns true if the item has a background. More...
 
QString id () const
 Returns the item's ID name. More...
 
bool isGroupMember () const
 Returns true if the item is part of a QgsLayoutItemGroup group. More...
 
bool isLocked () const
 Returns true if the item is locked, and cannot be interacted with using the mouse. More...
 
double itemOpacity () const
 Returns the item's opacity. More...
 
double itemRotation () const
 Returns the current rotation for the item, in degrees clockwise. More...
 
virtual QgsLayoutSize minimumSize () const
 Returns the minimum allowed size of the item, if applicable, or an empty size if item can be freely resized. More...
 
virtual void moveContent (double dx, double dy)
 Moves the content of the item, by a specified dx and dy in layout units. More...
 
virtual int numberExportLayers () const
 Returns the number of layers that this item requires for exporting during layered exports (e.g. More...
 
int page () const
 Returns the page the item is currently on, with the first page returning 0. More...
 
QPointF pagePos () const
 Returns the item's position (in layout units) relative to the top left corner of its current page. More...
 
QgsLayoutPoint pagePositionWithUnits () const
 Returns the item's position (in item units) relative to the top left corner of its current page. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override
 Handles preparing a paint surface for the layout item and painting the item's content. More...
 
QgsLayoutItemGroupparentGroup () const
 Returns the item's parent group, if the item is part of a QgsLayoutItemGroup group. More...
 
QgsLayoutPoint positionWithUnits () const
 Returns the item's current position, including units. More...
 
bool readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets the item state from a DOM element. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
ReferencePoint referencePoint () const
 Returns the reference point for positioning of the layout item. More...
 
virtual bool requiresRasterization () const
 Returns true if the item is drawn in such a way that forces the whole layout to be rasterized when exporting to vector formats. More...
 
void setBackgroundColor (const QColor &color)
 Sets the background color for this item. More...
 
void setBackgroundEnabled (bool drawBackground)
 Sets whether this item has a background drawn under it or not. More...
 
void setBlendMode (QPainter::CompositionMode mode)
 Sets the item's composition blending mode. More...
 
void setExcludeFromExports (bool exclude)
 Sets whether the item should be excluded from layout exports and prints. More...
 
virtual void setFrameEnabled (bool drawFrame)
 Sets whether this item has a frame drawn around it or not. More...
 
void setFrameJoinStyle (Qt::PenJoinStyle style)
 Sets the join style used when drawing the item's frame. More...
 
void setFrameStrokeColor (const QColor &color)
 Sets the frame stroke color. More...
 
virtual void setFrameStrokeWidth (QgsLayoutMeasurement width)
 Sets the frame stroke width. More...
 
virtual void setId (const QString &id)
 Set the item's id name. More...
 
void setItemOpacity (double opacity)
 Sets the item's opacity. More...
 
void setLocked (bool locked)
 Sets whether the item is locked, preventing mouse interactions with the item. More...
 
virtual void setMoveContentPreviewOffset (double dx, double dy)
 Sets temporary offset for the item, by a specified dx and dy in layout units. More...
 
void setParentGroup (QgsLayoutItemGroup *group)
 Sets the item's parent group. More...
 
void setReferencePoint (ReferencePoint point)
 Sets the reference point for positioning of the layout item. More...
 
virtual void setSelected (bool selected)
 Sets whether the item should be selected. More...
 
virtual void setVisibility (bool visible)
 Sets whether the item is visible. More...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
QgsLayoutSize sizeWithUnits () const
 Returns the item's current size, including units. More...
 
int type () const override
 Returns a unique graphics item type identifier. More...
 
virtual QString uuid () const
 Returns the item identification string. More...
 
bool writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores the item state in a DOM element. More...
 
virtual void zoomContent (double factor, QPointF point)
 Zooms content of item. More...
 
- Public Member Functions inherited from QgsLayoutObject
 QgsLayoutObject (QgsLayout *layout)
 Constructor for QgsLayoutObject, with the specified parent layout. More...
 
QgsExpressionContext createExpressionContext () const override
 Creates an expression context relating to the objects' current state. More...
 
QStringList customProperties () const
 Returns 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...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsLayoutlayout () const
 Returns the layout the object is attached to. More...
 
QgsLayoutlayout ()
 Returns the layout the object is attached to. 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 setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the objects's property collection, used for data defined overrides. More...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 
- Public Member Functions inherited from QgsLayoutUndoObjectInterface
virtual ~QgsLayoutUndoObjectInterface ()=default
 Destructor for QgsLayoutUndoObjectInterface. More...
 

Static Public Member Functions

static QgsLayoutItemLegendcreate (QgsLayout *layout)
 Returns a new legend item for the specified layout. More...
 
- Static Public Member Functions inherited from QgsLayoutObject
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the layout object property definitions. More...
 

Protected Member Functions

void draw (QgsLayoutItemRenderContext &context) override
 Draws the item's contents using the specified item render context. More...
 
bool readPropertiesFromElement (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
 Sets item state from a DOM element. More...
 
bool writePropertiesToElement (QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
 Stores item state within an XML DOM element. More...
 
- Protected Member Functions inherited from QgsLayoutItem
QPointF adjustPointForReferencePosition (QPointF point, QSizeF size, ReferencePoint reference) const
 Adjusts the specified point at which a reference position of the item sits and returns the top left corner of the item, if reference point were placed at the specified position. More...
 
QgsLayoutSize applyDataDefinedSize (const QgsLayoutSize &size)
 Applies any present data defined size overrides to the specified layout size. More...
 
virtual QSizeF applyItemSizeConstraint (QSizeF targetSize)
 Applies any item-specific size constraint handling to a given targetSize in layout units. More...
 
virtual void drawBackground (QgsRenderContext &context)
 Draws the background for the item. More...
 
virtual void drawDebugRect (QPainter *painter)
 Draws a debugging rectangle of the item's current bounds within the specified painter. More...
 
virtual void drawFrame (QgsRenderContext &context)
 Draws the frame around the item. More...
 
QPointF positionAtReferencePoint (ReferencePoint reference) const
 Returns the current position (in layout units) of a reference point for the item. More...
 
void refreshBackgroundColor (bool updateItem=true)
 Refresh item's background color, considering data defined colors. More...
 
void refreshBlendMode ()
 Refresh item's blend mode, considering data defined blend mode. More...
 
void refreshFrame (bool updateItem=true)
 Refresh item's frame, considering data defined colors and frame size. More...
 
void refreshItemPosition ()
 Refreshes an item's position by rechecking it against any possible overrides such as data defined positioning. More...
 
void refreshItemRotation (QPointF *origin=nullptr)
 Refreshes an item's rotation by rechecking it against any possible overrides such as data defined rotation. More...
 
void refreshItemSize ()
 Refreshes an item's size by rechecking it against any possible item fixed or minimum sizes. More...
 
void refreshOpacity (bool updateItem=true)
 Refresh item's opacity, considering data defined opacity. More...
 
virtual void setFixedSize (const QgsLayoutSize &size)
 Sets a fixed size for the layout item, which prevents it from being freely resized. More...
 
virtual void setMinimumSize (const QgsLayoutSize &size)
 Sets the minimum allowed size for the layout item. More...
 
QgsLayoutPoint topLeftToReferencePoint (const QgsLayoutPoint &point) const
 Returns the position for the reference point of the item, if the top-left of the item was placed at the specified point. More...
 
- Protected Member Functions inherited from QgsLayoutObject
bool readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets object properties from a DOM element. More...
 
bool writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores object properties within an XML DOM element. More...
 

Friends

class QgsCompositionConverter
 

Additional Inherited Members

- Public Types inherited from QgsLayoutItem
enum  Flag { FlagOverridesPaint = 1 << 1 }
 Flags for controlling how an item behaves. More...
 
enum  ReferencePoint {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
 Fixed position reference point. More...
 
enum  UndoCommand {
  UndoNone = -1, UndoIncrementalMove = 1, UndoIncrementalResize, UndoStrokeColor,
  UndoStrokeWidth, UndoBackgroundColor, UndoOpacity, UndoSetId,
  UndoRotation, UndoShapeStyle, UndoShapeCornerRadius, UndoNodeMove,
  UndoAtlasMargin, UndoMapRotation, UndoZoomContent, UndoOverviewStyle,
  UndoGridFramePenColor, UndoMapGridFrameFill1Color, UndoMapGridFrameFill2Color, UndoMapAnnotationDistance,
  UndoMapGridAnnotationFontColor, UndoMapGridLineSymbol, UndoMapGridMarkerSymbol, UndoMapLabelMargin,
  UndoPictureRotation, UndoPictureFillColor, UndoPictureStrokeColor, UndoPictureStrokeWidth,
  UndoPictureNorthOffset, UndoLabelText, UndoLabelFont, UndoLabelMargin,
  UndoLabelFontColor, UndoLegendText, UndoLegendColumnCount, UndoLegendSymbolWidth,
  UndoLegendSymbolHeight, UndoLegendWmsLegendWidth, UndoLegendWmsLegendHeight, UndoLegendTitleSpaceBottom,
  UndoLegendGroupSpace, UndoLegendLayerSpace, UndoLegendSymbolSpace, UndoLegendIconSymbolSpace,
  UndoLegendFontColor, UndoLegendBoxSpace, UndoLegendColumnSpace, UndoLegendLineSpacing,
  UndoLegendRasterStrokeWidth, UndoLegendRasterStrokeColor, UndoLegendTitleFont, UndoLegendGroupFont,
  UndoLegendLayerFont, UndoLegendItemFont, UndoScaleBarLineWidth, UndoScaleBarSegmentSize,
  UndoScaleBarSegmentsLeft, UndoScaleBarSegments, UndoScaleBarHeight, UndoScaleBarFontColor,
  UndoScaleBarFillColor, UndoScaleBarFillColor2, UndoScaleBarStrokeColor, UndoScaleBarUnitText,
  UndoScaleBarMapUnitsSegment, UndoScaleBarLabelBarSize, UndoScaleBarBoxContentSpace, UndoArrowStrokeWidth,
  UndoArrowHeadWidth, UndoArrowHeadFillColor, UndoArrowHeadStrokeColor, UndoCustomCommand
}
 Layout item undo commands, used for collapsing undo commands. More...
 
- Public Types inherited from QgsLayoutObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, Opacity,
  BlendMode, ExcludeFromExports, FrameColor, BackgroundColor,
  MapRotation, MapScale, MapXMin, MapYMin,
  MapXMax, MapYMax, MapAtlasMargin, MapLayers,
  MapStylePreset, MapLabelMargin, PictureSource, PictureSvgBackgroundColor,
  PictureSvgStrokeColor, PictureSvgStrokeWidth, SourceUrl, LegendTitle,
  LegendColumnCount, ScalebarFillColor, ScalebarFillColor2, ScalebarLineColor,
  ScalebarLineWidth, AttributeTableSourceLayer
}
 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 QgsLayoutItem
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
void rotationChanged (double newRotation)
 Emitted on item rotation change. More...
 
void sizePositionChanged ()
 Emitted when the item's size or position changes. More...
 
- Signals inherited from QgsLayoutObject
void changed ()
 Emitted when the object's properties change. More...
 
- Protected Attributes inherited from QgsLayoutObject
QgsObjectCustomProperties mCustomProperties
 Custom properties for object. More...
 
QgsPropertyCollection mDataDefinedProperties
 
QPointer< QgsLayoutmLayout
 
- Properties inherited from QgsLayoutItem
bool locked
 

Detailed Description

A layout item subclass for map legends.

Since
QGIS 3.0

Definition at line 100 of file qgslayoutitemlegend.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemLegend()

QgsLayoutItemLegend::QgsLayoutItemLegend ( QgsLayout layout)

Constructor for QgsLayoutItemLegend, with the specified parent layout.

Definition at line 39 of file qgslayoutitemlegend.cpp.

Member Function Documentation

◆ adjustBoxSize()

void QgsLayoutItemLegend::adjustBoxSize ( )

Sets the legend's item bounds to fit the whole legend content.

Definition at line 187 of file qgslayoutitemlegend.cpp.

◆ autoUpdateModel()

bool QgsLayoutItemLegend::autoUpdateModel ( ) const

Returns whether the legend content should auto update to reflect changes in the project's layer tree.

See also
setAutoUpdateModel()

Definition at line 251 of file qgslayoutitemlegend.cpp.

◆ boxSpace()

double QgsLayoutItemLegend::boxSpace ( ) const

Returns the legend box space.

See also
setBoxSpace()

Definition at line 333 of file qgslayoutitemlegend.cpp.

◆ columnCount()

int QgsLayoutItemLegend::columnCount ( ) const

Returns the legend column count.

See also
setColumnCount()

Definition at line 422 of file qgslayoutitemlegend.cpp.

◆ columnSpace()

double QgsLayoutItemLegend::columnSpace ( ) const

Returns the legend column spacing.

See also
setColumnSpace()

Definition at line 343 of file qgslayoutitemlegend.cpp.

◆ create()

QgsLayoutItemLegend * QgsLayoutItemLegend::create ( QgsLayout layout)
static

Returns a new legend item for the specified layout.

The caller takes responsibility for deleting the returned object.

Definition at line 62 of file qgslayoutitemlegend.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsLayoutItemLegend::createExpressionContext ( ) const
overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Since
QGIS 3.0

Reimplemented from QgsLayoutItem.

Definition at line 845 of file qgslayoutitemlegend.cpp.

◆ displayName()

QString QgsLayoutItemLegend::displayName ( ) const
overridevirtual

Gets item display name.

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

See also
id()
setId()

Reimplemented from QgsLayoutItem.

Definition at line 643 of file qgslayoutitemlegend.cpp.

◆ draw()

void QgsLayoutItemLegend::draw ( QgsLayoutItemRenderContext context)
overrideprotectedvirtual

Draws the item's contents using the specified item render context.

Note that the context's painter has been scaled so that painter units are pixels. Use the QgsRenderContext methods to convert from millimeters or other units to the painter's units.

Implements QgsLayoutItem.

Definition at line 162 of file qgslayoutitemlegend.cpp.

◆ drawRasterStroke()

bool QgsLayoutItemLegend::drawRasterStroke ( ) const

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

See also
setDrawRasterStroke()
rasterStrokeColor()
rasterStrokeWidth()

Definition at line 453 of file qgslayoutitemlegend.cpp.

◆ equalColumnWidth()

bool QgsLayoutItemLegend::equalColumnWidth ( ) const

Returns whether column widths should be equalized.

See also
setEqualColumnWidth()

Definition at line 443 of file qgslayoutitemlegend.cpp.

◆ finalizeRestoreFromXml()

void QgsLayoutItemLegend::finalizeRestoreFromXml ( )
overridevirtual

Called after all pending items have been restored from XML.

Items can use this method to run steps which must take place after all items have been restored to the layout, such as connecting to signals emitted by other items, which may not have existed in the layout at the time readXml() was called. E.g. a scalebar can use this to connect to its linked map item after restoration from XML.

See also
readXml()

Reimplemented from QgsLayoutItem.

Definition at line 148 of file qgslayoutitemlegend.cpp.

◆ fontColor()

QColor QgsLayoutItemLegend::fontColor ( ) const

Returns the legend font color.

See also
setFontColor()

Definition at line 353 of file qgslayoutitemlegend.cpp.

◆ icon()

QIcon QgsLayoutItemLegend::icon ( ) const
overridevirtual

Returns the item's icon.

Reimplemented from QgsLayoutItem.

Definition at line 72 of file qgslayoutitemlegend.cpp.

◆ itemFlags()

QgsLayoutItem::Flags QgsLayoutItemLegend::itemFlags ( ) const
overridevirtual

Returns the item's flags, which indicate how the item behaves.

Since
QGIS 3.4.3

Reimplemented from QgsLayoutItem.

Definition at line 77 of file qgslayoutitemlegend.cpp.

◆ legendFilterByMapEnabled()

bool QgsLayoutItemLegend::legendFilterByMapEnabled ( ) const
inline

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

See also
setLegendFilterByMapEnabled()

Definition at line 172 of file qgslayoutitemlegend.h.

◆ legendFilterOutAtlas()

bool QgsLayoutItemLegend::legendFilterOutAtlas ( ) const

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

See also
setLegendFilterOutAtlas()

Definition at line 826 of file qgslayoutitemlegend.cpp.

◆ legendSettings()

const QgsLegendSettings& QgsLayoutItemLegend::legendSettings ( ) const
inline

Returns the legend's renderer settings object.

Definition at line 492 of file qgslayoutitemlegend.h.

◆ lineSpacing()

double QgsLayoutItemLegend::lineSpacing ( ) const

Returns the spacing in-between lines in layout units.

See also
setLineSpacing()

Definition at line 323 of file qgslayoutitemlegend.cpp.

◆ linkedMap()

QgsLayoutItemMap* QgsLayoutItemLegend::linkedMap ( ) const
inline

Returns the associated map.

See also
setLinkedMap()

Definition at line 477 of file qgslayoutitemlegend.h.

◆ model()

QgsLegendModel* QgsLayoutItemLegend::model ( )
inline

Returns the legend model.

Definition at line 146 of file qgslayoutitemlegend.h.

◆ paint()

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

Definition at line 82 of file qgslayoutitemlegend.cpp.

◆ rasterStrokeColor()

QColor QgsLayoutItemLegend::rasterStrokeColor ( ) const

Returns the stroke color for the stroke drawn around raster symbol items.

The stroke is only drawn if drawRasterStroke() is true.

See also
setRasterStrokeColor()
drawRasterStroke()
rasterStrokeWidth()

Definition at line 463 of file qgslayoutitemlegend.cpp.

◆ rasterStrokeWidth()

double QgsLayoutItemLegend::rasterStrokeWidth ( ) const

Returns the stroke width (in layout units) for the stroke drawn around raster symbol items.

The stroke is only drawn if drawRasterStroke() is true.

See also
setRasterStrokeWidth()
drawRasterStroke()
rasterStrokeColor()

Definition at line 473 of file qgslayoutitemlegend.cpp.

◆ readPropertiesFromElement()

bool QgsLayoutItemLegend::readPropertiesFromElement ( const QDomElement &  element,
const QDomDocument &  document,
const QgsReadWriteContext context 
)
overrideprotectedvirtual

Sets item state from a DOM element.

Parameters
elementis the DOM element for the item
documentDOM document
contextread write context

Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring a scalebar, the connection to the linked map's signals should be implemented in finalizeRestoreFromXml(), not readPropertiesFromElement().

See also
writePropertiesToElement()
readXml()

Reimplemented from QgsLayoutItem.

Definition at line 551 of file qgslayoutitemlegend.cpp.

◆ refresh

void QgsLayoutItemLegend::refresh ( )
overrideslot

Definition at line 156 of file qgslayoutitemlegend.cpp.

◆ refreshDataDefinedProperty

void QgsLayoutItemLegend::refreshDataDefinedProperty ( QgsLayoutObject::DataDefinedProperty  property = QgsLayoutObject::AllProperties)
overrideslot

Definition at line 711 of file qgslayoutitemlegend.cpp.

◆ resizeToContents()

bool QgsLayoutItemLegend::resizeToContents ( ) const

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

See also
setResizeToContents()

Definition at line 218 of file qgslayoutitemlegend.cpp.

◆ rstyle()

QgsLegendStyle & QgsLayoutItemLegend::rstyle ( QgsLegendStyle::Style  s)

Returns reference to modifiable legend style.

Definition at line 288 of file qgslayoutitemlegend.cpp.

◆ setAutoUpdateModel()

void QgsLayoutItemLegend::setAutoUpdateModel ( bool  autoUpdate)

Sets whether the legend content should auto update to reflect changes in the project's layer tree.

See also
autoUpdateModel()

Definition at line 231 of file qgslayoutitemlegend.cpp.

◆ setBoxSpace()

void QgsLayoutItemLegend::setBoxSpace ( double  space)

Sets the legend box space.

See also
boxSpace()

Definition at line 338 of file qgslayoutitemlegend.cpp.

◆ setColumnCount()

void QgsLayoutItemLegend::setColumnCount ( int  count)

Sets the legend column count.

See also
columnCount()

Definition at line 427 of file qgslayoutitemlegend.cpp.

◆ setColumnSpace()

void QgsLayoutItemLegend::setColumnSpace ( double  spacing)

Sets the legend column spacing.

See also
columnSpace()

Definition at line 348 of file qgslayoutitemlegend.cpp.

◆ setDrawRasterStroke()

void QgsLayoutItemLegend::setDrawRasterStroke ( bool  enabled)

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

Parameters
enabledset to true to draw borders
See also
drawRasterStroke()
setRasterStrokeColor()
setRasterStrokeWidth()

Definition at line 458 of file qgslayoutitemlegend.cpp.

◆ setEqualColumnWidth()

void QgsLayoutItemLegend::setEqualColumnWidth ( bool  equalize)

Sets whether column widths should be equalized.

See also
equalColumnWidth()

Definition at line 448 of file qgslayoutitemlegend.cpp.

◆ setFontColor()

void QgsLayoutItemLegend::setFontColor ( const QColor &  color)

Sets the legend font color.

See also
fontColor()

Definition at line 358 of file qgslayoutitemlegend.cpp.

◆ setLegendFilterByMapEnabled()

void QgsLayoutItemLegend::setLegendFilterByMapEnabled ( bool  enabled)

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

See also
legendFilterByMapEnabled()

Definition at line 256 of file qgslayoutitemlegend.cpp.

◆ setLegendFilterOutAtlas()

void QgsLayoutItemLegend::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.

See also
legendFilterOutAtlas()

Definition at line 821 of file qgslayoutitemlegend.cpp.

◆ setLineSpacing()

void QgsLayoutItemLegend::setLineSpacing ( double  spacing)

Sets the spacing in-between multiple lines.

See also
lineSpacing()

Definition at line 328 of file qgslayoutitemlegend.cpp.

◆ setLinkedMap()

void QgsLayoutItemLegend::setLinkedMap ( QgsLayoutItemMap map)

Sets the map to associate with the legend.

See also
linkedMap()

Definition at line 688 of file qgslayoutitemlegend.cpp.

◆ setRasterStrokeColor()

void QgsLayoutItemLegend::setRasterStrokeColor ( const QColor &  color)

Sets the stroke color for the stroke drawn around raster symbol items.

The stroke is only drawn if drawRasterStroke() is true.

See also
rasterStrokeColor()
setDrawRasterStroke()
setRasterStrokeWidth()

Definition at line 468 of file qgslayoutitemlegend.cpp.

◆ setRasterStrokeWidth()

void QgsLayoutItemLegend::setRasterStrokeWidth ( double  width)

Sets the stroke width for the stroke drawn around raster symbol items.

The stroke is only drawn if drawRasterStroke() is true.

See also
rasterStrokeWidth()
setDrawRasterStroke()
setRasterStrokeColor()

Definition at line 478 of file qgslayoutitemlegend.cpp.

◆ setResizeToContents()

void QgsLayoutItemLegend::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()

Definition at line 213 of file qgslayoutitemlegend.cpp.

◆ setSplitLayer()

void QgsLayoutItemLegend::setSplitLayer ( bool  enabled)

Sets whether the legend items from a single layer can be split over multiple columns.

See also
splitLayer()

Definition at line 438 of file qgslayoutitemlegend.cpp.

◆ setStyle()

void QgsLayoutItemLegend::setStyle ( QgsLegendStyle::Style  component,
const QgsLegendStyle style 
)

Sets the style of component to style for the legend.

Definition at line 298 of file qgslayoutitemlegend.cpp.

◆ setStyleFont()

void QgsLayoutItemLegend::setStyleFont ( QgsLegendStyle::Style  component,
const QFont &  font 
)

Sets the style font for a legend component.

See also
styleFont()

Definition at line 308 of file qgslayoutitemlegend.cpp.

◆ setStyleMargin() [1/2]

void QgsLayoutItemLegend::setStyleMargin ( QgsLegendStyle::Style  component,
double  margin 
)

Set the margin for a legend component.

Definition at line 313 of file qgslayoutitemlegend.cpp.

◆ setStyleMargin() [2/2]

void QgsLayoutItemLegend::setStyleMargin ( QgsLegendStyle::Style  component,
QgsLegendStyle::Side  side,
double  margin 
)

Set the margin for a particular side of a legend component.

Definition at line 318 of file qgslayoutitemlegend.cpp.

◆ setSymbolAlignment()

void QgsLayoutItemLegend::setSymbolAlignment ( Qt::AlignmentFlag  alignment)

Sets the alignment for placement of legend symbols.

Only Qt::AlignLeft or Qt::AlignRight are supported values.

See also
symbolAlignment()
Since
QGIS 3.10

Definition at line 373 of file qgslayoutitemlegend.cpp.

◆ setSymbolHeight()

void QgsLayoutItemLegend::setSymbolHeight ( double  height)

Sets the legend symbol height.

See also
symbolHeight()

Definition at line 388 of file qgslayoutitemlegend.cpp.

◆ setSymbolWidth()

void QgsLayoutItemLegend::setSymbolWidth ( double  width)

Sets the legend symbol width.

See also
symbolWidth()

Definition at line 368 of file qgslayoutitemlegend.cpp.

◆ setTitle()

void QgsLayoutItemLegend::setTitle ( const QString &  title)

Sets the legend title.

See also
title()

Definition at line 262 of file qgslayoutitemlegend.cpp.

◆ setTitleAlignment()

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

Sets the alignment of the legend title.

See also
titleAlignment()

Definition at line 283 of file qgslayoutitemlegend.cpp.

◆ setWmsLegendHeight()

void QgsLayoutItemLegend::setWmsLegendHeight ( double  height)

Sets the WMS legend height.

See also
wmsLegendHeight()

Definition at line 407 of file qgslayoutitemlegend.cpp.

◆ setWmsLegendWidth()

void QgsLayoutItemLegend::setWmsLegendWidth ( double  width)

Sets the WMS legend width.

See also
wmsLegendWidth()

Definition at line 398 of file qgslayoutitemlegend.cpp.

◆ setWrapString()

void QgsLayoutItemLegend::setWrapString ( const QString &  string)

Sets the legend text wrapping string.

See also
wrapString()

Definition at line 412 of file qgslayoutitemlegend.cpp.

◆ splitLayer()

bool QgsLayoutItemLegend::splitLayer ( ) const

Returns whether the legend items from a single layer can be split over multiple columns.

See also
setSplitLayer()

Definition at line 433 of file qgslayoutitemlegend.cpp.

◆ style()

QgsLegendStyle QgsLayoutItemLegend::style ( QgsLegendStyle::Style  s) const

Returns legend style.

Definition at line 293 of file qgslayoutitemlegend.cpp.

◆ styleFont()

QFont QgsLayoutItemLegend::styleFont ( QgsLegendStyle::Style  component) const

Returns the font settings for a legend component.

See also
setStyleFont()

Definition at line 303 of file qgslayoutitemlegend.cpp.

◆ symbolAlignment()

Qt::AlignmentFlag QgsLayoutItemLegend::symbolAlignment ( ) const

Returns the alignment for placement of legend symbols.

Only Qt::AlignLeft or Qt::AlignRight are supported values.

See also
setSymbolAlignment()
Since
QGIS 3.10

Definition at line 378 of file qgslayoutitemlegend.cpp.

◆ symbolHeight()

double QgsLayoutItemLegend::symbolHeight ( ) const

Returns the legend symbol height.

See also
setSymbolHeight()

Definition at line 383 of file qgslayoutitemlegend.cpp.

◆ symbolWidth()

double QgsLayoutItemLegend::symbolWidth ( ) const

Returns the legend symbol width.

See also
setSymbolWidth()

Definition at line 363 of file qgslayoutitemlegend.cpp.

◆ title()

QString QgsLayoutItemLegend::title ( ) const

Returns the legend title.

See also
setTitle()

Definition at line 273 of file qgslayoutitemlegend.cpp.

◆ titleAlignment()

Qt::AlignmentFlag QgsLayoutItemLegend::titleAlignment ( ) const

Returns the alignment of the legend title.

See also
setTitleAlignment()

Definition at line 278 of file qgslayoutitemlegend.cpp.

◆ type()

int QgsLayoutItemLegend::type ( ) const
override

Definition at line 67 of file qgslayoutitemlegend.cpp.

◆ updateFilterByMap()

void QgsLayoutItemLegend::updateFilterByMap ( bool  redraw = true)

Updates the legend content when filtered by map.

Definition at line 776 of file qgslayoutitemlegend.cpp.

◆ updateLegend()

void QgsLayoutItemLegend::updateLegend ( )

Updates the model and all legend entries.

Definition at line 484 of file qgslayoutitemlegend.cpp.

◆ wmsLegendHeight()

double QgsLayoutItemLegend::wmsLegendHeight ( ) const

Returns the WMS legend height.

See also
setWmsLegendHeight()

Definition at line 403 of file qgslayoutitemlegend.cpp.

◆ wmsLegendWidth()

double QgsLayoutItemLegend::wmsLegendWidth ( ) const

Returns the WMS legend width.

See also
setWmsLegendWidth()

Definition at line 393 of file qgslayoutitemlegend.cpp.

◆ wrapString()

QString QgsLayoutItemLegend::wrapString ( ) const

Returns the legend text wrapping string.

See also
setWrapString()

Definition at line 417 of file qgslayoutitemlegend.cpp.

◆ writePropertiesToElement()

bool QgsLayoutItemLegend::writePropertiesToElement ( QDomElement &  element,
QDomDocument &  document,
const QgsReadWriteContext context 
) const
overrideprotectedvirtual

Stores item state within an XML DOM element.

Parameters
elementis the DOM element to store the item's properties in
documentDOM document
contextread write context
See also
writeXml()
readPropertiesFromElement()

Reimplemented from QgsLayoutItem.

Definition at line 490 of file qgslayoutitemlegend.cpp.

Friends And Related Function Documentation

◆ QgsCompositionConverter

friend class QgsCompositionConverter
friend

Definition at line 569 of file qgslayoutitemlegend.h.


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