Skip to content

Commit c5d8cc7

Browse files
committed
Added missing & in setTitle in SIP
1 parent 774a823 commit c5d8cc7

File tree

1 file changed

+32
-6
lines changed

1 file changed

+32
-6
lines changed

python/gui/qgsmaplayerconfigwidgetfactory.sip

+32-6
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class QgsMapLayerConfigWidgetFactory
1414
QgsMapLayerConfigWidgetFactory();
1515

1616
/** Constructor */
17-
QgsMapLayerConfigWidgetFactory(QString title, QIcon icon);
17+
QgsMapLayerConfigWidgetFactory( QString title, QIcon icon );
1818

1919
/** Destructor */
2020
virtual ~QgsMapLayerConfigWidgetFactory();
@@ -25,7 +25,11 @@ class QgsMapLayerConfigWidgetFactory
2525
*/
2626
virtual QIcon icon() const;
2727

28-
void setIcon(const QIcon& icon);
28+
/**
29+
* Set the icon for the factory object.
30+
* @param icon The icon to show in the interface.
31+
*/
32+
void setIcon( const QIcon& icon );
2933

3034
/**
3135
* @brief The title of the panel.
@@ -34,15 +38,37 @@ class QgsMapLayerConfigWidgetFactory
3438
*/
3539
virtual QString title() const;
3640

37-
void setTitle(const QString title);
41+
/**
42+
* Set the title for the interface
43+
* @note Not all users may show this as a label
44+
* e.g style dock uses this as a tooltip.
45+
* @param title The title to set.
46+
*/
47+
void setTitle( const QString& title );
3848

49+
/**
50+
* Flag if widget is supported for use in style dock.
51+
* @return True if supported
52+
*/
3953
virtual bool supportsStyleDock() const;
4054

41-
void setSupportsStyleDock(bool supports);
55+
/**
56+
* Set support flag for style dock
57+
* @param supports True if this widget is supported in the style dock.
58+
*/
59+
void setSupportsStyleDock( bool supports );
4260

61+
/**
62+
* Flag if widget is supported for use in layer properties dialog.
63+
* @return True if supported
64+
*/
4365
virtual bool supportLayerPropertiesDialog() const;
4466

45-
void setSupportLayerPropertiesDialog(bool supports);
67+
/**
68+
* Set support flag for style dock
69+
* @param supports True if this widget is supported in the style dock.
70+
*/
71+
void setSupportLayerPropertiesDialog( bool supports );
4672

4773
/**
4874
* @brief Check if the layer is supported for this widget.
@@ -59,5 +85,5 @@ class QgsMapLayerConfigWidgetFactory
5985
* @param parent The parent of the widget.
6086
* @return A new QgsMapStylePanel which is shown in the map style dock.
6187
*/
62-
virtual QgsMapLayerConfigWidget* createWidget( QgsMapLayer* layer, QgsMapCanvas *canvas, bool dockWidget = true, QWidget* parent /TransferThis/ = 0) const = 0 /Factory/;
88+
virtual QgsMapLayerConfigWidget* createWidget( QgsMapLayer* layer, QgsMapCanvas *canvas, bool dockWidget = true, QWidget* parent /TransferThis/ = 0 ) const = 0 /Factory/;
6389
};

0 commit comments

Comments
 (0)