QgsComposerLabel Class Reference

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

#include <qgscomposerlabel.h>

Inheritance diagram for QgsComposerLabel:

Collaboration diagram for QgsComposerLabel:

List of all members.

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
	Accessor for the vertical alignment of the label.
Qt::AlignmentFlag	hAlign () const
	Accessor for the horizontal alignment of the label.
void	setHAlign (Qt::AlignmentFlag a)
	Mutator for the horizontal alignment of the label.
void	setVAlign (Qt::AlignmentFlag a)
	Mutator for the vertical alignment of the label.
double	margin ()
	brief Accessor for the margin of the label
void	setMargin (double m)
	brief Mutator for the margin of the label
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
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

---

Detailed Description

A label that can be placed onto a map composition.

Definition at line 25 of file qgscomposerlabel.h.

---

Constructor & Destructor Documentation

QgsComposerLabel::QgsComposerLabel

(

QgsComposition *

composition

)

Definition at line 23 of file qgscomposerlabel.cpp.

References mFont.

QgsComposerLabel::~QgsComposerLabel

(

)

Definition at line 30 of file qgscomposerlabel.cpp.

---

Member Function Documentation

void QgsComposerLabel::adjustSizeToText

(

)

resizes the widget such that the text fits to the item.

Keeps top left point

Definition at line 102 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)

Note:

this function was added in version 1.2

Definition at line 69 of file qgscomposerlabel.cpp.

References mText, and replaceDateText().

Referenced by adjustSizeToText(), and paint().

QFont QgsComposerLabel::font

(

)

const

Definition at line 111 of file qgscomposerlabel.cpp.

References mFont.

QColor QgsComposerLabel::fontColor

(

)

const [inline]

Get font color.

Note:

: this function was added in version 1.4

Definition at line 77 of file qgscomposerlabel.h.

Qt::AlignmentFlag QgsComposerLabel::hAlign

(

)

const [inline]

Accessor for the horizontal alignment of the label.

Returns:

Qt::AlignmentFlag

Definition at line 56 of file qgscomposerlabel.h.

double QgsComposerLabel::margin

(

)

[inline]

brief Accessor for the margin of the label

Definition at line 68 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.

bool QgsComposerLabel::readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)		[virtual]

sets state from Dom document

Parameters:

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, mMargin, mText, and mVAlignment.

Referenced by QgsComposition::addItemsFromXML().

void QgsComposerLabel::replaceDateText

(

QString &

text

)

const [private]

Replaces replace '$CURRENT_DATE<(FORMAT)>' with the current date (e.g.

$CURRENT_DATE(d 'June' yyyy)

Definition at line 76 of file qgscomposerlabel.cpp.

Referenced by displayText().

void QgsComposerLabel::setFont

(

const QFont &

f

)

Definition at line 97 of file qgscomposerlabel.cpp.

References mFont.

void QgsComposerLabel::setFontColor

(

const QColor &

c

)

[inline]

Sets text color.

Note:

: this function was added in version 1.4

Definition at line 74 of file qgscomposerlabel.h.

void QgsComposerLabel::setHAlign

(

Qt::AlignmentFlag

a

)

[inline]

Mutator for the horizontal alignment of the label.

Parameters:

a

alignment

Returns:

void

Definition at line 61 of file qgscomposerlabel.h.

void QgsComposerLabel::setMargin

(

double

m

)

[inline]

brief Mutator for the margin of the label

Definition at line 70 of file qgscomposerlabel.h.

void QgsComposerLabel::setText

(

const QString &

text

)

Definition at line 64 of file qgscomposerlabel.cpp.

References mText, and text().

Referenced by QgsComposerView::mousePressEvent().

void QgsComposerLabel::setVAlign

(

Qt::AlignmentFlag

a

)

[inline]

Mutator for the vertical alignment of the label.

Parameters:

a

alignment

Returns:

void

Definition at line 66 of file qgscomposerlabel.h.

QString QgsComposerLabel::text

(

void

)

[inline]

Definition at line 40 of file qgscomposerlabel.h.

Referenced by setText().

virtual int QgsComposerLabel::type

(

)

const [inline, virtual]

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Definition at line 32 of file qgscomposerlabel.h.

References QgsComposerItem::ComposerLabel.

Qt::AlignmentFlag QgsComposerLabel::vAlign

(

)

const [inline]

Accessor for the vertical alignment of the label.

Returns:

Qt::AlignmentFlag

Definition at line 52 of file qgscomposerlabel.h.

bool QgsComposerLabel::writeXML	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const [virtual]

stores state in Dom element

Parameters:

elem	is Dom element corresponding to 'Composer' tag
doc	document

Implements QgsComposerItem.

Definition at line 116 of file qgscomposerlabel.cpp.

References QgsComposerItem::_writeXML(), mFont, mFontColor, mHAlignment, mMargin, mText, and mVAlignment.

---

Member Data Documentation

QFont QgsComposerLabel::mFont [private]

Definition at line 96 of file qgscomposerlabel.h.

Referenced by adjustSizeToText(), font(), paint(), QgsComposerLabel(), readXML(), setFont(), and writeXML().

QColor QgsComposerLabel::mFontColor [private]

Definition at line 102 of file qgscomposerlabel.h.

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

Qt::AlignmentFlag QgsComposerLabel::mHAlignment [private]

Definition at line 105 of file qgscomposerlabel.h.

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

double QgsComposerLabel::mMargin [private]

Definition at line 99 of file qgscomposerlabel.h.

Referenced by adjustSizeToText(), paint(), readXML(), and writeXML().

QString QgsComposerLabel::mText [private]

Definition at line 93 of file qgscomposerlabel.h.

Referenced by displayText(), readXML(), setText(), and writeXML().

Qt::AlignmentFlag QgsComposerLabel::mVAlignment [private]

Definition at line 108 of file qgscomposerlabel.h.

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

---

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

• src/core/composer/qgscomposerlabel.h
• src/core/composer/qgscomposerlabel.cpp