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

Shows a list of features and renders a edit button next to each feature. More...

#include <qgsfeaturelistview.h>

Inheritance diagram for QgsFeatureListView:
Inheritance graph
[legend]

Public Slots

void setEditSelection (const QgsFeatureIds &fids)
 Set the feature(s) to be edited. More...
 
void setEditSelection (const QModelIndex &index, QItemSelectionModel::SelectionFlags command)
 Set the feature(s) to be edited. More...
 
virtual void selectAll ()
 Select all currently visible features. More...
 
void repaintRequested (QModelIndexList indexes)
 
void repaintRequested ()
 

Signals

void currentEditSelectionChanged (QgsFeature &feat)
 Is emitted, whenever the current edit selection has been changed. More...
 
void displayExpressionChanged (const QString expression)
 Is emitted, whenever the display expression is successfully changed. More...
 
void aboutToChangeEditSelection (bool &ok)
 

Public Member Functions

 QgsFeatureListView (QWidget *parent=0)
 Creates a feature list view. More...
 
virtual ~QgsFeatureListView ()
 Destructor. More...
 
QgsVectorLayerCachelayerCache ()
 Returns the layer cache. More...
 
virtual void setModel (QgsFeatureListModel *featureListModel)
 Set the QgsFeatureListModel which is used to retrieve information. More...
 
QgsFeatureListModelfeatureListModel ()
 Get the featureListModel used by this view. More...
 
bool setDisplayExpression (const QString displayExpression)
 The display expression is an expression used to render the fields into a single string which is displaied. More...
 
const QString displayExpression () const
 Returns the expression which is currently used to render the features. More...
 
QString parserErrorString ()
 Returns a detailed message about errors while parsing a QgsExpression. More...
 
QgsFeatureIds currentEditSelection ()
 Get the currentEditSelection. More...
 
void setCurrentFeatureEdited (bool state)
 Sets if the currently shown form has received any edit events so far. More...
 

Protected Member Functions

virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void contextMenuEvent (QContextMenuEvent *event)
 

Detailed Description

Shows a list of features and renders a edit button next to each feature.

Accepts a display expression to define the way, features are rendered. Uses a QgsFeatureListModel as source model.

Constructor & Destructor Documentation

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

Creates a feature list view.

Parameters
parentowner
virtual QgsFeatureListView::~QgsFeatureListView ( )
inlinevirtual

Destructor.

Member Function Documentation

void QgsFeatureListView::aboutToChangeEditSelection ( bool &  ok)
signal
void QgsFeatureListView::contextMenuEvent ( QContextMenuEvent *  event)
protectedvirtual
QgsFeatureIds QgsFeatureListView::currentEditSelection ( )

Get the currentEditSelection.

Returns
A list of edited feature ids
void QgsFeatureListView::currentEditSelectionChanged ( QgsFeature feat)
signal

Is emitted, whenever the current edit selection has been changed.

Parameters
featthe feature, which will be edited.
const QString QgsFeatureListView::displayExpression ( ) const

Returns the expression which is currently used to render the features.

Returns
A string containing the currend display expression
See also
QgsExpression
void QgsFeatureListView::displayExpressionChanged ( const QString  expression)
signal

Is emitted, whenever the display expression is successfully changed.

Parameters
expressionThe expression that was applied
QgsFeatureListModel* QgsFeatureListView::featureListModel ( )
inline

Get the featureListModel used by this view.

Returns
The model in use
void QgsFeatureListView::keyPressEvent ( QKeyEvent *  event)
protectedvirtual
QgsVectorLayerCache * QgsFeatureListView::layerCache ( )

Returns the layer cache.

Returns
the layer cache used as backend
void QgsFeatureListView::mouseMoveEvent ( QMouseEvent *  event)
protectedvirtual

This function is called with the given event when a mouse move event is sent to the widget. If a selection is in progress and new items are moved over the selection is extended; if a drag is in progress it is continued.

void QgsFeatureListView::mousePressEvent ( QMouseEvent *  event)
protectedvirtual
void QgsFeatureListView::mouseReleaseEvent ( QMouseEvent *  event)
protectedvirtual

This function is called with the given event when a mouse button is released, after a mouse press event on the widget. If a user presses the mouse inside your widget and then drags the mouse to another location before releasing the mouse button, your widget receives the release event. The function will emit the clicked() signal if an item was being pressed.

QString QgsFeatureListView::parserErrorString ( )

Returns a detailed message about errors while parsing a QgsExpression.

Returns
A message containg information about the parser error.
void QgsFeatureListView::repaintRequested ( QModelIndexList  indexes)
slot
void QgsFeatureListView::repaintRequested ( )
slot
void QgsFeatureListView::selectAll ( )
virtualslot

Select all currently visible features.

void QgsFeatureListView::setCurrentFeatureEdited ( bool  state)

Sets if the currently shown form has received any edit events so far.

Parameters
stateThe state
bool QgsFeatureListView::setDisplayExpression ( const QString  displayExpression)

The display expression is an expression used to render the fields into a single string which is displaied.

Parameters
displayExpressionThe expression used to render the feature
See also
QgsExpression
void QgsFeatureListView::setEditSelection ( const QgsFeatureIds fids)
slot

Set the feature(s) to be edited.

Parameters
fidsA list of features to be edited
void QgsFeatureListView::setEditSelection ( const QModelIndex &  index,
QItemSelectionModel::SelectionFlags  command 
)
slot

Set the feature(s) to be edited.

Parameters
indexThe selection to set
commandselection update mode
void QgsFeatureListView::setModel ( QgsFeatureListModel featureListModel)
virtual

Set the QgsFeatureListModel which is used to retrieve information.

Parameters
featureListModelThe model to use

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