Quantum GIS API Documentation
1.7.5-Wroclaw
|
A label that can be placed onto a map composition. More...
#include <qgscomposerlabel.h>
Public Member Functions | |
QgsComposerLabel (QgsComposition *composition) | |
~QgsComposerLabel () | |
virtual int | type () const |
return correct graphics item type. | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) |
Reimplementation of QCanvasItem::paint. | |
void | adjustSizeToText () |
resizes the widget such that the text fits to the item. | |
QString | text () |
void | setText (const QString &text) |
QString | displayText () const |
Returns the text as it appears on screen (with replaced data field) | |
QFont | font () const |
void | setFont (const QFont &f) |
Qt::AlignmentFlag | vAlign () const |
Qt::AlignmentFlag | hAlign () const |
void | setHAlign (Qt::AlignmentFlag a) |
void | setVAlign (Qt::AlignmentFlag a) |
double | margin () |
void | setMargin (double m) |
void | setFontColor (const QColor &c) |
Sets text color. | |
QColor | fontColor () const |
Get font color. | |
bool | writeXML (QDomElement &elem, QDomDocument &doc) const |
stores state in Dom element | |
bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) |
sets state from Dom document | |
QString | id () const |
Get label identification number. | |
void | setId (const QString &id) |
Set label identification number. | |
![]() | |
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 QgsComposition * | composition () 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 |
Private Member Functions | |
void | replaceDateText (QString &text) const |
Replaces replace '$CURRENT_DATE<(FORMAT)>' with the current date (e.g. |
Private Attributes | |
QString | mText |
QFont | mFont |
double | mMargin |
QColor | mFontColor |
Qt::AlignmentFlag | mHAlignment |
Qt::AlignmentFlag | mVAlignment |
QString | mId |
Additional Inherited Members | |
![]() | |
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 } |
![]() | |
virtual void | setRotation (double r) |
void | repaint () |
![]() | |
void | rotationChanged (double newRotation) |
Is emitted on rotation change to notify north arrow pictures. | |
void | itemChanged () |
Used e.g. | |
![]() | |
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 ¤tPosition, 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. | |
![]() | |
QgsComposition * | mComposition |
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. |
A label that can be placed onto a map composition.
Definition at line 25 of file qgscomposerlabel.h.
QgsComposerLabel::QgsComposerLabel | ( | QgsComposition * | composition | ) |
Definition at line 23 of file qgscomposerlabel.cpp.
References mFont.
QgsComposerLabel::~QgsComposerLabel | ( | ) |
Definition at line 30 of file qgscomposerlabel.cpp.
void QgsComposerLabel::adjustSizeToText | ( | ) |
resizes the widget such that the text fits to the item.
Keeps top left point
Definition at line 100 of file qgscomposerlabel.cpp.
References displayText(), QgsComposerItem::fontAscentMillimeters(), mFont, mMargin, QgsComposerItem::setSceneRect(), and QgsComposerItem::textWidthMillimeters().
Referenced by QgsComposerView::mousePressEvent().
QString QgsComposerLabel::displayText | ( | ) | const |
Returns the text as it appears on screen (with replaced data field)
Definition at line 67 of file qgscomposerlabel.cpp.
References mText, and replaceDateText().
Referenced by adjustSizeToText(), and paint().
QFont QgsComposerLabel::font | ( | ) | const |
Definition at line 109 of file qgscomposerlabel.cpp.
References mFont.
|
inline |
Get font color.
Definition at line 61 of file qgscomposerlabel.h.
|
inline |
Definition at line 50 of file qgscomposerlabel.h.
|
inline |
Get label identification number.
Definition at line 77 of file qgscomposerlabel.h.
|
inline |
Definition at line 53 of file qgscomposerlabel.h.
void QgsComposerLabel::paint | ( | QPainter * | painter, |
const QStyleOptionGraphicsItem * | itemStyle, | ||
QWidget * | pWidget | ||
) |
Reimplementation of QCanvasItem::paint.
Definition at line 34 of file qgscomposerlabel.cpp.
References displayText(), QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), QgsComposerItem::drawSelectionBoxes(), QgsComposerItem::drawText(), mFont, mFontColor, mHAlignment, mMargin, and mVAlignment.
|
virtual |
sets state from Dom document
itemElem | is Dom element corresponding to 'ComposerLabel' tag |
doc | document |
Implements QgsComposerItem.
Definition at line 149 of file qgscomposerlabel.cpp.
References QgsComposerItem::_readXML(), QgsComposerItem::itemChanged(), mFont, mFontColor, mHAlignment, mId, mMargin, mText, and mVAlignment.
|
private |
Replaces replace '$CURRENT_DATE<(FORMAT)>' with the current date (e.g.
$CURRENT_DATE(d 'June' yyyy)
Definition at line 74 of file qgscomposerlabel.cpp.
Referenced by displayText().
void QgsComposerLabel::setFont | ( | const QFont & | f | ) |
Definition at line 95 of file qgscomposerlabel.cpp.
References mFont.
|
inline |
Sets text color.
Definition at line 58 of file qgscomposerlabel.h.
|
inline |
Definition at line 51 of file qgscomposerlabel.h.
|
inline |
Set label identification number.
Definition at line 81 of file qgscomposerlabel.h.
|
inline |
Definition at line 54 of file qgscomposerlabel.h.
void QgsComposerLabel::setText | ( | const QString & | text | ) |
Definition at line 62 of file qgscomposerlabel.cpp.
Referenced by QgsComposerView::mousePressEvent().
|
inline |
Definition at line 52 of file qgscomposerlabel.h.
|
inline |
Definition at line 40 of file qgscomposerlabel.h.
Referenced by setText().
|
inlinevirtual |
return correct graphics item type.
Added in v1.7
Reimplemented from QgsComposerItem.
Definition at line 32 of file qgscomposerlabel.h.
References QgsComposerItem::ComposerLabel.
|
inline |
Definition at line 49 of file qgscomposerlabel.h.
|
virtual |
stores state in Dom element
elem | is Dom element corresponding to 'Composer' tag |
doc | document |
Implements QgsComposerItem.
Definition at line 114 of file qgscomposerlabel.cpp.
References QgsComposerItem::_writeXML(), mFont, mFontColor, mHAlignment, mId, mMargin, mText, and mVAlignment.
|
private |
Definition at line 88 of file qgscomposerlabel.h.
Referenced by adjustSizeToText(), font(), paint(), QgsComposerLabel(), readXML(), setFont(), and writeXML().
|
private |
Definition at line 94 of file qgscomposerlabel.h.
Referenced by paint(), readXML(), and writeXML().
|
private |
Definition at line 97 of file qgscomposerlabel.h.
Referenced by paint(), readXML(), and writeXML().
|
private |
Definition at line 103 of file qgscomposerlabel.h.
Referenced by readXML(), and writeXML().
|
private |
Definition at line 91 of file qgscomposerlabel.h.
Referenced by adjustSizeToText(), paint(), readXML(), and writeXML().
|
private |
Definition at line 85 of file qgscomposerlabel.h.
Referenced by displayText(), readXML(), setText(), and writeXML().
|
private |
Definition at line 100 of file qgscomposerlabel.h.
Referenced by paint(), readXML(), and writeXML().