A base class for objects which belong to a map composition. More...

#include <qgscomposerobject.h>

Inheritance diagram for QgsComposerObject:

Public Types
enum	DataDefinedProperty { NoProperty = 0, AllProperties, TestProperty, PresetPaperSize, PaperWidth, PaperHeight, NumPages, PaperOrientation, PageNumber, PositionX, PositionY, ItemWidth, ItemHeight, ItemRotation, Transparency, BlendMode, ExcludeFromExports, MapRotation, MapScale, MapXMin, MapYMin, MapXMax, MapYMax, MapAtlasMargin, PictureSource, SourceUrl }
	Data defined properties for different item types. More...
enum	PropertyValueType { EvaluatedValue = 0, OriginalValue }
	Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...

Public Slots
virtual void	refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties)
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.
virtual void	repaint ()
	Triggers a redraw for the item.

Signals
void	itemChanged ()
	Emitted when the item changes.

Public Member Functions
	QgsComposerObject (QgsComposition *composition)
	Constructor.
virtual	~QgsComposerObject ()
const QgsComposition *	composition () const
	Returns the composition the item is attached to.
QgsComposition *	composition ()
QgsDataDefined *	dataDefinedProperty (const DataDefinedProperty property) const
	Returns a reference to the data defined settings for one of the item's data defined properties.
virtual bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Sets item state from DOM element.
void	setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field)
	Sets parameters for a data defined property for the item.
virtual bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	Stores item state in DOM element.

Protected Member Functions
bool	dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
	Evaluate a data defined property and return the calculated value.

Protected Attributes
QgsComposition *	mComposition
QMap < QgsComposerObject::DataDefinedProperty, QString >	mDataDefinedNames
	Map of data defined properties for the item to string name to use when exporting item to xml.

Friends
class	TestQgsComposerObject

Detailed Description

A base class for objects which belong to a map composition.

Definition at line 33 of file qgscomposerobject.h.

Member Enumeration Documentation

enum QgsComposerObject::DataDefinedProperty

Data defined properties for different item types.

Enumerator:

NoProperty
AllProperties
TestProperty
PresetPaperSize
PaperWidth
PaperHeight
NumPages
PaperOrientation
PageNumber
PositionX
PositionY
ItemWidth
ItemHeight
ItemRotation
Transparency
BlendMode
ExcludeFromExports
MapRotation
MapScale
MapXMin
MapYMin
MapXMax
MapYMax
MapAtlasMargin
PictureSource
SourceUrl

Definition at line 40 of file qgscomposerobject.h.

enum QgsComposerObject::PropertyValueType

Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property.

This may differ if a property has a data defined expression active.

Enumerator:

EvaluatedValue
OriginalValue

Definition at line 79 of file qgscomposerobject.h.

Constructor & Destructor Documentation

QgsComposerObject::QgsComposerObject ( QgsComposition * composition )

Constructor.

Parameters

composition parent composition

Definition at line 31 of file qgscomposerobject.cpp.

QgsComposerObject::~QgsComposerObject ( )

virtual

Definition at line 56 of file qgscomposerobject.cpp.

Member Function Documentation

const QgsComposition* QgsComposerObject::composition ( ) const

inline

Returns the composition the item is attached to.

Returns: QgsComposition for item.

Definition at line 94 of file qgscomposerobject.h.

QgsComposition* QgsComposerObject::composition ( )

inline

Reimplemented in QgsComposerMultiFrame.

Definition at line 95 of file qgscomposerobject.h.

bool QgsComposerObject::dataDefinedEvaluate	(	const QgsComposerObject::DataDefinedProperty	property,
		QVariant &	expressionValue
	)

protected

Evaluate a data defined property and return the calculated value.

Returns: true if data defined property could be successfully evaluated

Parameters

property	data defined property to evaluate
expressionValue	QVariant for storing the evaluated value

Note: this method was added in version 2.5

Definition at line 148 of file qgscomposerobject.cpp.

QgsDataDefined * QgsComposerObject::dataDefinedProperty ( const DataDefinedProperty property ) const

Returns a reference to the data defined settings for one of the item's data defined properties.

Parameters

property data defined property to return

Note: this method was added in version 2.5

Definition at line 88 of file qgscomposerobject.cpp.

void QgsComposerObject::itemChanged ( )

signal

Emitted when the item changes.

Signifies that the item widgets must update the gui elements.

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

virtual

Sets item state from DOM element.

Parameters

itemElem	is DOM node corresponding to item tag
doc	is DOM document

Reimplemented in QgsComposerMap, QgsComposerMapGrid, QgsComposerScaleBar, QgsComposerArrow, QgsComposerLegend, QgsComposerMapOverview, QgsComposerLabel, QgsComposerPicture, QgsComposerAttributeTable, QgsPaperItem, QgsComposerItemGroup, QgsComposerMapItem, QgsComposerShape, QgsComposerTextTable, QgsComposerFrame, and QgsComposerTable.

Definition at line 74 of file qgscomposerobject.cpp.

void QgsComposerObject::refreshDataDefinedProperty ( const DataDefinedProperty property = AllProperties )

virtualslot

Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.

Parameters

property data defined property to refresh. If property is set to QgsComposerItem::AllProperties then all data defined properties for the item will be refreshed.

Note: this method was added in version 2.5

Definition at line 141 of file qgscomposerobject.cpp.

void QgsComposerObject::repaint ( )

virtualslot

Triggers a redraw for the item.

Definition at line 136 of file qgscomposerobject.cpp.

void QgsComposerObject::setDataDefinedProperty	(	const DataDefinedProperty	property,
		const bool	active,
		const bool	useExpression,
		const QString &	expression,
		const QString &	field
	)

Sets parameters for a data defined property for the item.

Parameters

property	data defined property to set
active	true if data defined property is active, false if it is disabled
useExpression	true if the expression should be used
expression	expression for data defined property
field	field name if the data defined property should take its value from a field

Note: this method was added in version 2.5

Definition at line 107 of file qgscomposerobject.cpp.

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

virtual

Stores item state in DOM element.

Parameters

elem	is DOM element corresponding to item tag
doc	is the DOM document

Reimplemented in QgsComposerMap, QgsComposerMapGrid, QgsComposerScaleBar, QgsComposerArrow, QgsComposerLegend, QgsComposerMapOverview, QgsComposerLabel, QgsComposerPicture, QgsComposerAttributeTable, QgsPaperItem, QgsComposerFrame, QgsComposerTable, QgsComposerItemGroup, QgsComposerShape, QgsComposerMapItem, and QgsComposerTextTable.

Definition at line 61 of file qgscomposerobject.cpp.

Friends And Related Function Documentation

friend class TestQgsComposerObject

friend

Definition at line 171 of file qgscomposerobject.h.

Member Data Documentation

QgsComposition* QgsComposerObject::mComposition

protected

Definition at line 141 of file qgscomposerobject.h.

QMap< QgsComposerObject::DataDefinedProperty, QString > QgsComposerObject::mDataDefinedNames

protected

Map of data defined properties for the item to string name to use when exporting item to xml.

Definition at line 144 of file qgscomposerobject.h.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/core/composer/qgscomposerobject.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/core/composer/qgscomposerobject.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation