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

#include <qgscomposerlabel.h>

Inheritance diagram for QgsComposerLabel:

Collaboration diagram for QgsComposerLabel:

Public Slots
virtual void	setRotation (double r)
Public Member Functions
	QgsComposerLabel (QgsComposition *composition)
	~QgsComposerLabel ()
void	adjustSizeToText ()
	resizes the widget such that the text fits to the item.
QString	displayText () const
	Returns the text as it appears on screen (with replaced data field)
QFont	font () const
QColor	fontColor () const
	Get font color.
Qt::AlignmentFlag	hAlign () const
	Accessor for the horizontal alignment of the label.
int	htmlState ()
double	margin ()
	brief Accessor for the margin of the label
void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget)
	Reimplementation of QCanvasItem::paint.
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	sets state from Dom document
void	setExpressionContext (QgsFeature feature, QgsVectorLayer layer, QMap< QString, QVariant > substitutions=(QMap< QString, QVariant >()))
	Sets the current feature, the current layer and a list of local variable substitutions for evaluating expressions.
void	setFont (const QFont &f)
void	setFontColor (const QColor &c)
	Sets text color.
void	setHAlign (Qt::AlignmentFlag a)
	Mutator for the horizontal alignment of the label.
void	setHtmlState (int state)
void	setMargin (double m)
	brief Mutator for the margin of the label
void	setSceneRect (const QRectF &rectangle)
	Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.
void	setText (const QString &text)
void	setVAlign (Qt::AlignmentFlag a)
	Mutator for the vertical alignment of the label.
QString	text ()
virtual int	type () const
	return correct graphics item type.
Qt::AlignmentFlag	vAlign () const
	Accessor for the vertical alignment of the label.
bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	stores state in Dom element
Private Slots
void	loadingHtmlFinished (bool)
Private Member Functions
double	htmlUnitsToMM ()
void	itemShiftAdjustSize (double newWidth, double newHeight, double &xShift, double &yShift) const
	Helper function to calculate x/y shift for adjustSizeToText() depending on rotation, current size and alignment.
void	replaceDateText (QString &text) const
	Replaces replace '$CURRENT_DATE<(FORMAT)>' with the current date (e.g.
Private Attributes
QgsFeature *	mExpressionFeature
QgsVectorLayer *	mExpressionLayer
QFont	mFont
QColor	mFontColor
Qt::AlignmentFlag	mHAlignment
bool	mHtmlLoaded
int	mHtmlState
double	mHtmlUnitsToMM
double	mMargin
QMap< QString, QVariant >	mSubstitutions
QString	mText
double	mTextBoxHeight
	Height of the text box.
double	mTextBoxWidth
	Width of the text box.
Qt::AlignmentFlag	mVAlignment

Detailed Description

A label that can be placed onto a map composition.

Definition at line 29 of file qgscomposerlabel.h.

Constructor & Destructor Documentation

QgsComposerLabel::QgsComposerLabel ( QgsComposition * composition )

Definition at line 29 of file qgscomposerlabel.cpp.

References htmlUnitsToMM(), mFont, and mHtmlUnitsToMM.

QgsComposerLabel::~QgsComposerLabel ( )

Definition at line 40 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 212 of file qgscomposerlabel.cpp.

References displayText(), QgsComposerItem::fontAscentMillimeters(), itemShiftAdjustSize(), mFont, mMargin, mTextBoxHeight, mTextBoxWidth, setSceneRect(), QgsComposerItem::sizeChangedByRotation(), 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 173 of file qgscomposerlabel.cpp.

References QgsComposition::itemPageNumber(), QgsComposerItem::mComposition, mExpressionFeature, mExpressionLayer, mSubstitutions, mText, replaceDateText(), and QgsExpression::replaceExpressionText().

Referenced by adjustSizeToText(), and paint().

QFont QgsComposerLabel::font ( ) const

Definition at line 233 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 88 of file qgscomposerlabel.h.

Qt::AlignmentFlag QgsComposerLabel::hAlign ( ) const [inline]

Accessor for the horizontal alignment of the label.

Returns:: Qt::AlignmentFlag

Definition at line 67 of file qgscomposerlabel.h.

int QgsComposerLabel::htmlState ( ) [inline]

Definition at line 48 of file qgscomposerlabel.h.

double QgsComposerLabel::htmlUnitsToMM ( ) [private]

Definition at line 147 of file qgscomposerlabel.cpp.

References QgsComposerItem::mComposition, and QgsComposition::printResolution().

Referenced by QgsComposerLabel().

void QgsComposerLabel::itemShiftAdjustSize	(	double	newWidth,
		double	newHeight,
		double &	xShift,
		double &	yShift
	)		const `[private]`

Helper function to calculate x/y shift for adjustSizeToText() depending on rotation, current size and alignment.

Definition at line 358 of file qgscomposerlabel.cpp.

References mHAlignment, QgsComposerItem::mRotation, and mVAlignment.

Referenced by adjustSizeToText().

void QgsComposerLabel::loadingHtmlFinished ( bool result ) [private, slot]

Definition at line 141 of file qgscomposerlabel.cpp.

References mHtmlLoaded.

Referenced by paint().

double QgsComposerLabel::margin ( ) [inline]

brief Accessor for the margin of the label

Definition at line 79 of file qgscomposerlabel.h.

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

Reimplementation of QCanvasItem::paint.

Definition at line 44 of file qgscomposerlabel.cpp.

References displayText(), QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), QgsComposerItem::drawSelectionBoxes(), QgsComposerItem::drawText(), loadingHtmlFinished(), QgsComposerItem::mComposition, mFont, mFontColor, mHAlignment, mHtmlLoaded, mHtmlState, mHtmlUnitsToMM, mMargin, QgsComposerItem::mRotation, mTextBoxHeight, mTextBoxWidth, mVAlignment, QgsComposition::plotStyle(), QgsComposition::Postscript, and QgsComposition::Print.

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 298 of file qgscomposerlabel.cpp.

References QgsComposerItem::_readXML(), QgsComposerItem::itemChanged(), mFont, mFontColor, mHAlignment, mHtmlState, 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 182 of file qgscomposerlabel.cpp.

Referenced by displayText().

void QgsComposerLabel::setExpressionContext	(	QgsFeature *	feature,
		QgsVectorLayer *	layer,
		QMap< QString, QVariant >	substitutions = `( QMap<QString, QVariant>() )`
	)