QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | List of all members
QgsComposerLayerItem Class Reference

#include <qgscomposerlegenditem.h>

Inheritance diagram for QgsComposerLayerItem:
Inheritance graph
[legend]

Public Member Functions

 QgsComposerLayerItem ()
 
 QgsComposerLayerItem (const QString &text)
 
virtual ~QgsComposerLayerItem ()
 
virtual QStandardItemclone () const override
 
ItemType itemType () const override
 
QString layerID () const
 
virtual void readXML (const QDomElement &itemElem, bool xServerAvailable=true) override
 Read item content from xml. More...
 
void setDefaultStyle (double scaleDenominator=-1, const QString &rule="")
 
void setLayerID (const QString &id)
 
void setShowFeatureCount (bool show)
 
bool showFeatureCount () const
 
virtual void writeXML (QDomElement &elem, QDomDocument &doc) const override
 
- Public Member Functions inherited from QgsComposerLegendItem
 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 ()
 
void setStyle (QgsComposerLegendStyle::Style style)
 
virtual void setUserText (const QString &text)
 
QgsComposerLegendStyle::Style style () const
 
virtual QString userText () const
 
- 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
 
QStandardItemchild (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
 
QStandardItemModelmodel () const
 
virtual bool operator< (const QStandardItem &other) const
 
QStandardItemparent () 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
 
QStandardItemtakeChild (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
 

Additional Inherited Members

- Public Types inherited from QgsComposerLegendItem
enum  ItemType {
  GroupItem = QStandardItem::UserType, LayerItem, SymbologyV2Item, RasterSymbolItem,
  StyleItem
}
 
- Protected Member Functions inherited from QgsComposerLegendItem
void writeXMLChildren (QDomElement &elem, QDomDocument &doc) const
 
- Protected Member Functions inherited from QStandardItem
 QStandardItem (const QStandardItem &other)
 
void emitDataChanged ()
 
QStandardItemoperator= (const QStandardItem &other)
 
- Protected Attributes inherited from QgsComposerLegendItem
QgsComposerLegendStyle::Style mStyle
 
QString mUserText
 

Detailed Description

Definition at line 132 of file qgscomposerlegenditem.h.

Constructor & Destructor Documentation

◆ QgsComposerLayerItem() [1/2]

QgsComposerLayerItem::QgsComposerLayerItem ( )

Definition at line 204 of file qgscomposerlegenditem.cpp.

◆ QgsComposerLayerItem() [2/2]

QgsComposerLayerItem::QgsComposerLayerItem ( const QString text)

Definition at line 209 of file qgscomposerlegenditem.cpp.

◆ ~QgsComposerLayerItem()

QgsComposerLayerItem::~QgsComposerLayerItem ( )
virtual

Definition at line 214 of file qgscomposerlegenditem.cpp.

Member Function Documentation

◆ clone()

QStandardItem * QgsComposerLayerItem::clone ( ) const
overridevirtual

Implements QgsComposerLegendItem.

Definition at line 218 of file qgscomposerlegenditem.cpp.

◆ itemType()

ItemType QgsComposerLayerItem::itemType ( ) const
inlineoverridevirtual

Implements QgsComposerLegendItem.

Definition at line 143 of file qgscomposerlegenditem.h.

◆ layerID()

QString QgsComposerLayerItem::layerID ( ) const
inline

Definition at line 146 of file qgscomposerlegenditem.h.

◆ readXML()

void QgsComposerLayerItem::readXML ( const QDomElement itemElem,
bool  xServerAvailable = true 
)
overridevirtual

Read item content from xml.

Parameters
itemElemitem to read from
xServerAvailableRead item icons if true (QIcon needs x-server)

Implements QgsComposerLegendItem.

Definition at line 238 of file qgscomposerlegenditem.cpp.

◆ setDefaultStyle()

void QgsComposerLayerItem::setDefaultStyle ( double  scaleDenominator = -1,
const QString rule = "" 
)

Definition at line 288 of file qgscomposerlegenditem.cpp.

◆ setLayerID()

void QgsComposerLayerItem::setLayerID ( const QString id)
inline

Definition at line 145 of file qgscomposerlegenditem.h.

◆ setShowFeatureCount()

void QgsComposerLayerItem::setShowFeatureCount ( bool  show)
inline

Definition at line 148 of file qgscomposerlegenditem.h.

◆ showFeatureCount()

bool QgsComposerLayerItem::showFeatureCount ( ) const
inline

Definition at line 149 of file qgscomposerlegenditem.h.

◆ writeXML()

void QgsComposerLayerItem::writeXML ( QDomElement elem,
QDomDocument doc 
) const
overridevirtual

Implements QgsComposerLegendItem.

Definition at line 226 of file qgscomposerlegenditem.cpp.


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