Quantum GIS API Documentation  1.7.5-Wroclaw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Slots | Public Member Functions | Protected Attributes | Private Member Functions
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]

List of all members.

Public Slots

void synchronizeWithModel ()
 Data changed.
void invalidateCurrentMap ()
 Sets mCompositionMap to 0 if the map is deleted.
- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
void repaint ()

Public Member Functions

 QgsComposerLegend (QgsComposition *composition)
 ~QgsComposerLegend ()
virtual int type () const
 return correct graphics item type.
void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint.
QSizeF paintAndDetermineSize (QPainter *painter)
 Paints the legend and calculates its size.
void adjustBoxSize ()
 Sets item box to the whole content.
QgsLegendModelmodel ()
 Returns pointer to the legend model.
void setTitle (const QString &t)
QString title () const
QFont titleFont () const
void setTitleFont (const QFont &f)
QFont groupFont () const
void setGroupFont (const QFont &f)
QFont layerFont () const
void setLayerFont (const QFont &f)
QFont itemFont () const
void setItemFont (const QFont &f)
double boxSpace () const
void setBoxSpace (double s)
double layerSpace () const
void setLayerSpace (double s)
double symbolSpace () const
void setSymbolSpace (double s)
double iconLabelSpace () const
void setIconLabelSpace (double s)
double symbolWidth () const
void setSymbolWidth (double w)
double symbolHeight () const
void setSymbolHeight (double h)
void setComposerMap (const QgsComposerMap *map)
const QgsComposerMapcomposerMap () const
void updateLegend ()
 Updates the model and all legend entries.
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom node
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document
- Public Member Functions inherited from QgsComposerItem
 QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
 Constructor.
 QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
 Constructor with box position and composer object.
virtual ~QgsComposerItem ()
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted.
virtual bool selected (void)
 Is selected.
virtual bool writeSettings (void)
 stores state in project
virtual bool readSettings (void)
 read state from project
virtual bool removeSettings (void)
 delete settings from project file
void move (double dx, double dy)
 Moves item in canvas coordinates.
virtual void moveContent (double dx, double dy)
 Move Content of item.
virtual void zoomContent (int delta, double x, double y)
 Zoom content of item.
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft)
 Moves the item to a new position (in canvas coordinates)
void setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft)
 Sets item position and width / height in one go.
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.
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document.
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document.
bool frame () const
void setFrame (bool drawFrame)
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default.
virtual void removeItems ()
const QgsCompositioncomposition () const
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command.
void endCommand ()
 Finish current command and push it onto the undo stack.
void cancelCommand ()
void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
 Draws Text.
void drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignement=Qt::AlignLeft, Qt::AlignmentFlag valignement=Qt::AlignTop) const
 Like the above, but with a rectangle for multiline text.
double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters.
double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double pixelFontSize (double pointSize) const
 Calculates font to from point size to pixel size.
QFont scaledFontPixelSize (const QFont &font) const
 Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.
void setPositionLock (bool lock)
 Locks / unlocks the item position for mouse drags.
bool positionLock () const
 Returns position lock for mouse drags (true means locked)
void updateCursor (const QPointF &itemPos)
 Update mouse cursor at (item) position.
double rotation () const

Protected Attributes

QString mTitle
QFont mTitleFont
QFont mGroupFont
QFont mLayerFont
QFont mItemFont
double mBoxSpace
 Space between item box and contents.
double mLayerSpace
 Vertical space between layer entries.
double mSymbolSpace
 Vertical space between symbol entries.
double mIconLabelSpace
 Horizontal space between item icon and label.
double mSymbolWidth
 Width of symbol icon.
double mSymbolHeight
 Height of symbol icon.
QgsLegendModel mLegendModel
const QgsComposerMapmComposerMap
 Reference to map (because symbols are sometimes in map units)
- Protected Attributes inherited from QgsComposerItem
QgsCompositionmComposition
QgsComposerItem::MouseMoveAction mCurrentMouseMoveAction
QPointF mMouseMoveStartPos
 Start point of the last mouse move action (in scene coordinates)
QPointF mLastMouseEventPos
 Position of the last mouse move event (in scene coordinates)
QGraphicsRectItem * mBoundingResizeRectangle
 Rectangle used during move and resize actions.
bool mFrame
 True if item fram needs to be painted.
bool mItemPositionLocked
 True if item position and size cannot be changed with mouse move.
double mLastValidViewScaleFactor
 Backup to restore item appearance if no view scale factor is available.
double mRotation
 Item rotation in degrees, clockwise.

Private Member Functions

 QgsComposerLegend ()
void drawGroupItem (QPainter *p, QgsComposerGroupItem *groupItem, double &currentYCoord, double &maxXCoord)
 Draws a group item and all subitems.
void drawLayerItem (QPainter *p, QgsComposerLayerItem *layerItem, double &currentYCoord, double &maxXCoord)
 Draws a layer item and all subitems.
void drawLayerChildItems (QPainter *p, QStandardItem *layerItem, double &currentYCoord, double &maxXCoord, int layerOpacity=255)
 Draws child items of a layer item.
void drawSymbol (QPainter *p, QgsSymbol *s, double currentYCoord, double &currentXPosition, double &symbolHeight, int layerOpacity=255) const
 Draws a symbol at the current y position and returns the new x position.
void drawSymbolV2 (QPainter *p, QgsSymbolV2 *s, double currentYCoord, double &currentXPosition, double &symbolHeight, int layerOpacity=255) const
void drawPointSymbol (QPainter *, QgsSymbol *s, double currentYCoord, double &currentXPosition, double &symbolHeight, int opacity=255) const
void drawLineSymbol (QPainter *, QgsSymbol *s, double currentYCoord, double &currentXPosition, int opacity=255) const
void drawPolygonSymbol (QPainter *p, QgsSymbol *s, double currentYCoord, double &currentXPosition, int opacity=255) const
QStringList layerIdList () const
 Helper function that lists ids of layers contained in map canvas.

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
}
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
}
- Signals inherited from QgsComposerItem
void rotationChanged (double newRotation)
 Is emitted on rotation change to notify north arrow pictures.
void itemChanged ()
 Used e.g.
- Protected Member Functions inherited from QgsComposerItem
virtual void mouseMoveEvent (QGraphicsSceneMouseEvent *event)
virtual void mousePressEvent (QGraphicsSceneMouseEvent *event)
virtual void mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
virtual void hoverMoveEvent (QGraphicsSceneHoverEvent *event)
Qt::CursorShape cursorForPosition (const QPointF &itemCoordPos)
 Finds out the appropriate cursor for the current mouse position in the widget (e.g.
QgsComposerItem::MouseMoveAction mouseMoveActionForPosition (const QPointF &itemCoordPos)
 Finds out which mouse move action to choose depending on the cursor position inside the widget.
void changeItemRectangle (const QPointF &currentPosition, const QPointF &mouseMoveStartPos, const QGraphicsRectItem *originalItem, double dx, double dy, QGraphicsRectItem *changeItem)
 Changes the rectangle of an item depending on current mouse action (resize or move)
virtual void drawSelectionBoxes (QPainter *p)
 Draw selection boxes around item.
virtual void drawFrame (QPainter *p)
 Draw black frame around item.
virtual void drawBackground (QPainter *p)
 Draw background.
void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead.
double angle (const QPointF &p1, const QPointF &p2) const
 Returns angle of the line from p1 to p2 (clockwise, starting at N)
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the \ item border for resizing.
double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size.
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view.
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.
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling.
QPointF pointOnLineWithDistance (const QPointF &startPoint, const QPointF &directionPoint, double distance) const
 Returns a point on the line from startPoint to directionPoint that is a certain distance away from the starting point.
void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle (mRotation)
void rotate (double angle, double &x, double &y) const
 Rotates a point / vector.

Detailed Description

A legend that can be placed onto a map composition.

Definition at line 33 of file qgscomposerlegend.h.


Constructor & Destructor Documentation

QgsComposerLegend::QgsComposerLegend ( QgsComposition composition)
QgsComposerLegend::~QgsComposerLegend ( )

Definition at line 59 of file qgscomposerlegend.cpp.

QgsComposerLegend::QgsComposerLegend ( )
private

Definition at line 54 of file qgscomposerlegend.cpp.


Member Function Documentation

void QgsComposerLegend::adjustBoxSize ( )
double QgsComposerLegend::boxSpace ( ) const
inline

Definition at line 72 of file qgscomposerlegend.h.

const QgsComposerMap* QgsComposerLegend::composerMap ( ) const
inline

Definition at line 91 of file qgscomposerlegend.h.

void QgsComposerLegend::drawGroupItem ( QPainter *  p,
QgsComposerGroupItem groupItem,
double &  currentYCoord,
double &  maxXCoord 
)
private
void QgsComposerLegend::drawLayerChildItems ( QPainter *  p,
QStandardItem *  layerItem,
double &  currentYCoord,
double &  maxXCoord,
int  layerOpacity = 255 
)
private

Draws child items of a layer item.

Parameters:
ppainter
layerItemparent model item (layer)
currentYCoordin/out: current y position of legend item
maxXCoordin/out: maximum x-coordinate of the whole legend
layerOpacityopacity of the corresponding map layer

Definition at line 245 of file qgscomposerlegend.cpp.

References QgsComposerRasterSymbolItem::color(), drawSymbol(), drawSymbolV2(), QgsComposerItem::drawText(), QgsComposerItem::fontHeightCharacterMM(), mBoxSpace, mIconLabelSpace, mItemFont, mSymbolHeight, mSymbolSpace, mSymbolWidth, QgsComposerSymbolItem::symbol(), QgsComposerSymbolV2Item::symbolV2(), and QgsComposerItem::textWidthMillimeters().

Referenced by drawLayerItem().

void QgsComposerLegend::drawLayerItem ( QPainter *  p,
QgsComposerLayerItem layerItem,
double &  currentYCoord,
double &  maxXCoord 
)
private
void QgsComposerLegend::drawLineSymbol ( QPainter *  p,
QgsSymbol s,
double  currentYCoord,
double &  currentXPosition,
int  opacity = 255 
) const
private

Definition at line 491 of file qgscomposerlegend.cpp.

References mSymbolHeight, mSymbolWidth, and QgsSymbol::pen().

Referenced by drawSymbol().

void QgsComposerLegend::drawPointSymbol ( QPainter *  p,
QgsSymbol s,
double  currentYCoord,
double &  currentXPosition,
double &  symbolHeight,
int  opacity = 255 
) const
private

Definition at line 454 of file qgscomposerlegend.cpp.

References QgsSymbol::getPointSymbolAsImage(), and QgsSymbol::pointSize().

Referenced by drawSymbol().

void QgsComposerLegend::drawPolygonSymbol ( QPainter *  p,
QgsSymbol s,
double  currentYCoord,
double &  currentXPosition,
int  opacity = 255 
) const
private
void QgsComposerLegend::drawSymbol ( QPainter *  p,
QgsSymbol s,
double  currentYCoord,
double &  currentXPosition,
double &  symbolHeight,
int  layerOpacity = 255 
) const
private

Draws a symbol at the current y position and returns the new x position.

Returns real symbol height, because for points, it is possible that it differs from mSymbolHeight

Definition at line 348 of file qgscomposerlegend.cpp.

References drawLineSymbol(), drawPointSymbol(), drawPolygonSymbol(), QGis::Line, mSymbolHeight, QGis::NoGeometry, QGis::Point, QGis::Polygon, QgsSymbol::type(), and QGis::UnknownGeometry.

Referenced by drawLayerChildItems().

void QgsComposerLegend::drawSymbolV2 ( QPainter *  p,
QgsSymbolV2 s,
double  currentYCoord,
double &  currentXPosition,
double &  symbolHeight,
int  layerOpacity = 255 
) const
private
QFont QgsComposerLegend::groupFont ( ) const

Definition at line 603 of file qgscomposerlegend.cpp.

References mGroupFont.

double QgsComposerLegend::iconLabelSpace ( ) const
inline

Definition at line 81 of file qgscomposerlegend.h.

void QgsComposerLegend::invalidateCurrentMap ( )
slot

Sets mCompositionMap to 0 if the map is deleted.

Definition at line 734 of file qgscomposerlegend.cpp.

References mComposerMap.

Referenced by setComposerMap().

QFont QgsComposerLegend::itemFont ( ) const

Definition at line 613 of file qgscomposerlegend.cpp.

References mItemFont.

QFont QgsComposerLegend::layerFont ( ) const

Definition at line 608 of file qgscomposerlegend.cpp.

References mLayerFont.

QStringList QgsComposerLegend::layerIdList ( ) const
private

Helper function that lists ids of layers contained in map canvas.

Definition at line 550 of file qgscomposerlegend.cpp.

References QgsMapRenderer::layerSet(), QgsComposition::mapRenderer(), and QgsComposerItem::mComposition.

Referenced by updateLegend().

double QgsComposerLegend::layerSpace ( ) const
inline

Definition at line 75 of file qgscomposerlegend.h.

QgsLegendModel* QgsComposerLegend::model ( )
inline

Returns pointer to the legend model.

Definition at line 54 of file qgscomposerlegend.h.

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

Reimplementation of QCanvasItem::paint.

Definition at line 64 of file qgscomposerlegend.cpp.

References paintAndDetermineSize().

QSizeF QgsComposerLegend::paintAndDetermineSize ( QPainter *  painter)
bool QgsComposerLegend::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
virtual
void QgsComposerLegend::setBoxSpace ( double  s)
inline

Definition at line 73 of file qgscomposerlegend.h.

void QgsComposerLegend::setComposerMap ( const QgsComposerMap map)

Definition at line 728 of file qgscomposerlegend.cpp.

References invalidateCurrentMap(), and mComposerMap.

Referenced by QgsComposerView::addComposerLegend().

void QgsComposerLegend::setGroupFont ( const QFont &  f)

Definition at line 577 of file qgscomposerlegend.cpp.

References adjustBoxSize(), and mGroupFont.

void QgsComposerLegend::setIconLabelSpace ( double  s)
inline

Definition at line 82 of file qgscomposerlegend.h.

void QgsComposerLegend::setItemFont ( const QFont &  f)

Definition at line 591 of file qgscomposerlegend.cpp.

References adjustBoxSize(), and mItemFont.

void QgsComposerLegend::setLayerFont ( const QFont &  f)

Definition at line 584 of file qgscomposerlegend.cpp.

References adjustBoxSize(), and mLayerFont.

void QgsComposerLegend::setLayerSpace ( double  s)
inline

Definition at line 76 of file qgscomposerlegend.h.

void QgsComposerLegend::setSymbolHeight ( double  h)
inline

Definition at line 88 of file qgscomposerlegend.h.

void QgsComposerLegend::setSymbolSpace ( double  s)
inline

Definition at line 79 of file qgscomposerlegend.h.

void QgsComposerLegend::setSymbolWidth ( double  w)
inline

Definition at line 85 of file qgscomposerlegend.h.

void QgsComposerLegend::setTitle ( const QString &  t)
inline

Definition at line 57 of file qgscomposerlegend.h.

void QgsComposerLegend::setTitleFont ( const QFont &  f)

Definition at line 570 of file qgscomposerlegend.cpp.

References adjustBoxSize(), and mTitleFont.

double QgsComposerLegend::symbolHeight ( ) const
inline

Definition at line 87 of file qgscomposerlegend.h.

double QgsComposerLegend::symbolSpace ( ) const
inline

Definition at line 78 of file qgscomposerlegend.h.

double QgsComposerLegend::symbolWidth ( ) const
inline

Definition at line 84 of file qgscomposerlegend.h.

void QgsComposerLegend::synchronizeWithModel ( )
slot

Data changed.

Definition at line 564 of file qgscomposerlegend.cpp.

References adjustBoxSize().

Referenced by QgsComposerLegend().

QString QgsComposerLegend::title ( ) const
inline

Definition at line 58 of file qgscomposerlegend.h.

QFont QgsComposerLegend::titleFont ( ) const

Definition at line 598 of file qgscomposerlegend.cpp.

References mTitleFont.

virtual int QgsComposerLegend::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 42 of file qgscomposerlegend.h.

References QgsComposerItem::ComposerLegend.

Referenced by drawGroupItem(), and paintAndDetermineSize().

void QgsComposerLegend::updateLegend ( )

Updates the model and all legend entries.

Definition at line 618 of file qgscomposerlegend.cpp.

References adjustBoxSize(), layerIdList(), mLegendModel, and QgsLegendModel::setLayerSet().

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

stores state in Dom node

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

Implements QgsComposerItem.

Definition at line 625 of file qgscomposerlegend.cpp.

References QgsComposerItem::_writeXML(), QgsComposerMap::id(), mBoxSpace, mComposerMap, mGroupFont, mIconLabelSpace, mItemFont, mLayerFont, mLayerSpace, mLegendModel, mSymbolHeight, mSymbolSpace, mSymbolWidth, mTitle, mTitleFont, and QgsLegendModel::writeXML().


Member Data Documentation

double QgsComposerLegend::mBoxSpace
protected

Space between item box and contents.

Definition at line 124 of file qgscomposerlegend.h.

Referenced by drawGroupItem(), drawLayerChildItems(), drawLayerItem(), paintAndDetermineSize(), readXML(), and writeXML().

const QgsComposerMap* QgsComposerLegend::mComposerMap
protected

Reference to map (because symbols are sometimes in map units)

Definition at line 139 of file qgscomposerlegend.h.

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

QFont QgsComposerLegend::mGroupFont
protected
double QgsComposerLegend::mIconLabelSpace
protected

Horizontal space between item icon and label.

Definition at line 130 of file qgscomposerlegend.h.

Referenced by drawLayerChildItems(), readXML(), and writeXML().

QFont QgsComposerLegend::mItemFont
protected
QFont QgsComposerLegend::mLayerFont
protected
double QgsComposerLegend::mLayerSpace
protected

Vertical space between layer entries.

Definition at line 126 of file qgscomposerlegend.h.

Referenced by drawGroupItem(), drawLayerItem(), readXML(), and writeXML().

QgsLegendModel QgsComposerLegend::mLegendModel
protected
double QgsComposerLegend::mSymbolHeight
protected
double QgsComposerLegend::mSymbolSpace
protected

Vertical space between symbol entries.

Definition at line 128 of file qgscomposerlegend.h.

Referenced by drawLayerChildItems(), drawLayerItem(), readXML(), and writeXML().

double QgsComposerLegend::mSymbolWidth
protected
QString QgsComposerLegend::mTitle
protected

Definition at line 115 of file qgscomposerlegend.h.

Referenced by paintAndDetermineSize(), readXML(), and writeXML().

QFont QgsComposerLegend::mTitleFont
protected

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