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

Signals

void childItemDeleted (QgsComposerItem *item)
 
- Signals inherited from QgsComposerItem
void rotationChanged (double newRotation)
 Is emitted on rotation change to notify north arrow pictures. More...
 
void itemChanged ()
 Used e.g. 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...
 
void resize (double dx, double dy)
 resizes an item in x- and y direction (scene coordinates) 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 (void)
 Is selected. More...
 
virtual bool writeSettings (void)
 stores state in project More...
 
virtual bool readSettings (void)
 read state from project More...
 
virtual bool removeSettings (void)
 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)
 Sets item position and width / height in one go. 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 frame () const
 
void setFrame (bool drawFrame)
 
const QgsCompositioncomposition () const
 
void beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
 Starts new composer undo command. More...
 
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 halignement=Qt::AlignLeft, Qt::AlignmentFlag valignement=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 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...
 
void updateCursor (const QPointF &itemPos)
 Update mouse cursor at (item) position. More...
 
double rotation () const
 

Protected Member Functions

void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
- 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. More...
 
QgsComposerItem::MouseMoveAction mouseMoveActionForPosition (const QPointF &itemCoordPos)
 Finds out which mouse move action to choose depending on the cursor position inside the widget. More...
 
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) More...
 
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) const
 Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...
 
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling. More...
 
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. More...
 
void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle (mRotation) More...
 
void rotate (double angle, double &x, double &y) const
 Rotates a point / vector. More...
 

Private Attributes

QSet< QgsComposerItem * > mItems
 
QRectF mSceneBoundingRectangle
 

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
}
 
- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
 
void repaint ()
 
- 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...
 
bool mFrame
 True if item fram needs to be painted. 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 mRotation
 Item rotation in degrees, clockwise. 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 23 of file qgscomposeritemgroup.cpp.

QgsComposerItemGroup::~QgsComposerItemGroup ( )

Definition at line 29 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 42 of file qgscomposeritemgroup.cpp.

References mItems, mSceneBoundingRectangle, QgsComposerItem::setSceneRect(), and QgsComposerItem::setSelected().

Referenced by QgsComposerView::groupItems().

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

Draw black frame around item.

Reimplemented from QgsComposerItem.

Definition at line 152 of file qgscomposeritemgroup.cpp.

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

Referenced by paint().

QSet<QgsComposerItem*> QgsComposerItemGroup::items ( )
inline

Definition at line 59 of file qgscomposeritemgroup.h.

Referenced by QgsComposerView::keyPressEvent().

void QgsComposerItemGroup::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget *  widget = 0 
)

Draw outline and ev.

selection handles

Definition at line 106 of file qgscomposeritemgroup.cpp.

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

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

sets state from Dom document

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

Implements QgsComposerItem.

Definition at line 57 of file qgscomposeritemgroup.h.

void QgsComposerItemGroup::removeItems ( )
virtual

Removes the items but does not delete them.

Reimplemented from QgsComposerItem.

Definition at line 95 of file qgscomposeritemgroup.cpp.

References mItems.

Referenced by QgsComposerView::ungroupItems().

void QgsComposerItemGroup::resize ( double  dx,
double  dy 
)

resizes an item in x- and y direction (scene coordinates)

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 115 of file qgscomposeritemgroup.cpp.

References mItems, 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
inlinevirtual

stores state in Dom node

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

Implements QgsComposerItem.

Definition at line 51 of file qgscomposeritemgroup.h.

Member Data Documentation

QSet<QgsComposerItem*> QgsComposerItemGroup::mItems
private

Definition at line 68 of file qgscomposeritemgroup.h.

Referenced by addItem(), removeItems(), setSceneRect(), and ~QgsComposerItemGroup().

QRectF QgsComposerItemGroup::mSceneBoundingRectangle
private

Definition at line 69 of file qgscomposeritemgroup.h.

Referenced by addItem().


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