QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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)
 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 ()
 
virtual void setItemRotation (const double r, const bool adjustPosition=false)
 Sets the item rotation. More...
 
virtual void setRotation (double r)
 Sets the item rotation. More...
 
- Public Slots inherited from QgsComposerObject
virtual void refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties)
 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. More...
 
QRectF boundingRect () const
 In case of negative margins, the bounding rect may be larger than the label's frame. More...
 
virtual QString displayName () const
 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 ()
 
Q_DECL_DEPRECATED double margin ()
 Returns the margin between the edge of the frame and the label contents. More...
 
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)
 Reimplementation of QCanvasItem::paint. More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document More...
 
void setExpressionContext (QgsFeature *feature, QgsVectorLayer *layer, QMap< QString, QVariant > substitutions=(QMap< QString, QVariant >()))
 Sets the current feature, the current layer and a list of local variable substitutions for evaluating expressions. More...
 
void setFont (const QFont &f)
 
void setFontColor (const QColor &c)
 Sets text color. More...
 
virtual void setFrameEnabled (const bool drawFrame)
 Reimplemented to call prepareGeometryChange after toggling frame. More...
 
virtual void setFrameOutlineWidth (const double outlineWidth)
 Reimplemented to call prepareGeometryChange after changing outline 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
 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
 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. More...
 
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. More...
 
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default. More...
 
QColor backgroundColor () const
 Gets the background color for this item. More...
 
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command. More...
 
virtual void beginItemCommand (const QString &text)
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void cancelCommand ()
 
Q_DECL_DEPRECATED void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const
 Draws Text. More...
 
Q_DECL_DEPRECATED void drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop, int flags=Qt::TextWordWrap) const
 Like the above, but with a rectangle for multiline text. More...
 
bool effectsEnabled () const
 Returns whether effects (eg blend modes) are enabled for the item. More...
 
void endCommand ()
 Finish current command and push it onto the undo stack. More...
 
virtual void endItemCommand ()
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
bool excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue)
 Returns whether the item should be excluded from composer exports and prints. More...
 
Q_DECL_DEPRECATED double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontDescentMillimeters (const QFont &font) const
 Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters. More...
 
Q_DECL_DEPRECATED double fontHeightMillimeters (const QFont &font) const
 Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
QColor frameOutlineColor () const
 Returns the frame's outline color. More...
 
double frameOutlineWidth () const
 Returns the frame's outline width. More...
 
bool hasBackground () const
 Whether this item has a Background or not. More...
 
bool hasFrame () const
 Whether this item has a frame or not. More...
 
QString id () const
 Get item's id (which is not necessarly unique) More...
 
bool isGroupMember () const
 Returns whether this item is part of a group. More...
 
virtual bool isRemoved () const
 Returns whether this item has been removed from the composition. More...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item. More...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. More...
 
void move (double dx, double dy)
 Moves item in canvas coordinates. More...
 
virtual void moveContent (double dx, double dy)
 Move Content of item. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
int page () const
 Gets the page the item is currently on. More...
 
QPointF pagePos () const
 Returns the item's position relative to its current page. More...
 
Q_DECL_DEPRECATED double pixelFontSize (double pointSize) const
 Calculates font size in mm from a font point size. More...
 
bool positionLock () const
 Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
virtual void removeItems ()
 
Q_DECL_DEPRECATED double rotation () const
 Returns the rotation for the composer item. More...
 
Q_DECL_DEPRECATED QFont scaledFontPixelSize (const QFont &font) const
 Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. More...
 
virtual bool selected () const
 Is selected. More...
 
void setBackgroundColor (const QColor &backgroundColor)
 Sets the background color for this item. More...
 
void setBackgroundEnabled (const bool drawBackground)
 Set whether this item has a Background drawn around it or not. More...
 
void setBlendMode (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting. More...
 
void setEffectsEnabled (const bool effectsEnabled)
 Sets whether effects (eg blend modes) are enabled for the item. More...
 
virtual void setExcludeFromExports (const bool exclude)
 Sets whether the item should be excluded from composer exports and prints. More...
 
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 setId (const QString &id)
 Set item's id (which is not necessarly unique) More...
 
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group. More...
 
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition. More...
 
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
 Moves the item to a new position (in canvas coordinates) More...
 
void setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft, bool posIncludesFrame=false, int page=-1)
 Sets item position and width / height in one go. More...
 
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags. More...
 
virtual void setSceneRect (const QRectF &rectangle)
 Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit. More...
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
void setTransparency (const int transparency)
 Sets the item's transparency. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
Q_DECL_DEPRECATED double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
int transparency () const
 Returns the item's transparency. More...
 
virtual void updateItem ()
 Updates item, with the possibility to do custom update for subclasses. More...
 
void updatePagePos (double newPageWidth, double newPageHeight)
 Moves the item so that it retains its relative position on the page when the paper size changes. More...
 
QString uuid () const
 Get item identification name. More...
 
virtual Q_DECL_DEPRECATED void zoomContent (int delta, double x, double y)
 Zoom content of item. More...
 
virtual void zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom)
 Zoom content of item. More...
 
- Public Member Functions inherited from QgsComposerObject
 QgsComposerObject (QgsComposition *composition)
 Constructor. More...
 
virtual ~QgsComposerObject ()
 
const QgsCompositioncomposition () const
 Returns the composition the item is attached to. More...
 
QgsCompositioncomposition ()
 
QgsDataDefineddataDefinedProperty (const DataDefinedProperty property) const
 Returns a reference to the data defined settings for one of the item's data defined properties. 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...
 

Additional Inherited Members

- Public Types inherited from QgsComposerItem
enum  ItemPositionMode {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
 
enum  ItemType {
  ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel,
  ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture,
  ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable,
  ComposerTextTable, ComposerFrame
}
 
enum  MouseMoveAction {
  MoveItem, ResizeUp, ResizeDown, ResizeLeft,
  ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown,
  ResizeRightDown, NoAction
}
 Describes the action (move or resize in different directon) to be done during mouse move. More...
 
enum  ZoomMode { Zoom = 0, ZoomRecenter, ZoomToPoint, NoZoom }
 Modes for zooming item content. More...
 
- Public Types inherited from QgsComposerObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, BlendMode,
  ExcludeFromExports, MapRotation, MapScale, MapXMin,
  MapYMin, MapXMax, MapYMax, MapAtlasMargin,
  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
Q_DECL_DEPRECATED double angle (const QPointF &p1, const QPointF &p2) const
 Returns angle of the line from p1 to p2 (clockwise, starting at N) More...
 
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
 Calculates corner point after rotation and scaling. More...
 
Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling. More...
 
void deleteAlignItems ()
 
void deleteHAlignSnapItem ()
 
void deleteVAlignSnapItem ()
 
Q_DECL_DEPRECATED void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawSelectionBoxes (QPainter *p)
 Draws additional graphics on selected items. More...
 
QRectF evalItemRect (const QRectF &newRect, const bool resizeOnly=false)
 Evaluates an item's bounding rect to consider data defined position and size of item and reference point. More...
 
QGraphicsLineItem * hAlignSnapItem ()
 Return horizontal align snap item. More...
 
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view. More...
 
Q_DECL_DEPRECATED bool imageSizeConsideringRotation (double &width, double &height, double rotation) const
 Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...
 
Q_DECL_DEPRECATED bool imageSizeConsideringRotation (double &width, double &height) const
 Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...
 
Q_DECL_DEPRECATED QRectF largestRotatedRectWithinBounds (QRectF originalRect, QRectF boundsRect, double rotation) const
 Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount. More...
 
Q_DECL_DEPRECATED double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size. More...
 
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. More...
 
Q_DECL_DEPRECATED void rotate (double angle, double &x, double &y) const
 Rotates a point / vector. More...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
Q_DECL_DEPRECATED void sizeChangedByRotation (double &width, double &height, double rotation)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
Q_DECL_DEPRECATED void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
QGraphicsLineItem * vAlignSnapItem ()
 Return vertical align snap item. More...
 
- Protected Member Functions inherited from QgsComposerObject
bool dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
 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
 
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 label that can be placed onto a map composition.

Definition at line 30 of file qgscomposerlabel.h.

Constructor & Destructor Documentation

QgsComposerLabel::QgsComposerLabel ( QgsComposition composition)

Definition at line 37 of file qgscomposerlabel.cpp.

QgsComposerLabel::~QgsComposerLabel ( )

Definition at line 83 of file qgscomposerlabel.cpp.

Member Function Documentation

void QgsComposerLabel::adjustSizeToText ( )

resizes the widget such that the text fits to the item.

Keeps top left point

Definition at line 334 of file qgscomposerlabel.cpp.

QRectF QgsComposerLabel::boundingRect ( ) const

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

Definition at line 500 of file qgscomposerlabel.cpp.

QString QgsComposerLabel::displayName ( ) const
virtual

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 472 of file qgscomposerlabel.cpp.

QString QgsComposerLabel::displayText ( ) const

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

Definition at line 276 of file qgscomposerlabel.cpp.

QFont QgsComposerLabel::font ( ) const

Definition at line 354 of file qgscomposerlabel.cpp.

QColor QgsComposerLabel::fontColor ( ) const
inline

Get font color.

Definition at line 130 of file qgscomposerlabel.h.

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

Accessor for the horizontal alignment of the label.

Returns
Qt::AlignmentFlag

Definition at line 67 of file qgscomposerlabel.h.

int QgsComposerLabel::htmlState ( )
inline

Definition at line 49 of file qgscomposerlabel.h.

Q_DECL_DEPRECATED double QgsComposerLabel::margin ( )
inline

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

Returns
margin in mm
Deprecated:
use marginX and marginY instead

Definition at line 83 of file qgscomposerlabel.h.

double QgsComposerLabel::marginX ( ) const
inline

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

Returns
horizontal margin in mm
Note
added in QGIS 2.7

Definition at line 90 of file qgscomposerlabel.h.

double QgsComposerLabel::marginY ( ) const
inline

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

Returns
vertical margin in mm
Note
added in QGIS 2.7

Definition at line 97 of file qgscomposerlabel.h.

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

Reimplementation of QCanvasItem::paint.

Definition at line 88 of file qgscomposerlabel.cpp.

bool QgsComposerLabel::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
virtual

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.

void QgsComposerLabel::refreshExpressionContext ( )
slot

Definition at line 259 of file qgscomposerlabel.cpp.

void QgsComposerLabel::setExpressionContext ( QgsFeature feature,
QgsVectorLayer layer,
QMap< QString, QVariant >  substitutions = ( QMap<QString, QVariant>() ) 
)

Sets the current feature, the current layer and a list of local variable substitutions for evaluating expressions.

Definition at line 233 of file qgscomposerlabel.cpp.

void QgsComposerLabel::setFont ( const QFont &  f)

Definition at line 310 of file qgscomposerlabel.cpp.

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

Sets text color.

Definition at line 128 of file qgscomposerlabel.h.

void QgsComposerLabel::setFrameEnabled ( const bool  drawFrame)
virtual

Reimplemented to call prepareGeometryChange after toggling frame.

Reimplemented from QgsComposerItem.

Definition at line 518 of file qgscomposerlabel.cpp.

void QgsComposerLabel::setFrameOutlineWidth ( const double  outlineWidth)
virtual

Reimplemented to call prepareGeometryChange after changing outline width.

Reimplemented from QgsComposerItem.

Definition at line 524 of file qgscomposerlabel.cpp.

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

Mutator for the horizontal alignment of the label.

Parameters
aalignment
Returns
void

Definition at line 72 of file qgscomposerlabel.h.

void QgsComposerLabel::setHtmlState ( int  state)

Definition at line 217 of file qgscomposerlabel.cpp.

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 315 of file qgscomposerlabel.cpp.

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
Note
added in QGIS 2.7

Definition at line 322 of file qgscomposerlabel.cpp.

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
Note
added in QGIS 2.7

Definition at line 328 of file qgscomposerlabel.cpp.

void QgsComposerLabel::setText ( const QString &  text)

Definition at line 205 of file qgscomposerlabel.cpp.

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

Mutator for the vertical alignment of the label.

Parameters
aalignment
Returns
void

Definition at line 77 of file qgscomposerlabel.h.

QString QgsComposerLabel::text ( void  )
inline

Definition at line 46 of file qgscomposerlabel.h.

virtual int QgsComposerLabel::type ( ) const
inlinevirtual

return correct graphics item type.

Reimplemented from QgsComposerItem.

Definition at line 38 of file qgscomposerlabel.h.

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.

bool QgsComposerLabel::writeXML ( QDomElement &  elem,
QDomDocument &  doc 
) const
virtual

stores state in Dom element

Parameters
elemis Dom element corresponding to 'Composer' tag
docdocument

Reimplemented from QgsComposerObject.

Definition at line 359 of file qgscomposerlabel.cpp.


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