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

Private Slots

void on_mFeatureList_aboutToChangeEditSelection (bool &ok)
 
void on_mFeatureList_currentEditSelectionChanged (const QgsFeature &feat)
 Changes the currently visible feature within the attribute editor. More...
 
void previewExpressionBuilder ()
 
void previewColumnChanged (QObject *previewAction)
 
void viewWillShowContextMenu (QMenu *menu, QModelIndex atIndex)
 
void previewExpressionChanged (const QString expression)
 
void featureFormAttributeChanged ()
 Will be called whenever the currently shown feature form changes. More...
 
virtual void progress (int i, bool &cancel)
 Will be called periodically, when loading layers from slow data providers. More...
 
virtual void finished ()
 Will be called, once all the features are loaded. More...
 

Private Member Functions

void initLayerCache (QgsVectorLayer *layer)
 
void initModels (QgsMapCanvas *mapCanvas, const QgsFeatureRequest &request)
 

Private Attributes

QgsAttributeEditorContext mEditorContext
 
QgsAttributeTableModelmMasterModel
 
QgsAttributeTableFilterModelmFilterModel
 
QgsFeatureListModelmFeatureListModel
 
QgsAttributeFormmAttributeForm
 
QgsCachedFeatureIteratormFeatureCache
 
QSignalMapper * mPreviewActionMapper
 
QMenu * mPreviewColumnsMenu
 
QgsVectorLayerCachemLayerCache
 
QProgressDialog * mProgressDlg
 
QgsIFeatureSelectionManagermFeatureSelectionManager
 
QgsDistanceArea mDistanceArea
 

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.

Note
Added in 2.0

Definition at line 42 of file qgsdualview.h.

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.

Definition at line 53 of file qgsdualview.h.

Constructor & Destructor Documentation

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

Member Function Documentation

void QgsDualView::columnBoxInit ( )
protected
void QgsDualView::displayExpressionChanged ( const QString  expression)
signal

Is emitted, whenever the display expression is successfully changed.

Parameters
expressionThe expression that was applied

Referenced by initModels(), and QgsDualView().

int QgsDualView::featureCount ( )

Returns the number of features on the layer.

Returns
Number of features

Definition at line 310 of file qgsdualview.cpp.

References mMasterModel, and QgsAttributeTableModel::rowCount().

void QgsDualView::featureFormAttributeChanged ( )
privateslot

Will be called whenever the currently shown feature form changes.

Will forward this signal to the feature list to visually represent that there has been an edit event.

Definition at line 368 of file qgsdualview.cpp.

Referenced by init().

void QgsDualView::filterChanged ( )
signal

Is emitted, whenever the filter changes.

Referenced by setFilterMode().

int QgsDualView::filteredFeatureCount ( )

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

Returns
Number of features

Definition at line 315 of file qgsdualview.cpp.

References mFilterModel.

QgsFeatureIds QgsDualView::filteredFeatures ( )
inline

Definition at line 131 of file qgsdualview.h.

QgsAttributeTableFilterModel::FilterMode QgsDualView::filterMode ( )
inline

Definition at line 98 of file qgsdualview.h.

void QgsDualView::finished ( )
privatevirtualslot

Will be called, once all the features are loaded.

Use e.g. to close a dialog created from progress(int i,bool& cancel )

Definition at line 412 of file qgsdualview.cpp.

References mProgressDlg.

Referenced by initLayerCache(), and initModels().

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

Definition at line 61 of file qgsdualview.cpp.

References columnBoxInit(), featureFormAttributeChanged(), QgsAttributeForm::hideButtonBox(), initLayerCache(), initModels(), mAttributeForm, mEditorContext, mFeatureListModel, mFilterModel, and viewWillShowContextMenu().

Referenced by QgsRelationEditorWidget::createRelationEditor().

void QgsDualView::initLayerCache ( QgsVectorLayer layer)
private
void QgsDualView::initModels ( QgsMapCanvas mapCanvas,
const QgsFeatureRequest request 
)
private
QgsAttributeTableModel* QgsDualView::masterModel ( ) const
inline

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

Returns
The master model

Definition at line 138 of file qgsdualview.h.

Referenced by QgsAttributeTableAction::execute(), QgsAttributeTableMapLayerAction::execute(), QgsAttributeTableAction::featureForm(), QgsRelationEditorWidget::on_mAddFeatureButton_clicked(), and QgsRelationEditorWidget::onCollapsedStateChanged().

void QgsDualView::on_mFeatureList_aboutToChangeEditSelection ( bool &  ok)
privateslot
void QgsDualView::on_mFeatureList_currentEditSelectionChanged ( const QgsFeature feat)
privateslot

Changes the currently visible feature within the attribute editor.

Parameters
featThe newly visible feature

Definition at line 246 of file qgsdualview.cpp.

References QgsFeature::id(), QgsVectorLayer::isEditable(), QgsVectorLayerCache::layer(), mAttributeForm, mLayerCache, QgsAttributeForm::save(), setCurrentEditSelection(), and QgsAttributeForm::setFeature().

void QgsDualView::previewColumnChanged ( QObject *  previewAction)
privateslot

Definition at line 285 of file qgsdualview.cpp.

References tr.

Referenced by QgsDualView().

void QgsDualView::previewExpressionBuilder ( )
privateslot
void QgsDualView::previewExpressionChanged ( const QString  expression)
privateslot
void QgsDualView::progress ( int  i,
bool &  cancel 
)
privatevirtualslot

Will be called periodically, when loading layers from slow data providers.

Parameters
iThe number of features already loaded
cancelSet to true to cancel

Definition at line 394 of file qgsdualview.cpp.

References mProgressDlg, and tr.

Referenced by initLayerCache(), and initModels().

bool QgsDualView::saveEditChanges ( )
slot

saveEditChanges

Returns
true if the saving was ok. false is possible due to connected validation logic.

Definition at line 265 of file qgsdualview.cpp.

References mAttributeForm, and QgsAttributeForm::save().

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)

Definition at line 259 of file qgsdualview.cpp.

Referenced by QgsAttributeTableAction::featureForm(), and on_mFeatureList_currentEditSelectionChanged().

void QgsDualView::setFeatureSelectionManager ( QgsIFeatureSelectionManager featureSelectionManager)

Definition at line 383 of file qgsdualview.cpp.

References mFeatureSelectionManager.

Referenced by QgsRelationEditorWidget::createRelationEditor().

void QgsDualView::setFilteredFeatures ( QgsFeatureIds  filteredFeatures)

Set a list of currently visible features.

Parameters
filteredFeaturesA list of feature ids

Definition at line 373 of file qgsdualview.cpp.

References mFilterModel, and QgsAttributeTableFilterModel::setFilteredFeatures().

void QgsDualView::setFilterMode ( QgsAttributeTableFilterModel::FilterMode  filterMode)

Set the filter mode.

Parameters
filterMode

Definition at line 196 of file qgsdualview.cpp.

References filterChanged(), mFilterModel, and QgsAttributeTableFilterModel::setFilterMode().

void QgsDualView::setRequest ( const QgsFeatureRequest request)

Definition at line 378 of file qgsdualview.cpp.

References mMasterModel, and QgsAttributeTableModel::setRequest().

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.

Definition at line 202 of file qgsdualview.cpp.

References mFilterModel, and QgsAttributeTableFilterModel::setSelectedOnTop().

void QgsDualView::setView ( QgsDualView::ViewMode  view)

Change the current view mode.

Parameters
viewThe view mode to set

Definition at line 191 of file qgsdualview.cpp.

Referenced by QgsAttributeTableAction::featureForm().

void QgsDualView::viewWillShowContextMenu ( QMenu *  menu,
QModelIndex  atIndex 
)
privateslot

Friends And Related Function Documentation

friend class TestQgsDualView
friend

Definition at line 235 of file qgsdualview.h.

Member Data Documentation

QgsAttributeForm* QgsDualView::mAttributeForm
private
QgsDistanceArea QgsDualView::mDistanceArea
private

Definition at line 233 of file qgsdualview.h.

QgsAttributeEditorContext QgsDualView::mEditorContext
private

Definition at line 222 of file qgsdualview.h.

Referenced by init().

QgsCachedFeatureIterator* QgsDualView::mFeatureCache
private

Definition at line 227 of file qgsdualview.h.

QgsFeatureListModel* QgsDualView::mFeatureListModel
private

Definition at line 225 of file qgsdualview.h.

Referenced by init(), and initModels().

QgsIFeatureSelectionManager* QgsDualView::mFeatureSelectionManager
private

Definition at line 232 of file qgsdualview.h.

Referenced by setFeatureSelectionManager().

QgsAttributeTableFilterModel* QgsDualView::mFilterModel
private
QgsVectorLayerCache* QgsDualView::mLayerCache
private
QgsAttributeTableModel* QgsDualView::mMasterModel
private

Definition at line 223 of file qgsdualview.h.

Referenced by featureCount(), initModels(), and setRequest().

QSignalMapper* QgsDualView::mPreviewActionMapper
private

Definition at line 228 of file qgsdualview.h.

Referenced by columnBoxInit(), and QgsDualView().

QMenu* QgsDualView::mPreviewColumnsMenu
private

Definition at line 229 of file qgsdualview.h.

Referenced by columnBoxInit(), and QgsDualView().

QProgressDialog* QgsDualView::mProgressDlg
private

Definition at line 231 of file qgsdualview.h.

Referenced by finished(), and progress().


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