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

#include <qgsdualview.h>

Inheritance diagram for QgsDualView:

Collaboration diagram for QgsDualView:

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 ()

QgsAttributeTableModel *	masterModel () 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

QgsAttributeTableModel *	mMasterModel

QgsAttributeTableFilterModel *	mFilterModel

QgsFeatureListModel *	mFeatureListModel

QgsAttributeForm *	mAttributeForm

QgsCachedFeatureIterator *	mFeatureCache

QSignalMapper *	mPreviewActionMapper

QMenu *	mPreviewColumnsMenu

QgsVectorLayerCache *	mLayerCache

QProgressDialog *	mProgressDlg

QgsIFeatureSelectionManager *	mFeatureSelectionManager

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

enum QgsDualView::ViewMode

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

Constructor.

Parameters

parent The parent widget

Definition at line 36 of file qgsdualview.cpp.

References displayExpressionChanged(), QgsApplication::getThemeIcon(), mPreviewActionMapper, mPreviewColumnsMenu, previewColumnChanged(), previewExpressionBuilder(), and previewExpressionChanged().

Member Function Documentation

void QgsDualView::columnBoxInit ( )

protected

Initializes widgets which depend on the attributes of this layer.

Definition at line 84 of file qgsdualview.cpp.

References QgsVectorLayer::displayExpression(), QgsVectorLayer::displayField(), QgsVectorLayer::editorWidgetV2(), QgsVectorLayer::fieldNameIndex(), QgsApplication::getThemeIcon(), icon(), QgsVectorLayerCache::layer(), mLayerCache, mPreviewActionMapper, mPreviewColumnsMenu, QgsField::name(), QgsVectorLayer::pendingFields(), QgsVectorLayer::pendingPkAttributesList(), and QgsFields::toList().

Referenced by init().

void QgsDualView::displayExpressionChanged ( const QString expression )

signal

Is emitted, whenever the display expression is successfully changed.

Parameters

expression The 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

layer	The layer which should be used to fetch features
mapCanvas	The mapCanvas (used for the FilterMode QgsAttributeTableFilterModel::ShowVisible
request	Use a modified request to limit the shown features
context	The 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

Definition at line 207 of file qgsdualview.cpp.

References finished(), mLayerCache, progress(), and QgsVectorDataProvider::SelectAtId.

Referenced by init().

void QgsDualView::initModels	(	QgsMapCanvas *	mapCanvas,
		const QgsFeatureRequest &	request
	)

private

Definition at line 223 of file qgsdualview.cpp.

References displayExpressionChanged(), finished(), QgsAttributeTableModel::loadLayer(), mFeatureListModel, mFilterModel, mLayerCache, mMasterModel, progress(), and QgsAttributeTableModel::setRequest().

Referenced by init().

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

Definition at line 240 of file qgsdualview.cpp.

References QgsVectorLayer::isEditable(), QgsVectorLayerCache::layer(), mAttributeForm, mLayerCache, and QgsAttributeForm::save().

void QgsDualView::on_mFeatureList_currentEditSelectionChanged ( const QgsFeature & feat )

privateslot

Changes the currently visible feature within the attribute editor.

Parameters

feat	The 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

Definition at line 270 of file qgsdualview.cpp.

References QgsVectorLayer::displayExpression(), QgsVectorLayerCache::layer(), mLayerCache, QgsExpressionBuilderDialog::setExpressionText(), and tr.

Referenced by QgsDualView().

void QgsDualView::previewExpressionChanged ( const QString expression )

privateslot

Definition at line 363 of file qgsdualview.cpp.

References QgsVectorLayerCache::layer(), mLayerCache, and QgsVectorLayer::setDisplayExpression().

Referenced by QgsDualView().

void QgsDualView::progress	(	int	i,
		bool &	cancel
	)

privatevirtualslot

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

Parameters

i	The number of features already loaded
cancel	Set 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

fids	A 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

filteredFeatures A 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

selectedOnTop True: 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

view	The view mode to set

Definition at line 191 of file qgsdualview.cpp.

Referenced by QgsAttributeTableAction::featureForm().

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

privateslot

Definition at line 320 of file qgsdualview.cpp.

References QgsVectorLayer::actions(), QgsAttributeAction::at(), QgsMapLayerActionRegistry::instance(), QgsVectorLayerCache::layer(), QgsMapLayerActionRegistry::mapLayerActions(), mFilterModel, mLayerCache, QgsAction::name(), QgsAction::runable(), QgsAttributeAction::size(), and tr.

Referenced by init().

Friends And Related Function Documentation

friend class TestQgsDualView

friend

Definition at line 235 of file qgsdualview.h.

Member Data Documentation

QgsAttributeForm* QgsDualView::mAttributeForm

private

Definition at line 226 of file qgsdualview.h.

Referenced by init(), on_mFeatureList_aboutToChangeEditSelection(), on_mFeatureList_currentEditSelectionChanged(), and saveEditChanges().

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

Definition at line 224 of file qgsdualview.h.

Referenced by filteredFeatureCount(), init(), initModels(), setFilteredFeatures(), setFilterMode(), setSelectedOnTop(), and viewWillShowContextMenu().

QgsVectorLayerCache* QgsDualView::mLayerCache

private

Definition at line 230 of file qgsdualview.h.

Referenced by columnBoxInit(), initLayerCache(), initModels(), on_mFeatureList_aboutToChangeEditSelection(), on_mFeatureList_currentEditSelectionChanged(), previewExpressionBuilder(), previewExpressionChanged(), and viewWillShowContextMenu().

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:

/tmp/buildd/qgis-2.4.0+unstable1/src/gui/attributetable/qgsdualview.h
/tmp/buildd/qgis-2.4.0+unstable1/src/gui/attributetable/qgsdualview.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation