QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Slots | Public Member Functions | Private Member Functions | Private Attributes | List of all members
QgsComposerLegend Class Reference

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

#include <qgscomposerlegend.h>

Inheritance diagram for QgsComposerLegend:
Inheritance graph
[legend]
Collaboration diagram for QgsComposerLegend:
Collaboration graph
[legend]

Public Slots

void synchronizeWithModel ()
 Data changed. More...
 
void invalidateCurrentMap ()
 Sets mCompositionMap to 0 if the map is deleted. More...
 
- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
 Sets the item rotation. More...
 
virtual void setItemRotation (const double r, const bool adjustPosition=false)
 Sets the item rotation. More...
 
void repaint ()
 
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...
 
- Public Slots inherited from QgsComposerObject
virtual void repaint ()
 Triggers a redraw for the item. More...
 
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...
 

Public Member Functions

 QgsComposerLegend (QgsComposition *composition)
 
 ~QgsComposerLegend ()
 
virtual int type () const
 return correct graphics item type. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint. More...
 
QSizeF paintAndDetermineSize (QPainter *painter)
 Paints the legend and calculates its size. More...
 
void adjustBoxSize ()
 Sets item box to the whole content. More...
 
QgsLegendModelmodel ()
 Returns pointer to the legend model. More...
 
void setTitle (const QString &t)
 
QString title () const
 
Qt::AlignmentFlag titleAlignment () const
 Returns the alignment of the legend title. More...
 
void setTitleAlignment (Qt::AlignmentFlag alignment)
 Sets the alignment of the legend title. More...
 
QgsComposerLegendStylerstyle (QgsComposerLegendStyle::Style s)
 Returns reference to modifiable style. More...
 
QgsComposerLegendStyle style (QgsComposerLegendStyle::Style s) const
 Returns style. More...
 
void setStyle (QgsComposerLegendStyle::Style s, const QgsComposerLegendStyle style)
 
QFont styleFont (QgsComposerLegendStyle::Style s) const
 
void setStyleFont (QgsComposerLegendStyle::Style s, const QFont &f)
 Set style font. More...
 
void setStyleMargin (QgsComposerLegendStyle::Style s, double margin)
 Set style margin. More...
 
void setStyleMargin (QgsComposerLegendStyle::Style s, QgsComposerLegendStyle::Side side, double margin)
 
double boxSpace () const
 
void setBoxSpace (double s)
 
double columnSpace () const
 
void setColumnSpace (double s)
 
QColor fontColor () const
 
void setFontColor (const QColor &c)
 
double symbolWidth () const
 
void setSymbolWidth (double w)
 
double symbolHeight () const
 
void setSymbolHeight (double h)
 
double wmsLegendWidth () const
 
void setWmsLegendWidth (double w)
 
double wmsLegendHeight () const
 
void setWmsLegendHeight (double h)
 
void setWrapChar (const QString &t)
 
QString wrapChar () const
 
int columnCount () const
 
void setColumnCount (int c)
 
int splitLayer () const
 
void setSplitLayer (bool s)
 
int equalColumnWidth () const
 
void setEqualColumnWidth (bool s)
 
void setComposerMap (const QgsComposerMap *map)
 
const QgsComposerMapcomposerMap () const
 
void updateLegend ()
 Updates the model and all legend entries. More...
 
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom node More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document More...
 
virtual QString displayName () const
 Get item display name. 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 ()
 
virtual bool isRemoved () const
 Returns whether this item has been removed from the composition. More...
 
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition. More...
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
virtual bool selected () const
 Is selected. 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 void zoomContent (int delta, double x, double y)
 Zoom content of item. 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...
 
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...
 
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...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. 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...
 
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. More...
 
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document. More...
 
bool hasFrame () const
 Whether this item has a frame or not. More...
 
void setFrameEnabled (const bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
virtual void setFrameOutlineWidth (const double outlineWidth)
 Sets frame outline width. More...
 
double frameOutlineWidth () const
 Returns the frame's outline width. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
void setFrameJoinStyle (const Qt::PenJoinStyle style)
 Sets join style used when drawing the item's frame. More...
 
virtual double estimatedFrameBleed () const
 Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...
 
virtual QRectF rectWithFrame () const
 Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...
 
bool hasBackground () const
 Whether this item has a Background or not. More...
 
void setBackgroundEnabled (const bool drawBackground)
 Set whether this item has a Background drawn around it or not. More...
 
QColor backgroundColor () const
 Gets the background color for this item. More...
 
void setBackgroundColor (const QColor &backgroundColor)
 Sets the background color for this item. More...
 
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode. More...
 
void setBlendMode (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
int transparency () const
 Returns the item's transparency. More...
 
void setTransparency (const int transparency)
 Sets the item's transparency. More...
 
bool effectsEnabled () const
 Returns whether effects (eg blend modes) are enabled for the item. More...
 
void setEffectsEnabled (const bool effectsEnabled)
 Sets whether effects (eg blend modes) are enabled for the item. More...
 
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default. More...
 
virtual void removeItems ()
 
virtual void beginItemCommand (const QString &text)
 
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command. More...
 
virtual void endItemCommand ()
 
void endCommand ()
 Finish current command and push it onto the undo stack. 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...
 
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...
 
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 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 fontHeightMillimeters (const QFont &font) const
 Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double pixelFontSize (double pointSize) const
 Calculates font size in mm from a font point size. 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...
 
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags. 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...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item. More...
 
Q_DECL_DEPRECATED double rotation () const
 Returns the rotation for the composer item. More...
 
virtual void updateItem ()
 Updates item, with the possibility to do custom update for subclasses. More...
 
QString id () const
 Get item's id (which is not necessarly unique) More...
 
virtual void setId (const QString &id)
 Set item's id (which is not necessarly unique) More...
 
QString uuid () const
 Get item identification name. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
bool isGroupMember () const
 Returns whether this item is part of a group. More...
 
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting. 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...
 

Private Member Functions

 QgsComposerLegend ()
 

Private Attributes

QgsLegendModel mLegendModel
 
QgsLegendSettings mSettings
 
const QgsComposerMapmComposerMap
 

Additional Inherited Members

- Public Types inherited from QgsComposerItem
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  ItemPositionMode {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
 
- Public Types inherited from QgsComposerObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, BlendMode,
  MapRotation, MapScale, MapXMin, MapYMin,
  MapXMax, MapYMax, 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 itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
- Signals inherited from QgsComposerObject
void itemChanged ()
 Emitted when the item changes. More...
 
- Protected Member Functions inherited from QgsComposerItem
virtual void drawSelectionBoxes (QPainter *p)
 Draws additional graphics on selected items. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
Q_DECL_DEPRECATED void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
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...
 
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 double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size. 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 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...
 
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...
 
Q_DECL_DEPRECATED void rotate (double angle, double &x, double &y) const
 Rotates a point / vector. More...
 
QGraphicsLineItem * hAlignSnapItem ()
 Return horizontal align snap item. More...
 
void deleteHAlignSnapItem ()
 
QGraphicsLineItem * vAlignSnapItem ()
 Return vertical align snap item. More...
 
void deleteVAlignSnapItem ()
 
void deleteAlignItems ()
 
QRectF evalItemRect (const QRectF &newRect)
 Update an item rect to consider data defined position and size of 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 mRemovedFromComposition
 True if item has been removed from the composition. More...
 
QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction
 
QPointF mMouseMoveStartPos
 Start point of the last mouse move action (in scene coordinates) More...
 
QPointF mLastMouseEventPos
 Position of the last mouse move event (in scene coordinates) More...
 
QGraphicsRectItem * mBoundingResizeRectangle
 Rectangle used during move and resize actions. More...
 
QGraphicsLineItem * mHAlignSnapItem
 
QGraphicsLineItem * mVAlignSnapItem
 
bool mFrame
 True if item fram needs to be painted. More...
 
bool mBackground
 True if item background needs to be painted. More...
 
QColor mBackgroundColor
 Background color. More...
 
Qt::PenJoinStyle mFrameJoinStyle
 Frame join style. More...
 
bool mItemPositionLocked
 True if item position and size cannot be changed with mouse move. More...
 
double mLastValidViewScaleFactor
 Backup to restore item appearance if no view scale factor is available. More...
 
double mItemRotation
 Item rotation in degrees, clockwise. More...
 
double mEvaluatedItemRotation
 Temporary evaluated item rotation in degrees, clockwise. More...
 
QPainter::CompositionMode mBlendMode
 Composition blend mode for item. More...
 
bool mEffectsEnabled
 
QgsComposerEffectmEffect
 
int mTransparency
 Item transparency. More...
 
ItemPositionMode mLastUsedPositionMode
 The item's position mode. More...
 
bool mIsGroupMember
 Whether or not this item is part of a group. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 
- 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 legend that can be placed onto a map composition.

Definition at line 37 of file qgscomposerlegend.h.

Constructor & Destructor Documentation

QgsComposerLegend::QgsComposerLegend ( QgsComposition composition)

Definition at line 31 of file qgscomposerlegend.cpp.

References adjustBoxSize(), mLegendModel, and synchronizeWithModel().

QgsComposerLegend::~QgsComposerLegend ( )

Definition at line 46 of file qgscomposerlegend.cpp.

QgsComposerLegend::QgsComposerLegend ( )
private

Definition at line 41 of file qgscomposerlegend.cpp.

Member Function Documentation

void QgsComposerLegend::adjustBoxSize ( )

Sets item box to the whole content.

Definition at line 94 of file qgscomposerlegend.cpp.

References QgsLegendRenderer::minimumSize(), mLegendModel, mSettings, QgsDebugMsg, QgsComposerItem::setSceneRect(), and size.

Referenced by QgsComposerLegend(), synchronizeWithModel(), and updateLegend().

double QgsComposerLegend::boxSpace ( ) const

Definition at line 130 of file qgscomposerlegend.cpp.

References QgsLegendSettings::boxSpace(), and mSettings.

int QgsComposerLegend::columnCount ( ) const

Definition at line 154 of file qgscomposerlegend.cpp.

References QgsLegendSettings::columnCount(), and mSettings.

double QgsComposerLegend::columnSpace ( ) const

Definition at line 133 of file qgscomposerlegend.cpp.

References QgsLegendSettings::columnSpace(), and mSettings.

const QgsComposerMap* QgsComposerLegend::composerMap ( ) const
inline

Definition at line 125 of file qgscomposerlegend.h.

QString QgsComposerLegend::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 348 of file qgscomposerlegend.cpp.

References QgsComposerItem::id(), mSettings, QgsLegendSettings::title(), and tr.

int QgsComposerLegend::equalColumnWidth ( ) const

Definition at line 160 of file qgscomposerlegend.cpp.

References QgsLegendSettings::equalColumnWidth(), and mSettings.

QColor QgsComposerLegend::fontColor ( ) const

Definition at line 136 of file qgscomposerlegend.cpp.

References QgsLegendSettings::fontColor(), and mSettings.

void QgsComposerLegend::invalidateCurrentMap ( )
slot

Sets mCompositionMap to 0 if the map is deleted.

Definition at line 380 of file qgscomposerlegend.cpp.

References mComposerMap.

Referenced by setComposerMap().

QgsLegendModel* QgsComposerLegend::model ( )
inline

Returns pointer to the legend model.

Definition at line 58 of file qgscomposerlegend.h.

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

Paints the legend and calculates its size.

If painter is 0, only size is calculated

Definition at line 84 of file qgscomposerlegend.cpp.

References QgsLegendRenderer::drawLegend(), QgsLegendRenderer::minimumSize(), mLegendModel, mSettings, and size.

bool QgsComposerLegend::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
virtual
QgsComposerLegendStyle & QgsComposerLegend::rstyle ( QgsComposerLegendStyle::Style  s)

Returns reference to modifiable style.

Definition at line 120 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::rstyle().

Referenced by readXML(), setStyleFont(), and setStyleMargin().

void QgsComposerLegend::setBoxSpace ( double  s)

Definition at line 131 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setBoxSpace().

void QgsComposerLegend::setColumnCount ( int  c)

Definition at line 155 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setColumnCount().

void QgsComposerLegend::setColumnSpace ( double  s)

Definition at line 134 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setColumnSpace().

void QgsComposerLegend::setComposerMap ( const QgsComposerMap map)

Definition at line 371 of file qgscomposerlegend.cpp.

References invalidateCurrentMap(), and mComposerMap.

void QgsComposerLegend::setEqualColumnWidth ( bool  s)

Definition at line 161 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setEqualColumnWidth().

void QgsComposerLegend::setFontColor ( const QColor &  c)

Definition at line 137 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setFontColor().

void QgsComposerLegend::setSplitLayer ( bool  s)

Definition at line 158 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setSplitLayer().

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

Definition at line 122 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setStyle().

Referenced by readXML().

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

Set style font.

Definition at line 125 of file qgscomposerlegend.cpp.

References rstyle(), and QgsComposerLegendStyle::setFont().

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

Set style margin.

Definition at line 127 of file qgscomposerlegend.cpp.

References rstyle(), and QgsComposerLegendStyle::setMargin().

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

Definition at line 128 of file qgscomposerlegend.cpp.

References rstyle(), and QgsComposerLegendStyle::setMargin().

void QgsComposerLegend::setSymbolHeight ( double  h)
void QgsComposerLegend::setSymbolWidth ( double  w)
void QgsComposerLegend::setTitle ( const QString &  t)
void QgsComposerLegend::setTitleAlignment ( Qt::AlignmentFlag  alignment)

Sets the alignment of the legend title.

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

Definition at line 118 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setTitleAlignment().

void QgsComposerLegend::setWmsLegendHeight ( double  h)
void QgsComposerLegend::setWmsLegendWidth ( double  w)
void QgsComposerLegend::setWrapChar ( const QString &  t)

Definition at line 151 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::setWrapChar().

int QgsComposerLegend::splitLayer ( ) const

Definition at line 157 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::splitLayer().

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

Returns style.

Definition at line 121 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::style().

Referenced by readXML(), and writeXML().

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

Definition at line 142 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::symbolSize().

double QgsComposerLegend::symbolWidth ( ) const

Definition at line 139 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::symbolSize().

void QgsComposerLegend::synchronizeWithModel ( )
slot

Data changed.

Definition at line 164 of file qgscomposerlegend.cpp.

References adjustBoxSize(), and QgsDebugMsg.

Referenced by QgsComposerLegend().

QString QgsComposerLegend::title ( ) const

Definition at line 115 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::title().

Qt::AlignmentFlag QgsComposerLegend::titleAlignment ( ) const

Returns the alignment of the legend title.

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

Definition at line 117 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::titleAlignment().

virtual int QgsComposerLegend::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 46 of file qgscomposerlegend.h.

References QgsComposerItem::ComposerLegend.

void QgsComposerLegend::updateLegend ( )
double QgsComposerLegend::wmsLegendHeight ( ) const

Definition at line 148 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::wmsLegendSize().

double QgsComposerLegend::wmsLegendWidth ( ) const

Definition at line 145 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::wmsLegendSize().

QString QgsComposerLegend::wrapChar ( ) const

Definition at line 152 of file qgscomposerlegend.cpp.

References mSettings, and QgsLegendSettings::wrapChar().

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

Member Data Documentation

const QgsComposerMap* QgsComposerLegend::mComposerMap
private

Definition at line 158 of file qgscomposerlegend.h.

Referenced by invalidateCurrentMap(), paint(), readXML(), setComposerMap(), and writeXML().

QgsLegendModel QgsComposerLegend::mLegendModel
private
QgsLegendSettings QgsComposerLegend::mSettings
private

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