QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Slots | Signals | Public Member Functions | Protected Slots | List of all members
QgsFieldComboBox Class Reference

The QgsFieldComboBox is a combo box which displays the list of fields of a given layer. More...

#include <qgsfieldcombobox.h>

Inheritance diagram for QgsFieldComboBox:
Inheritance graph
[legend]

Public Slots

void setField (QString fieldName)
 setField sets the currently selected field More...
 
void setLayer (QgsVectorLayer *layer)
 set the layer of which the fields are listed More...
 
void setLayer (QgsMapLayer *layer)
 convenience slot to connect QgsMapLayerComboBox layer signal More...
 

Signals

void fieldChanged (QString fieldName)
 the signal is emitted when the currently selected field changes More...
 

Public Member Functions

 QgsFieldComboBox (QWidget *parent=0)
 QgsFieldComboBox creates a combo box to display the fields of a layer. More...
 
QString currentField () const
 return the currently selected field More...
 
QgsFieldProxyModel::Filters filters () const
 currently used filter on list of fields More...
 
QgsVectorLayerlayer () const
 Returns the currently used layer. More...
 
void setFilters (QgsFieldProxyModel::Filters filters)
 setFilters allows fitering according to the type of field More...
 

Protected Slots

void indexChanged (int i)
 

Detailed Description

The QgsFieldComboBox is a combo box which displays the list of fields of a given layer.

It might be combined with a QgsMapLayerComboBox to automatically update fields according to a chosen layer. If expression must be used, QgsFieldExpressionWidget shall be used instead.

See also
QgsMapLayerComboBox
Note
added in 2.3

Definition at line 33 of file qgsfieldcombobox.h.

Constructor & Destructor Documentation

QgsFieldComboBox::QgsFieldComboBox ( QWidget *  parent = 0)
explicit

QgsFieldComboBox creates a combo box to display the fields of a layer.

The layer can be either manually given or dynamically set by connecting the signal QgsMapLayerComboBox::layerChanged to the slot setLayer.

Definition at line 21 of file qgsfieldcombobox.cpp.

Member Function Documentation

QString QgsFieldComboBox::currentField ( ) const

return the currently selected field

Definition at line 70 of file qgsfieldcombobox.cpp.

void QgsFieldComboBox::fieldChanged ( QString  fieldName)
signal

the signal is emitted when the currently selected field changes

QgsFieldProxyModel::Filters QgsFieldComboBox::filters ( ) const
inline

currently used filter on list of fields

Definition at line 50 of file qgsfieldcombobox.h.

void QgsFieldComboBox::indexChanged ( int  i)
protectedslot

Definition at line 84 of file qgsfieldcombobox.cpp.

QgsVectorLayer * QgsFieldComboBox::layer ( ) const

Returns the currently used layer.

Definition at line 49 of file qgsfieldcombobox.cpp.

void QgsFieldComboBox::setField ( QString  fieldName)
slot

setField sets the currently selected field

Definition at line 54 of file qgsfieldcombobox.cpp.

void QgsFieldComboBox::setFilters ( QgsFieldProxyModel::Filters  filters)

setFilters allows fitering according to the type of field

Definition at line 30 of file qgsfieldcombobox.cpp.

void QgsFieldComboBox::setLayer ( QgsVectorLayer layer)
slot

set the layer of which the fields are listed

Definition at line 44 of file qgsfieldcombobox.cpp.

void QgsFieldComboBox::setLayer ( QgsMapLayer layer)
slot

convenience slot to connect QgsMapLayerComboBox layer signal

Definition at line 35 of file qgsfieldcombobox.cpp.


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