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

#include <qgscomposerlegenditem.h>

Inheritance diagram for QgsComposerLegendItem:

[legend]

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 override=0

virtual ItemType	itemType () const =0

virtual void	readXML (const QDomElement &itemElem, bool xServerAvailable=true)=0
	Read item content from xml. More...

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

Public Member Functions inherited from QStandardItem
	QStandardItem ()

	QStandardItem (const QString &text)

	QStandardItem (int rows, int columns)

	QStandardItem (const QIcon &icon, const QString &text)

virtual	~QStandardItem ()

QString	accessibleDescription () const

QString	accessibleText () const

void	appendColumn (const QList< QStandardItem * > &items)

void	appendRow (const QList< QStandardItem * > &items)

void	appendRow (QStandardItem *item)

void	appendRows (const QList< QStandardItem * > &items)

QBrush	background () const

Qt::CheckState	checkState () const

QStandardItem *	child (int row, int column) const

int	column () const

int	columnCount () const

virtual QVariant	data (int role) const

Qt::ItemFlags	flags () const

QFont	font () const

QBrush	foreground () const

bool	hasChildren () const

QIcon	icon () const

QModelIndex	index () const

void	insertColumn (int column, const QList< QStandardItem * > &items)

void	insertColumns (int column, int count)

void	insertRow (int row, QStandardItem *item)

void	insertRow (int row, const QList< QStandardItem * > &items)

void	insertRows (int row, const QList< QStandardItem * > &items)

void	insertRows (int row, int count)

bool	isCheckable () const

bool	isDragEnabled () const

bool	isDropEnabled () const

bool	isEditable () const

bool	isEnabled () const

bool	isSelectable () const

bool	isTristate () const

QStandardItemModel *	model () const

virtual bool	operator< (const QStandardItem &other) const

QStandardItem *	parent () const

virtual void	read (QDataStream &in)

void	removeColumn (int column)

void	removeColumns (int column, int count)

void	removeRow (int row)

void	removeRows (int row, int count)

int	row () const

int	rowCount () const

void	setAccessibleDescription (const QString &accessibleDescription)

void	setAccessibleText (const QString &accessibleText)

void	setBackground (const QBrush &brush)

void	setCheckable (bool checkable)

void	setCheckState (Qt::CheckState state)

void	setChild (int row, int column, QStandardItem *item)

void	setChild (int row, QStandardItem *item)

void	setColumnCount (int columns)

virtual void	setData (const QVariant &value, int role)

void	setDragEnabled (bool dragEnabled)

void	setDropEnabled (bool dropEnabled)

void	setEditable (bool editable)

void	setEnabled (bool enabled)

void	setFlags (QFlags< Qt::ItemFlag > flags)

void	setFont (const QFont &font)

void	setForeground (const QBrush &brush)

void	setIcon (const QIcon &icon)

void	setRowCount (int rows)

void	setSelectable (bool selectable)

void	setSizeHint (const QSize &size)

void	setStatusTip (const QString &statusTip)

void	setText (const QString &text)

void	setTextAlignment (QFlags< Qt::AlignmentFlag > alignment)

void	setToolTip (const QString &toolTip)

void	setTristate (bool tristate)

void	setWhatsThis (const QString &whatsThis)

QSize	sizeHint () const

void	sortChildren (int column, Qt::SortOrder order)

QString	statusTip () const

QStandardItem *	takeChild (int row, int column)

QList< QStandardItem * >	takeColumn (int column)

QList< QStandardItem * >	takeRow (int row)

QString	text () const

Qt::Alignment	textAlignment () const

QString	toolTip () const

virtual int	type () const

QString	whatsThis () const

virtual void	write (QDataStream &out) const

Protected Member Functions
void	writeXMLChildren (QDomElement &elem, QDomDocument &doc) const

Protected Member Functions inherited from QStandardItem
	QStandardItem (const QStandardItem &other)

void	emitDataChanged ()

QStandardItem &	operator= (const QStandardItem &other)

Protected Attributes
QgsComposerLegendStyle::Style	mStyle

QString	mUserText

Detailed Description

Abstract base class for the legend item types.

Definition at line 29 of file qgscomposerlegenditem.h.

Member Enumeration Documentation

◆ ItemType

enum QgsComposerLegendItem::ItemType

Enumerator
GroupItem
LayerItem
SymbologyV2Item
RasterSymbolItem
StyleItem

Definition at line 37 of file qgscomposerlegenditem.h.

Constructor & Destructor Documentation

◆ QgsComposerLegendItem() [1/3]

QgsComposerLegendItem::QgsComposerLegendItem ( QgsComposerLegendStyle::Style s = QgsComposerLegendStyle::Undefined )

Definition at line 31 of file qgscomposerlegenditem.cpp.

◆ QgsComposerLegendItem() [2/3]

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

Definition at line 36 of file qgscomposerlegenditem.cpp.

◆ QgsComposerLegendItem() [3/3]

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

Definition at line 41 of file qgscomposerlegenditem.cpp.

◆ ~QgsComposerLegendItem()

QgsComposerLegendItem::~QgsComposerLegendItem ( )

virtual

Definition at line 46 of file qgscomposerlegenditem.cpp.

Member Function Documentation

◆ clone()

virtual QStandardItem* QgsComposerLegendItem::clone ( ) const

overridepure virtual

Reimplemented from QStandardItem.

Implemented in QgsComposerGroupItem, QgsComposerLayerItem, QgsComposerRasterSymbolItem, and QgsComposerSymbolV2Item.

◆ itemType()

virtual ItemType QgsComposerLegendItem::itemType ( ) const

pure virtual

Implemented in QgsComposerGroupItem, QgsComposerLayerItem, QgsComposerRasterSymbolItem, and QgsComposerSymbolV2Item.

◆ readXML()

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.

◆ setStyle()

void QgsComposerLegendItem::setStyle ( QgsComposerLegendStyle::Style style )

inline

Definition at line 56 of file qgscomposerlegenditem.h.

◆ setUserText()

virtual void QgsComposerLegendItem::setUserText ( const QString & text )

inlinevirtual

Definition at line 61 of file qgscomposerlegenditem.h.

◆ style()

QgsComposerLegendStyle::Style QgsComposerLegendItem::style ( ) const

inline

Definition at line 55 of file qgscomposerlegenditem.h.

◆ userText()

virtual QString QgsComposerLegendItem::userText ( ) const

inlinevirtual

Definition at line 59 of file qgscomposerlegenditem.h.

◆ writeXML()

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

pure virtual

Implemented in QgsComposerGroupItem, QgsComposerLayerItem, QgsComposerRasterSymbolItem, and QgsComposerSymbolV2Item.

◆ writeXMLChildren()

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

protected

Definition at line 50 of file qgscomposerlegenditem.cpp.

Member Data Documentation

◆ mStyle

QgsComposerLegendStyle::Style QgsComposerLegendItem::mStyle

protected

Definition at line 66 of file qgscomposerlegenditem.h.

◆ mUserText

QString QgsComposerLegendItem::mUserText

protected

Definition at line 69 of file qgscomposerlegenditem.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/composer/qgscomposerlegenditem.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/composer/qgscomposerlegenditem.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ItemType

Constructor & Destructor Documentation

◆ QgsComposerLegendItem() [1/3]

◆ QgsComposerLegendItem() [2/3]

◆ QgsComposerLegendItem() [3/3]

◆ ~QgsComposerLegendItem()

Member Function Documentation

◆ clone()

◆ itemType()

◆ readXML()

◆ setStyle()

◆ setUserText()

◆ style()

◆ userText()

◆ writeXML()

◆ writeXMLChildren()

Member Data Documentation

◆ mStyle

◆ mUserText