QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | 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]
Collaboration diagram for QgsExpressionItem:
Collaboration 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...
 

Private Attributes

QString mExpressionText
 
QString mHelpText
 
QgsExpressionItem::ItemType mType
 

Detailed Description

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

Definition at line 49 of file qgsexpressionbuilderwidget.h.

Member Enumeration Documentation

Enumerator
Header 
Field 
ExpressionNode 

Definition at line 52 of file qgsexpressionbuilderwidget.h.

Constructor & Destructor Documentation

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

Definition at line 59 of file qgsexpressionbuilderwidget.h.

References mExpressionText, mHelpText, and mType.

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

Definition at line 70 of file qgsexpressionbuilderwidget.h.

References mExpressionText, and mType.

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.

Definition at line 85 of file qgsexpressionbuilderwidget.h.

References mHelpText.

Referenced by QgsExpressionBuilderWidget::loadFunctionHelp().

QgsExpressionItem::ItemType QgsExpressionItem::getItemType ( )
inline
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.

Definition at line 90 of file qgsexpressionbuilderwidget.h.

References mHelpText.

Member Data Documentation

QString QgsExpressionItem::mExpressionText
private

Definition at line 99 of file qgsexpressionbuilderwidget.h.

Referenced by getExpressionText(), and QgsExpressionItem().

QString QgsExpressionItem::mHelpText
private

Definition at line 100 of file qgsexpressionbuilderwidget.h.

Referenced by getHelpText(), QgsExpressionItem(), and setHelpText().

QgsExpressionItem::ItemType QgsExpressionItem::mType
private

Definition at line 101 of file qgsexpressionbuilderwidget.h.

Referenced by getItemType(), and QgsExpressionItem().


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