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

A container for grouping several QgsComposerItems. More...

#include <qgscomposeritemgroup.h>

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

Public Slots

void itemDestroyed ()
 
- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
 Sets the item rotation. More...
 
virtual void setItemRotation (double r, bool adjustPosition=false)
 Sets the item rotation. More...
 
void repaint ()
 

Signals

void childItemDeleted (QgsComposerItem *item)
 
- Signals inherited from QgsComposerItem
void itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void itemChanged ()
 Used e.g. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 

Public Member Functions

 QgsComposerItemGroup (QgsComposition *c)
 
 ~QgsComposerItemGroup ()
 
virtual int type () const
 return correct graphics item type. More...
 
void addItem (QgsComposerItem *item)
 Adds an item to the group. More...
 
void removeItems ()
 Removes the items but does not delete them. More...
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=0)
 Draw outline and ev. More...
 
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 &elem, QDomDocument &doc) const
 stores state in Dom node More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document More...
 
QSet< QgsComposerItem * > items ()
 
- 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 void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
virtual bool selected () const
 Is selected. More...
 
virtual bool writeSettings ()
 stores state in project More...
 
virtual bool readSettings ()
 read state from project More...
 
virtual bool removeSettings ()
 delete settings from project file 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...
 
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft)
 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)
 Sets item position and width / height in one go. More...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. 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 (bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
virtual void setFrameOutlineWidth (double outlineWidth)
 Sets frame outline width. More...
 
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame. More...
 
void setFrameJoinStyle (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 (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 (QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
int transparency () const
 Returns the item's transparency. More...
 
void setTransparency (int transparency)
 Sets the item's transparency. More...
 
bool effectsEnabled () const
 Returns true if effects (eg blend modes) are enabled for the item. More...
 
void setEffectsEnabled (bool effectsEnabled)
 Sets whether effects (eg blend modes) are enabled for the item. More...
 
const QgsCompositioncomposition () const
 
QgsCompositioncomposition ()
 
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 ()
 
void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
 Draws Text. More...
 
void drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop) const
 Like the above, but with a rectangle for multiline text. More...
 
double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters. More...
 
double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
double fontDescentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
double pixelFontSize (double pointSize) const
 Calculates font to from point size to pixel size. More...
 
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 (bool lock)
 Locks / unlocks the item position for mouse drags. More...
 
bool positionLock () const
 Returns position lock for mouse drags (true means locked) More...
 
double itemRotation () const
 Returns the rotation for the composer item. More...
 
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 int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
virtual void setCurrentExportLayer (int layerIdx=-1)
 Sets the current layer to draw for exporting. More...
 

Protected Member Functions

void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
- Protected Member Functions inherited from QgsComposerItem
virtual void drawSelectionBoxes (QPainter *p)
 Draw selection boxes around item. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
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...
 
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...
 
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...
 
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...
 
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...
 
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
 Calculates corner point after rotation and scaling. More...
 
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling. More...
 
void sizeChangedByRotation (double &width, double &height, double rotation)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle. More...
 
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 ()
 

Private Attributes

QSet< QgsComposerItem * > mItems
 
QRectF mBoundingRectangle
 

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
}
 
- Protected Attributes inherited from QgsComposerItem
QgsCompositionmComposition
 
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...
 
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...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 

Detailed Description

A container for grouping several QgsComposerItems.

Definition at line 24 of file qgscomposeritemgroup.h.

Constructor & Destructor Documentation

QgsComposerItemGroup::QgsComposerItemGroup ( QgsComposition c)

Definition at line 25 of file qgscomposeritemgroup.cpp.

QgsComposerItemGroup::~QgsComposerItemGroup ( )

Definition at line 32 of file qgscomposeritemgroup.cpp.

References QgsComposerItem::mComposition, and mItems.

Member Function Documentation

void QgsComposerItemGroup::addItem ( QgsComposerItem item)
virtual

Adds an item to the group.

All the group members are deleted if the group is deleted

Reimplemented from QgsComposerItem.

Definition at line 45 of file qgscomposeritemgroup.cpp.

References itemDestroyed(), QgsComposerItem::itemRotation(), mBoundingRectangle, mItems, QgsComposerItem::setItemRotation(), QgsComposerItem::setSceneRect(), and QgsComposerItem::setSelected().

Referenced by QgsComposerView::groupItems(), and readXML().

void QgsComposerItemGroup::childItemDeleted ( QgsComposerItem item)
signal
void QgsComposerItemGroup::drawFrame ( QPainter *  p)
protectedvirtual

Draw black frame around item.

Reimplemented from QgsComposerItem.

Definition at line 146 of file qgscomposeritemgroup.cpp.

References QgsComposerItem::mComposition, QgsComposerItem::mFrame, QgsComposition::plotStyle(), and QgsComposition::Preview.

Referenced by paint().

void QgsComposerItemGroup::itemDestroyed ( )
slot

Definition at line 109 of file qgscomposeritemgroup.cpp.

References mItems.

Referenced by addItem().

QSet<QgsComposerItem*> QgsComposerItemGroup::items ( )
inline
void QgsComposerItemGroup::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget *  widget = 0 
)

Draw outline and ev.

selection handles

Definition at line 114 of file qgscomposeritemgroup.cpp.

References drawFrame(), and QgsComposerItem::drawSelectionBoxes().

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

sets state from Dom document

Parameters
itemElemis Dom node corresponding to item tag
docis the Dom document

Implements QgsComposerItem.

Definition at line 181 of file qgscomposeritemgroup.cpp.

References QgsComposerItem::_readXML(), addItem(), items(), QgsComposerItem::mComposition, QgsComposerItem::mTemplateUuid, QgsComposerItem::mUuid, and QgsComposerItem::uuid().

Referenced by QgsComposition::addItemsFromXML().

void QgsComposerItemGroup::removeItems ( )
virtual

Removes the items but does not delete them.

Reimplemented from QgsComposerItem.

Definition at line 98 of file qgscomposeritemgroup.cpp.

References mItems.

Referenced by QgsComposerView::ungroupItems().

void QgsComposerItemGroup::setSceneRect ( const QRectF &  rectangle)
virtual

Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.

Reimplemented from QgsComposerItem.

Definition at line 125 of file qgscomposeritemgroup.cpp.

References mItems, QgsComposition::relativeResizeRect(), and QgsComposerItem::setSceneRect().

virtual int QgsComposerItemGroup::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 32 of file qgscomposeritemgroup.h.

References QgsComposerItem::ComposerItemGroup.

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

stores state in Dom node

Parameters
elemis Dom element corresponding to 'Composer' tag
docis the Dom document

Implements QgsComposerItem.

Definition at line 164 of file qgscomposeritemgroup.cpp.

References QgsComposerItem::_writeXML(), and mItems.

Member Data Documentation

QRectF QgsComposerItemGroup::mBoundingRectangle
private

Definition at line 70 of file qgscomposeritemgroup.h.

Referenced by addItem().

QSet<QgsComposerItem*> QgsComposerItemGroup::mItems
private

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