QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | List of all members
QgsExpressionItem Class Reference

An expression item that can be used in the QgsExpressionBuilderWidget tree. More...

#include <qgsexpressionbuilderwidget.h>

Inheritance diagram for QgsExpressionItem:
Inheritance graph
[legend]

Public Types

enum  ItemType { Header, Field, ExpressionNode }
 

Public Member Functions

 QgsExpressionItem (QString label, QString expressionText, QString helpText, QgsExpressionItem::ItemType itemType=ExpressionNode)
 
 QgsExpressionItem (QString label, QString expressionText, QgsExpressionItem::ItemType itemType=ExpressionNode)
 
QString getExpressionText ()
 
QString getHelpText ()
 Get the help text that is associated with this expression item. More...
 
void setHelpText (QString helpText)
 Set the help text for the current item. More...
 
QgsExpressionItem::ItemType getItemType ()
 Get the type of expression item eg header, field, ExpressionNode. More...
 

Detailed Description

An expression item that can be used in the QgsExpressionBuilderWidget tree.

Member Enumeration Documentation

Enumerator
Header 
Field 
ExpressionNode 

Constructor & Destructor Documentation

QgsExpressionItem::QgsExpressionItem ( QString  label,
QString  expressionText,
QString  helpText,
QgsExpressionItem::ItemType  itemType = ExpressionNode 
)
inline
QgsExpressionItem::QgsExpressionItem ( QString  label,
QString  expressionText,
QgsExpressionItem::ItemType  itemType = ExpressionNode 
)
inline

Member Function Documentation

QString QgsExpressionItem::getExpressionText ( )
inline
QString QgsExpressionItem::getHelpText ( )
inline

Get the help text that is associated with this expression item.

Returns
The help text.
QgsExpressionItem::ItemType QgsExpressionItem::getItemType ( )
inline

Get the type of expression item eg header, field, ExpressionNode.

Returns
The QgsExpressionItem::ItemType
void QgsExpressionItem::setHelpText ( QString  helpText)
inline

Set the help text for the current item.

Note
The help text can be set as a html string.

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