Skip to content

Commit 846fef2

Browse files
committedSep 21, 2017
Doxygen
1 parent 813e9d3 commit 846fef2

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed
 

‎python/gui/qgsmaplayerconfigwidgetfactory.sip

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ Constructor
6969
virtual bool supportsStyleDock() const;
7070
%Docstring
7171
Flag if widget is supported for use in style dock.
72+
The default implementation returns false.
7273
:return: True if supported
7374
:rtype: bool
7475
%End
@@ -82,6 +83,7 @@ Constructor
8283
virtual bool supportLayerPropertiesDialog() const;
8384
%Docstring
8485
Flag if widget is supported for use in layer properties dialog.
86+
The default implementation returns false.
8587
:return: True if supported
8688
:rtype: bool
8789
%End

‎src/app/qgsvectorlayerproperties.h

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,22 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private
6464
return txtDisplayName->text();
6565
}
6666

67-
/** Adds an attribute to the table (but does not commit it yet)
68-
\param field the field to add
69-
\returns false in case of a name conflict, true in case of success */
67+
/**
68+
* Adds an attribute to the layer.
69+
* The layer will need to be in edit mode. It will only be added to the provider when the edit buffer
70+
* is committed.
71+
* \param field the field to add
72+
* \returns false in case of a name conflict, true in case of success
73+
*/
7074
bool addAttribute( const QgsField &field );
7175

72-
/** Deletes an attribute (but does not commit it)
73-
\param name attribute name
74-
\returns false in case of a non-existing attribute.*/
76+
/**
77+
* Deletes an attribute.
78+
* The layer will need to be in edit mode. It will only be added to the provider when the edit buffer
79+
* is committed.
80+
* \param name attribute name
81+
* \returns false in case of a non-existing attribute.
82+
*/
7583
bool deleteAttribute( int attr );
7684

7785
//! Adds a properties page factory to the vector layer properties dialog.

‎src/gui/qgsmaplayerconfigwidgetfactory.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory
7070

7171
/**
7272
* Flag if widget is supported for use in style dock.
73+
* The default implementation returns false.
7374
* \returns True if supported
7475
*/
7576
virtual bool supportsStyleDock() const { return false; }
@@ -82,6 +83,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory
8283

8384
/**
8485
* Flag if widget is supported for use in layer properties dialog.
86+
* The default implementation returns false.
8587
* \returns True if supported
8688
*/
8789
virtual bool supportLayerPropertiesDialog() const { return false; }

0 commit comments

Comments
 (0)
Please sign in to comment.