Skip to content

Commit abcca5a

Browse files
committed
Doxymentation for QgsAttributeForm
1 parent a1202be commit abcca5a

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/gui/qgsattributeform.h

+19
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,14 @@ class GUI_EXPORT QgsAttributeForm : public QWidget
3636

3737
const QgsFeature& feature() { return mFeature; }
3838

39+
/**
40+
* Hides the button box (Ok/Cancel) and enables auto-commit
41+
*/
3942
void hideButtonBox();
4043

44+
/**
45+
* Shows the button box (Ok/Cancel) and disables auto-commit
46+
*/
4147
void showButtonBox();
4248

4349
/**
@@ -46,8 +52,18 @@ class GUI_EXPORT QgsAttributeForm : public QWidget
4652
*/
4753
void addInterface( QgsAttributeFormInterface* iface );
4854

55+
/**
56+
* Returns the layer for which this form is shown
57+
*
58+
* @return Layer
59+
*/
4960
QgsVectorLayer* layer() { return mLayer; }
5061

62+
/**
63+
* Returns if the form is currently in editable mode.
64+
*
65+
* @return Editable mode of this form
66+
*/
5167
bool editable();
5268

5369
/**
@@ -118,6 +134,9 @@ class GUI_EXPORT QgsAttributeForm : public QWidget
118134
*/
119135
Q_DECL_DEPRECATED void reject() { resetValues(); }
120136

137+
/**
138+
* Sets all values to the values of the current feature
139+
*/
121140
void resetValues();
122141

123142
private slots:

0 commit comments

Comments
 (0)