QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Slots | Public Member Functions | List of all members
QgsAttributeDialog Class Reference

#include <qgsattributedialog.h>

Public Slots

void accept ()
void show (bool autoDelete=true)
 Show the dialog non-blocking.

Public Member Functions

 QgsAttributeDialog (QgsVectorLayer *vl, QgsFeature *thepFeature, bool featureOwner, QgsDistanceArea myDa, QWidget *parent=0, bool showDialogButtons=true)
 Create an attribute dialog for a given layer and feature.
 QgsAttributeDialog (QgsVectorLayer *vl, QgsFeature *thepFeature, bool featureOwner, QWidget *parent=0, bool showDialogButtons=true, QgsAttributeEditorContext context=QgsAttributeEditorContext())
 Create an attribute dialog for a given layer and feature.
 ~QgsAttributeDialog ()
void saveGeometry ()
 Saves the size and position for the next time this dialog box will be used.
void restoreGeometry ()
 Restores the size and position from the last time this dialog box was used.
void setHighlight (QgsHighlight *h)
 setHighlight
Q_DECL_DEPRECATED QDialog * dialog ()
 Returns reference to self.
QgsAttributeFormattributeForm ()
const QgsFeaturefeature ()
bool editable ()
 Is this dialog editable?
void setIsAddDialog (bool isAddDialog)
 Toggles the form mode between edit feature and add feature.
void setEditCommandMessage (const QString &message)
 Sets the edit command message (Undo) that will be used when the dialog is accepted.

Constructor & Destructor Documentation

QgsAttributeDialog::QgsAttributeDialog ( QgsVectorLayer vl,
QgsFeature thepFeature,
bool  featureOwner,
QgsDistanceArea  myDa,
QWidget *  parent = 0,
bool  showDialogButtons = true 
)

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
myDaA QgsDistanceArea which will be used for expressions
parentA parent widget for the dialog
showDialogButtonsTrue: Show the dialog buttons accept/cancel
Deprecated:
QgsAttributeDialog::QgsAttributeDialog ( QgsVectorLayer vl,
QgsFeature thepFeature,
bool  featureOwner,
QWidget *  parent = 0,
bool  showDialogButtons = true,
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
QgsAttributeDialog::~QgsAttributeDialog ( )

Member Function Documentation

void QgsAttributeDialog::accept ( )
slot
QgsAttributeForm* QgsAttributeDialog::attributeForm ( )
inline
Q_DECL_DEPRECATED QDialog* QgsAttributeDialog::dialog ( )
inline

Returns reference to self.

Only here for legacy compliance

Returns
this
Deprecated:
Do not use. Just use this object itself. Or QgsAttributeForm if you want to embed.
bool QgsAttributeDialog::editable ( )
inline

Is this dialog editable?

Returns
returns true, if this dialog was created in an editable manner.
const QgsFeature* QgsAttributeDialog::feature ( )
inline
void QgsAttributeDialog::restoreGeometry ( )

Restores the size and position from the last time this dialog box was used.

void QgsAttributeDialog::saveGeometry ( )

Saves the size and position for the next time this dialog box will be used.

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
void QgsAttributeDialog::setHighlight ( QgsHighlight h)

setHighlight

Parameters
hThe highlight. Ownership is taken.
void QgsAttributeDialog::setIsAddDialog ( bool  isAddDialog)
inline

Toggles the form mode between edit feature and add feature.

If set to true, the dialog will be editable even with an invalid feature. If set to true, the dialog will add a new feature when the form is accepted.

Parameters
isAddDialogIf set to true, turn this dialog into an add feature dialog.
void QgsAttributeDialog::show ( bool  autoDelete = true)
slot

Show the dialog non-blocking.

Reparents this dialog to be a child of the dialog form and is deleted when closed.


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