QGIS API Documentation  3.5.0-Master (bebc34b)
Public Slots | Public Member Functions | List of all members
QgsAttributeDialog Class Reference

#include <qgsattributedialog.h>

Inheritance diagram for QgsAttributeDialog:
Inheritance graph
[legend]

Public Slots

void accept () override
 
void reject () override
 
void show ()
 Show the dialog non-blocking. Reparents this dialog to be a child of the dialog form. More...
 

Public Member Functions

 QgsAttributeDialog (QgsVectorLayer *vl, QgsFeature *thepFeature, bool featureOwner, QWidget *parent=nullptr, bool showDialogButtons=true, const QgsAttributeEditorContext &context=QgsAttributeEditorContext())
 Create an attribute dialog for a given layer and feature. More...
 
 ~QgsAttributeDialog () override
 
QgsAttributeFormattributeForm ()
 
bool editable ()
 Is this dialog editable? More...
 
bool event (QEvent *e) override
 Intercept window activate/deactivate events to show/hide the highlighted feature. More...
 
const QgsFeaturefeature ()
 
void setEditCommandMessage (const QString &message)
 Sets the edit command message (Undo) that will be used when the dialog is accepted. More...
 
void setHighlight (QgsHighlight *h)
 setHighlight More...
 
void setMode (QgsAttributeEditorContext::Mode mode)
 Toggles the form mode. More...
 

Detailed Description

Definition at line 38 of file qgsattributedialog.h.

Constructor & Destructor Documentation

◆ QgsAttributeDialog()

QgsAttributeDialog::QgsAttributeDialog ( QgsVectorLayer vl,
QgsFeature thepFeature,
bool  featureOwner,
QWidget *  parent = nullptr,
bool  showDialogButtons = true,
const QgsAttributeEditorContext context = QgsAttributeEditorContext() 
)

Create an attribute dialog for a given layer and feature.

Parameters
vlThe layer for which the dialog will be generated
thepFeatureA feature for which the dialog will be generated
featureOwnerSet to true, if the dialog should take ownership of the feature
parentA parent widget for the dialog
showDialogButtonsTrue: Show the dialog buttons accept/cancel
contextThe context in which this dialog is created

Definition at line 25 of file qgsattributedialog.cpp.

◆ ~QgsAttributeDialog()

QgsAttributeDialog::~QgsAttributeDialog ( )
override

Definition at line 32 of file qgsattributedialog.cpp.

Member Function Documentation

◆ accept

void QgsAttributeDialog::accept ( )
overrideslot

Definition at line 66 of file qgsattributedialog.cpp.

◆ attributeForm()

QgsAttributeForm* QgsAttributeDialog::attributeForm ( )
inline

Definition at line 65 of file qgsattributedialog.h.

◆ editable()

bool QgsAttributeDialog::editable ( )
inline

Is this dialog editable?

Returns
returns true, if this dialog was created in an editable manner.

Definition at line 74 of file qgsattributedialog.h.

◆ event()

bool QgsAttributeDialog::event ( QEvent *  e)
override

Intercept window activate/deactivate events to show/hide the highlighted feature.

Parameters
eThe event
Returns
The same as the parent QDialog

Definition at line 125 of file qgsattributedialog.cpp.

◆ feature()

const QgsFeature* QgsAttributeDialog::feature ( )
inline

Definition at line 67 of file qgsattributedialog.h.

◆ reject

void QgsAttributeDialog::reject ( )
overrideslot

Definition at line 79 of file qgsattributedialog.cpp.

◆ setEditCommandMessage()

void QgsAttributeDialog::setEditCommandMessage ( const QString &  message)
inline

Sets the edit command message (Undo) that will be used when the dialog is accepted.

Parameters
messageThe message

Definition at line 88 of file qgsattributedialog.h.

◆ setHighlight()

void QgsAttributeDialog::setHighlight ( QgsHighlight h)

setHighlight

Parameters
hThe highlight. Ownership is taken.

Definition at line 59 of file qgsattributedialog.cpp.

◆ setMode()

void QgsAttributeDialog::setMode ( QgsAttributeEditorContext::Mode  mode)

Toggles the form mode.

Parameters
modeform mode. For example, if set to QgsAttributeEditorContext::AddFeatureMode, the dialog will be editable even with an invalid feature and will add a new feature when the form is accepted.

Definition at line 119 of file qgsattributedialog.cpp.

◆ show

void QgsAttributeDialog::show ( )
slot

Show the dialog non-blocking. Reparents this dialog to be a child of the dialog form.

Definition at line 72 of file qgsattributedialog.cpp.


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