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

This widget is used to show the attributes of a set of features of a QgsVectorLayer. More...

#include <qgsdualview.h>

Inheritance diagram for QgsDualView:
Inheritance graph
[legend]

Public Types

enum  ViewMode { AttributeTable = 0, AttributeEditor = 1 }
 The view modes, in which this widget can present information. More...
 

Public Slots

void setCurrentEditSelection (const QgsFeatureIds &fids)
 Set the current edit selection in the AttributeEditor mode. More...
 
bool saveEditChanges ()
 saveEditChanges More...
 

Signals

void displayExpressionChanged (const QString expression)
 Is emitted, whenever the display expression is successfully changed. More...
 
void filterChanged ()
 Is emitted, whenever the filter changes. More...
 

Public Member Functions

 QgsDualView (QWidget *parent=0)
 Constructor. More...
 
void init (QgsVectorLayer *layer, QgsMapCanvas *mapCanvas, const QgsFeatureRequest &request=QgsFeatureRequest(), QgsAttributeEditorContext context=QgsAttributeEditorContext())
 Has to be called to initialize the dual view. More...
 
void setView (ViewMode view)
 Change the current view mode. More...
 
void setFilterMode (QgsAttributeTableFilterModel::FilterMode filterMode)
 Set the filter mode. More...
 
QgsAttributeTableFilterModel::FilterMode filterMode ()
 
void setSelectedOnTop (bool selectedOnTop)
 Toggle the selectedOnTop flag. More...
 
int featureCount ()
 Returns the number of features on the layer. More...
 
int filteredFeatureCount ()
 Returns the number of features which are currently visible, according to the filter restrictions. More...
 
void setFilteredFeatures (QgsFeatureIds filteredFeatures)
 Set a list of currently visible features. More...
 
QgsFeatureIds filteredFeatures ()
 
QgsAttributeTableModelmasterModel () const
 Returns the model which has the information about all features (not only filtered) More...
 
void setRequest (const QgsFeatureRequest &request)
 
void setFeatureSelectionManager (QgsIFeatureSelectionManager *featureSelectionManager)
 

Protected Member Functions

void columnBoxInit ()
 Initializes widgets which depend on the attributes of this layer. More...
 

Friends

class TestQgsDualView
 

Detailed Description

This widget is used to show the attributes of a set of features of a QgsVectorLayer.

The attributes can be edited. It supports two different layouts: the table layout, in which the attributes for the features are shown in a table and the editor layout, where the features are shown as a selectable list and the attributes for the currently selected feature are shown in a form.

Member Enumeration Documentation

The view modes, in which this widget can present information.

Relates to the QStackedWidget stacks.

Enumerator
AttributeTable 

Shows the features and attributes in a table layout.

AttributeEditor 

Show a list of the features, where one can be chosen and the according attribute dialog will be presented in the neighbouring frame.

Constructor & Destructor Documentation

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

Constructor.

Parameters
parentThe parent widget

Member Function Documentation

void QgsDualView::columnBoxInit ( )
protected

Initializes widgets which depend on the attributes of this layer.

void QgsDualView::displayExpressionChanged ( const QString  expression)
signal

Is emitted, whenever the display expression is successfully changed.

Parameters
expressionThe expression that was applied
int QgsDualView::featureCount ( )

Returns the number of features on the layer.

Returns
Number of features
void QgsDualView::filterChanged ( )
signal

Is emitted, whenever the filter changes.

int QgsDualView::filteredFeatureCount ( )

Returns the number of features which are currently visible, according to the filter restrictions.

Returns
Number of features
QgsFeatureIds QgsDualView::filteredFeatures ( )
inline
QgsAttributeTableFilterModel::FilterMode QgsDualView::filterMode ( )
inline
void QgsDualView::init ( QgsVectorLayer layer,
QgsMapCanvas mapCanvas,
const QgsFeatureRequest request = QgsFeatureRequest(),
QgsAttributeEditorContext  context = QgsAttributeEditorContext() 
)

Has to be called to initialize the dual view.

Parameters
layerThe layer which should be used to fetch features
mapCanvasThe mapCanvas (used for the FilterMode QgsAttributeTableFilterModel::ShowVisible
requestUse a modified request to limit the shown features
contextThe context in which this view is shown
QgsAttributeTableModel* QgsDualView::masterModel ( ) const
inline

Returns the model which has the information about all features (not only filtered)

Returns
The master model
bool QgsDualView::saveEditChanges ( )
slot

saveEditChanges

Returns
true if the saving was ok. false is possible due to connected validation logic.
void QgsDualView::setCurrentEditSelection ( const QgsFeatureIds fids)
slot

Set the current edit selection in the AttributeEditor mode.

Parameters
fidsA list of edited features (Currently only one at a time is supported)
void QgsDualView::setFeatureSelectionManager ( QgsIFeatureSelectionManager featureSelectionManager)
void QgsDualView::setFilteredFeatures ( QgsFeatureIds  filteredFeatures)

Set a list of currently visible features.

Parameters
filteredFeaturesA list of feature ids
void QgsDualView::setFilterMode ( QgsAttributeTableFilterModel::FilterMode  filterMode)

Set the filter mode.

Parameters
filterMode
void QgsDualView::setRequest ( const QgsFeatureRequest request)
void QgsDualView::setSelectedOnTop ( bool  selectedOnTop)

Toggle the selectedOnTop flag.

If enabled, selected features will be moved to top.

Parameters
selectedOnTopTrue: Show selected features on top. False: Use defined sorting column.
void QgsDualView::setView ( QgsDualView::ViewMode  view)

Change the current view mode.

Parameters
viewThe view mode to set

Friends And Related Function Documentation

friend class TestQgsDualView
friend

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