@@ -14,7 +14,7 @@ class QgsMapLayerConfigWidgetFactory
14
14
QgsMapLayerConfigWidgetFactory();
15
15
16
16
/** Constructor */
17
- QgsMapLayerConfigWidgetFactory(QString title, QIcon icon);
17
+ QgsMapLayerConfigWidgetFactory( QString title, QIcon icon );
18
18
19
19
/** Destructor */
20
20
virtual ~QgsMapLayerConfigWidgetFactory();
@@ -25,7 +25,11 @@ class QgsMapLayerConfigWidgetFactory
25
25
*/
26
26
virtual QIcon icon() const;
27
27
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 );
29
33
30
34
/**
31
35
* @brief The title of the panel.
@@ -34,15 +38,37 @@ class QgsMapLayerConfigWidgetFactory
34
38
*/
35
39
virtual QString title() const;
36
40
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 );
38
48
49
+ /**
50
+ * Flag if widget is supported for use in style dock.
51
+ * @return True if supported
52
+ */
39
53
virtual bool supportsStyleDock() const;
40
54
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 );
42
60
61
+ /**
62
+ * Flag if widget is supported for use in layer properties dialog.
63
+ * @return True if supported
64
+ */
43
65
virtual bool supportLayerPropertiesDialog() const;
44
66
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 );
46
72
47
73
/**
48
74
* @brief Check if the layer is supported for this widget.
@@ -59,5 +85,5 @@ class QgsMapLayerConfigWidgetFactory
59
85
* @param parent The parent of the widget.
60
86
* @return A new QgsMapStylePanel which is shown in the map style dock.
61
87
*/
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/;
63
89
};
0 commit comments