QgsComposerLegendItem Class Reference

Abstract base class for the legend item types. More...

#include <qgscomposerlegenditem.h>

Inheritance diagram for QgsComposerLegendItem:

List of all members.

Public Types
enum	ItemType {   GroupItem = QStandardItem::UserType, LayerItem, SymbologyV2Item, RasterSymbolItem,   StyleItem }
Public Member Functions
	QgsComposerLegendItem (QgsComposerLegendStyle::Style s=QgsComposerLegendStyle::Undefined)
	QgsComposerLegendItem (const QString &text, QgsComposerLegendStyle::Style s=QgsComposerLegendStyle::Undefined)
	QgsComposerLegendItem (const QIcon &icon, const QString &text, QgsComposerLegendStyle::Style s=QgsComposerLegendStyle::Undefined)
virtual	~QgsComposerLegendItem ()
virtual QStandardItem *	clone () const =0
virtual ItemType	itemType () const =0
virtual void	readXML (const QDomElement &itemElem, bool xServerAvailable=true)=0
	Read item content from xml.
void	setStyle (QgsComposerLegendStyle::Style style)
virtual void	setUserText (const QString &text)
QgsComposerLegendStyle::Style	style () const
virtual QString	userText () const
virtual void	writeXML (QDomElement &elem, QDomDocument &doc) const =0
Protected Member Functions
void	writeXMLChildren (QDomElement &elem, QDomDocument &doc) const
Protected Attributes
QgsComposerLegendStyle::Style	mStyle
QString	mUserText

---

Detailed Description

Abstract base class for the legend item types.

Definition at line 27 of file qgscomposerlegenditem.h.

---

Member Enumeration Documentation

enum QgsComposerLegendItem::ItemType

Enumerator:

GroupItem
LayerItem
SymbologyV2Item
RasterSymbolItem
StyleItem

Definition at line 35 of file qgscomposerlegenditem.h.

---

Constructor & Destructor Documentation

QgsComposerLegendItem::QgsComposerLegendItem

(

QgsComposerLegendStyle::Style

s = QgsComposerLegendStyle::Undefined

)

Definition at line 31 of file qgscomposerlegenditem.cpp.

QgsComposerLegendItem::QgsComposerLegendItem	(	const QString &	text,
		QgsComposerLegendStyle::Style	s = QgsComposerLegendStyle::Undefined
	)

Definition at line 36 of file qgscomposerlegenditem.cpp.

QgsComposerLegendItem::QgsComposerLegendItem	(	const QIcon &	icon,
		const QString &	text,
		QgsComposerLegendStyle::Style	s = QgsComposerLegendStyle::Undefined
	)

Definition at line 41 of file qgscomposerlegenditem.cpp.

QgsComposerLegendItem::~QgsComposerLegendItem

(

)

[virtual]

Definition at line 46 of file qgscomposerlegenditem.cpp.

---

Member Function Documentation

virtual QStandardItem* QgsComposerLegendItem::clone

(

)

const [pure virtual]

Implemented in QgsComposerGroupItem, QgsComposerLayerItem, QgsComposerRasterSymbolItem, and QgsComposerSymbolV2Item.

virtual ItemType QgsComposerLegendItem::itemType

(

)

const [pure virtual]

Implemented in QgsComposerGroupItem, QgsComposerLayerItem, QgsComposerRasterSymbolItem, and QgsComposerSymbolV2Item.

Referenced by QgsComposerLegend::createAtomList(), QgsComposerLegend::drawAtom(), QgsLegendModel::flags(), QgsComposerLegend::setColumns(), QgsComposerLegend::spaceAboveAtom(), and QgsLegendModel::updateItem().

virtual void QgsComposerLegendItem::readXML	(	const QDomElement &	itemElem,
		bool	xServerAvailable = true
	)		[pure virtual]

Read item content from xml.

Parameters:

itemElem	item to read from
xServerAvailable	Read item icons if true (QIcon needs x-server)

Implemented in QgsComposerGroupItem, QgsComposerLayerItem, QgsComposerRasterSymbolItem, and QgsComposerSymbolV2Item.

Referenced by QgsLegendModel::dropMimeData(), QgsLegendModel::readXML(), QgsComposerLayerItem::readXML(), and QgsComposerGroupItem::readXML().

void QgsComposerLegendItem::setStyle

(

QgsComposerLegendStyle::Style

style

)

[inline]

Definition at line 54 of file qgscomposerlegenditem.h.

Referenced by QgsComposerLayerItem::readXML(), QgsComposerGroupItem::readXML(), and QgsComposerLayerItem::setDefaultStyle().

virtual void QgsComposerLegendItem::setUserText

(

const QString &

text

)

[inline, virtual]

Definition at line 59 of file qgscomposerlegenditem.h.

Referenced by QgsLegendModel::addGroup(), QgsLegendModel::addRasterLayerItems(), QgsLegendModel::addVectorLayerItemsV2(), QgsComposerSymbolV2Item::readXML(), QgsComposerRasterSymbolItem::readXML(), QgsComposerLayerItem::readXML(), and QgsComposerGroupItem::readXML().

QgsComposerLegendStyle::Style QgsComposerLegendItem::style

(

)

const [inline]

Definition at line 53 of file qgscomposerlegenditem.h.

Referenced by QgsComposerLegend::createAtomList(), QgsComposerLegend::drawAtom(), QgsComposerLegend::drawGroupItemTitle(), QgsComposerLegend::drawLayerItemTitle(), QgsComposerStyleItem::QgsComposerStyleItem(), and QgsComposerLegend::spaceAboveAtom().

virtual QString QgsComposerLegendItem::userText

(

)

const [inline, virtual]

Definition at line 57 of file qgscomposerlegenditem.h.

Referenced by QgsLegendModel::addRasterLayerItems(), QgsLegendModel::addVectorLayerItemsV2(), QgsComposerGroupItem::readXML(), QgsLegendModel::updateItemText(), QgsLegendModel::updateLayerItemText(), QgsLegendModel::updateRasterSymbolItemText(), QgsLegendModel::updateSymbolV2ItemText(), QgsComposerSymbolV2Item::writeXML(), QgsComposerRasterSymbolItem::writeXML(), QgsComposerLayerItem::writeXML(), and QgsComposerGroupItem::writeXML().

virtual void QgsComposerLegendItem::writeXML	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const [pure virtual]

Implemented in QgsComposerGroupItem, QgsComposerLayerItem, QgsComposerRasterSymbolItem, and QgsComposerSymbolV2Item.

Referenced by QgsLegendModel::mimeData(), QgsLegendModel::writeXML(), and writeXMLChildren().

void QgsComposerLegendItem::writeXMLChildren	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const [protected]

Definition at line 50 of file qgscomposerlegenditem.cpp.

References writeXML().

Referenced by QgsComposerLayerItem::writeXML(), and QgsComposerGroupItem::writeXML().

---

Member Data Documentation

QgsComposerLegendStyle::Style QgsComposerLegendItem::mStyle [protected]

Definition at line 65 of file qgscomposerlegenditem.h.

Referenced by QgsComposerLayerItem::writeXML(), and QgsComposerGroupItem::writeXML().

QString QgsComposerLegendItem::mUserText [protected]

Definition at line 68 of file qgscomposerlegenditem.h.

---

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

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