sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-17 00:04:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Matthias Kuhn 2017-09-02 09:37:04 +02:00
parent 813e9d32b0
commit 846fef2013
No known key found for this signature in database
GPG Key ID: A0E766808764D73F
3 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/gui/qgsmaplayerconfigwidgetfactory.sip
View File

@ -69,6 +69,7 @@ Constructor
virtual bool supportsStyleDock() const; virtual bool supportsStyleDock() const;
%Docstring %Docstring
Flag if widget is supported for use in style dock. Flag if widget is supported for use in style dock.
The default implementation returns false.
:return: True if supported :return: True if supported
:rtype: bool :rtype: bool
%End %End
@ -82,6 +83,7 @@ Constructor
virtual bool supportLayerPropertiesDialog() const; virtual bool supportLayerPropertiesDialog() const;
%Docstring %Docstring
Flag if widget is supported for use in layer properties dialog. Flag if widget is supported for use in layer properties dialog.
The default implementation returns false.
:return: True if supported :return: True if supported
:rtype: bool :rtype: bool
%End %End

20
src/app/qgsvectorlayerproperties.h
View File

@ -64,14 +64,22 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private
return txtDisplayName->text(); return txtDisplayName->text();
} }
/** Adds an attribute to the table (but does not commit it yet) /**
\param field the field to add * Adds an attribute to the layer.
\returns false in case of a name conflict, true in case of success */ * The layer will need to be in edit mode. It will only be added to the provider when the edit buffer
* is committed.
* \param field the field to add
* \returns false in case of a name conflict, true in case of success
*/
bool addAttribute( const QgsField &field ); bool addAttribute( const QgsField &field );
/** Deletes an attribute (but does not commit it) /**
\param name attribute name * Deletes an attribute.
\returns false in case of a non-existing attribute.*/ * The layer will need to be in edit mode. It will only be added to the provider when the edit buffer
* is committed.
* \param name attribute name
* \returns false in case of a non-existing attribute.
*/
bool deleteAttribute( int attr ); bool deleteAttribute( int attr );
//! Adds a properties page factory to the vector layer properties dialog. //! Adds a properties page factory to the vector layer properties dialog.

2
src/gui/qgsmaplayerconfigwidgetfactory.h
View File

@ -70,6 +70,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory
/** /**
* Flag if widget is supported for use in style dock. * Flag if widget is supported for use in style dock.
* The default implementation returns false.
* \returns True if supported * \returns True if supported
*/ */
virtual bool supportsStyleDock() const { return false; } virtual bool supportsStyleDock() const { return false; }
@ -82,6 +83,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory
/** /**
* Flag if widget is supported for use in layer properties dialog. * Flag if widget is supported for use in layer properties dialog.
* The default implementation returns false.
* \returns True if supported * \returns True if supported
*/ */
virtual bool supportLayerPropertiesDialog() const { return false; } virtual bool supportLayerPropertiesDialog() const { return false; }