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

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

#include <qgscomposerlabel.h>

Inheritance diagram for QgsComposerLabel:
Inheritance graph
[legend]

Public Slots

void refreshExpressionContext ()
 
- 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 rotation, const bool adjustPosition=false)
 Sets the item rotation, in degrees clockwise. 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

 QgsComposerLabel (QgsComposition *composition)
 
 ~QgsComposerLabel ()
 
void adjustSizeToText ()
 Resizes the widget such that the text fits to the item. Keeps top left point. More...
 
QRectF boundingRect () const override
 In case of negative margins, the bounding rect may be larger than the label's frame. More...
 
virtual QString displayName () const override
 Get item display name. More...
 
QString displayText () const
 Returns the text as it appears on screen (with replaced data field) More...
 
QFont font () const
 
QColor fontColor () const
 Get font color. More...
 
Qt::AlignmentFlag hAlign () const
 Accessor for the horizontal alignment of the label. More...
 
int htmlState ()
 
double marginX () const
 Returns the horizontal margin between the edge of the frame and the label contents. More...
 
double marginY () const
 Returns the vertical margin between the edge of the frame and the label contents. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override
 Reimplementation of QCanvasItem::paint. More...
 
bool readXml (const QDomElement &itemElem, const QDomDocument &doc) override
 Sets state from Dom document. More...
 
void setFont (const QFont &f)
 
void setFontColor (const QColor &c)
 Sets text color. More...
 
virtual void setFrameEnabled (const bool drawFrame) override
 Reimplemented to call prepareGeometryChange after toggling frame. More...
 
virtual void setFrameStrokeWidth (const double strokeWidth) override
 Reimplemented to call prepareGeometryChange after changing stroke width. More...
 
void setHAlign (Qt::AlignmentFlag a)
 Mutator for the horizontal alignment of the label. More...
 
void setHtmlState (int state)
 
void setMargin (const double m)
 Sets the margin between the edge of the frame and the label contents. More...
 
void setMarginX (const double margin)
 Sets the horizontal margin between the edge of the frame and the label contents. More...
 
void setMarginY (const double margin)
 Sets the vertical margin between the edge of the frame and the label contents. More...
 
void setText (const QString &text)
 
void setVAlign (Qt::AlignmentFlag a)
 Mutator for the vertical alignment of the label. More...
 
QString text ()
 
virtual int type () const override
 Return correct graphics item type. More...
 
Qt::AlignmentFlag vAlign () const
 Accessor for the vertical alignment of the label. More...
 
bool writeXml (QDomElement &elem, QDomDocument &doc) const override
 Stores state in Dom element. 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 (e.g., 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 frameStrokeColor () const
 Returns the frame's stroke color. More...
 
double frameStrokeWidth () const
 Returns the frame's stroke 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 itemOpacity () const
 Returns the item's opacity. More...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item, in degrees clockwise. 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 (e.g., 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...
 
void setFrameJoinStyle (const Qt::PenJoinStyle style)
 Sets join style used when drawing the item's frame. More...
 
virtual void setFrameStrokeColor (const QColor &color)
 Sets frame stroke color. 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 setItemOpacity (const double opacity)
 Sets the item's opacity. 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 setUpdatesEnabled (bool enabled)
 Sets whether updates to the item are enabled. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
virtual void updateItem ()
 Updates (redraws) the 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...
 
bool updatesEnabled () const
 Returns whether updates to the item are enabled. 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 ()=default
 
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...
 
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...
 
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
 

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, Opacity,
  BlendMode, ExcludeFromExports, FrameColor, BackgroundColor,
  MapRotation, MapScale, MapXMin, MapYMin,
  MapXMax, MapYMax, MapAtlasMargin, MapLayers,
  MapStylePreset, PictureSource, PictureSvgBackgroundColor, PictureSvgStrokeColor,
  PictureSvgStrokeWidth, SourceUrl, LegendTitle, LegendColumnCount,
  ScalebarFillColor, ScalebarFillColor2, ScalebarLineColor, ScalebarLineWidth
}
 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 QgsComposerObject
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the composer object property definitions. 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 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 = nullptr
 Rectangle used during move and resize actions. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 
QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction
 
QgsComposerEffectmEffect = nullptr
 
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...
 
QColor mFrameColor
 Item frame color. More...
 
Qt::PenJoinStyle mFrameJoinStyle = Qt::MiterJoin
 Frame join style. More...
 
double mFrameWidth = 0.3
 Item frame width. More...
 
QGraphicsLineItem * mHAlignSnapItem = nullptr
 
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...
 
double mOpacity = 1.0
 Item opacity, between 0 and 1. More...
 
bool mRemovedFromComposition
 True if item has been removed from the composition. More...
 
QGraphicsLineItem * mVAlignSnapItem = nullptr
 
- Protected Attributes inherited from QgsComposerObject
QgsCompositionmComposition = nullptr
 
QgsObjectCustomProperties mCustomProperties
 Custom properties for object. More...
 
QgsPropertyCollection mDataDefinedProperties
 

Detailed Description

A label that can be placed onto a map composition.

Definition at line 32 of file qgscomposerlabel.h.

Constructor & Destructor Documentation

◆ QgsComposerLabel()

QgsComposerLabel::QgsComposerLabel ( QgsComposition composition)

Definition at line 44 of file qgscomposerlabel.cpp.

◆ ~QgsComposerLabel()

QgsComposerLabel::~QgsComposerLabel ( )

Definition at line 102 of file qgscomposerlabel.cpp.

Member Function Documentation

◆ adjustSizeToText()

void QgsComposerLabel::adjustSizeToText ( )

Resizes the widget such that the text fits to the item. Keeps top left point.

Definition at line 337 of file qgscomposerlabel.cpp.

◆ boundingRect()

QRectF QgsComposerLabel::boundingRect ( ) const
override

In case of negative margins, the bounding rect may be larger than the label's frame.

Definition at line 493 of file qgscomposerlabel.cpp.

◆ displayName()

QString QgsComposerLabel::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
Since
QGIS 2.5

Reimplemented from QgsComposerItem.

Definition at line 465 of file qgscomposerlabel.cpp.

◆ displayText()

QString QgsComposerLabel::displayText ( ) const

Returns the text as it appears on screen (with replaced data field)

Definition at line 278 of file qgscomposerlabel.cpp.

◆ font()

QFont QgsComposerLabel::font ( ) const

Definition at line 357 of file qgscomposerlabel.cpp.

◆ fontColor()

QColor QgsComposerLabel::fontColor ( ) const
inline

Get font color.

Definition at line 127 of file qgscomposerlabel.h.

◆ hAlign()

Qt::AlignmentFlag QgsComposerLabel::hAlign ( ) const
inline

Accessor for the horizontal alignment of the label.

Returns
Qt::AlignmentFlag

Definition at line 68 of file qgscomposerlabel.h.

◆ htmlState()

int QgsComposerLabel::htmlState ( )
inline

Definition at line 51 of file qgscomposerlabel.h.

◆ marginX()

double QgsComposerLabel::marginX ( ) const
inline

Returns the horizontal margin between the edge of the frame and the label contents.

Returns
horizontal margin in mm
Since
QGIS 2.7

Definition at line 87 of file qgscomposerlabel.h.

◆ marginY()

double QgsComposerLabel::marginY ( ) const
inline

Returns the vertical margin between the edge of the frame and the label contents.

Returns
vertical margin in mm
Since
QGIS 2.7

Definition at line 94 of file qgscomposerlabel.h.

◆ paint()

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

Reimplementation of QCanvasItem::paint.

Definition at line 108 of file qgscomposerlabel.cpp.

◆ readXml()

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

Sets state from Dom document.

Parameters
itemElemis Dom element corresponding to 'ComposerLabel' tag
docdocument

Reimplemented from QgsComposerObject.

Definition at line 394 of file qgscomposerlabel.cpp.

◆ refreshExpressionContext

void QgsComposerLabel::refreshExpressionContext ( )
slot

Definition at line 249 of file qgscomposerlabel.cpp.

◆ setFont()

void QgsComposerLabel::setFont ( const QFont &  f)

Definition at line 313 of file qgscomposerlabel.cpp.

◆ setFontColor()

void QgsComposerLabel::setFontColor ( const QColor &  c)
inline

Sets text color.

Definition at line 125 of file qgscomposerlabel.h.

◆ setFrameEnabled()

void QgsComposerLabel::setFrameEnabled ( const bool  drawFrame)
overridevirtual

Reimplemented to call prepareGeometryChange after toggling frame.

Reimplemented from QgsComposerItem.

Definition at line 511 of file qgscomposerlabel.cpp.

◆ setFrameStrokeWidth()

void QgsComposerLabel::setFrameStrokeWidth ( const double  strokeWidth)
overridevirtual

Reimplemented to call prepareGeometryChange after changing stroke width.

Reimplemented from QgsComposerItem.

Definition at line 517 of file qgscomposerlabel.cpp.

◆ setHAlign()

void QgsComposerLabel::setHAlign ( Qt::AlignmentFlag  a)
inline

Mutator for the horizontal alignment of the label.

Parameters
aalignment
Returns
void

Definition at line 74 of file qgscomposerlabel.h.

◆ setHtmlState()

void QgsComposerLabel::setHtmlState ( int  state)

Definition at line 232 of file qgscomposerlabel.cpp.

◆ setMargin()

void QgsComposerLabel::setMargin ( const double  m)

Sets the margin between the edge of the frame and the label contents.

This method sets both the horizontal and vertical margins to the same value. The margins can be individually controlled using the setMarginX and setMarginY methods.

Parameters
mmargin in mm
See also
setMarginX
setMarginY

Definition at line 318 of file qgscomposerlabel.cpp.

◆ setMarginX()

void QgsComposerLabel::setMarginX ( const double  margin)

Sets the horizontal margin between the edge of the frame and the label contents.

Parameters
marginhorizontal margin in mm
See also
setMargin
setMarginY
Since
QGIS 2.7

Definition at line 325 of file qgscomposerlabel.cpp.

◆ setMarginY()

void QgsComposerLabel::setMarginY ( const double  margin)

Sets the vertical margin between the edge of the frame and the label contents.

Parameters
marginvertical margin in mm
See also
setMargin
setMarginX
Since
QGIS 2.7

Definition at line 331 of file qgscomposerlabel.cpp.

◆ setText()

void QgsComposerLabel::setText ( const QString &  text)

Definition at line 218 of file qgscomposerlabel.cpp.

◆ setVAlign()

void QgsComposerLabel::setVAlign ( Qt::AlignmentFlag  a)
inline

Mutator for the vertical alignment of the label.

Parameters
aalignment
Returns
void

Definition at line 80 of file qgscomposerlabel.h.

◆ text()

QString QgsComposerLabel::text ( )
inline

Definition at line 48 of file qgscomposerlabel.h.

◆ type()

virtual int QgsComposerLabel::type ( ) const
inlineoverridevirtual

Return correct graphics item type.

Reimplemented from QgsComposerItem.

Definition at line 40 of file qgscomposerlabel.h.

◆ vAlign()

Qt::AlignmentFlag QgsComposerLabel::vAlign ( ) const
inline

Accessor for the vertical alignment of the label.

Returns
Qt::AlignmentFlag

Definition at line 63 of file qgscomposerlabel.h.

◆ writeXml()

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

Stores state in Dom element.

Parameters
elemis Dom element corresponding to 'Composer' tag
docdocument

Reimplemented from QgsComposerObject.

Definition at line 362 of file qgscomposerlabel.cpp.


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