Skip to content

Commit 625cfc7

Browse files
3nids3nids
committed
sip gui layertree and raster
1 parent 6eb3570 commit 625cfc7

16 files changed

Lines changed: 674 additions & 276 deletions

‎python/auto_sip.blacklist‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -187,19 +187,6 @@ gui/attributetable/qgsfeatureselectionmodel.sip
187187
gui/attributetable/qgsfieldconditionalformatwidget.sip
188188
gui/attributetable/qgsifeatureselectionmanager.sip
189189
gui/attributetable/qgsorganizetablecolumnsdialog.sip
190-
gui/layertree/qgscustomlayerorderwidget.sip
191-
gui/layertree/qgslayertreeembeddedconfigwidget.sip
192-
gui/layertree/qgslayertreeembeddedwidgetregistry.sip
193-
gui/layertree/qgslayertreemapcanvasbridge.sip
194-
gui/layertree/qgslayertreeview.sip
195-
gui/layertree/qgslayertreeviewdefaultactions.sip
196-
gui/raster/qgspalettedrendererwidget.sip
197-
gui/raster/qgsrasterhistogramwidget.sip
198-
gui/raster/qgssinglebandgrayrendererwidget.sip
199-
gui/raster/qgssinglebandpseudocolorrendererwidget.sip
200-
gui/raster/qgsrendererrasterpropertieswidget.sip
201-
gui/raster/qgsrastertransparencywidget.sip
202-
gui/raster/qgshillshaderendererwidget.sip
203190
gui/symbology-ng/qgs25drendererwidget.sip
204191
gui/symbology-ng/qgsarrowsymbollayerwidget.sip
205192
gui/symbology-ng/qgsbrushstylecombobox.sip

‎python/gui/layertree/qgscustomlayerorderwidget.sip‎

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,44 @@
1-
/**
2-
* The QgsCustomLayerOrderWidget class provides a list box where the user can define
3-
* custom order for drawing of layers. It also features a checkbox for enabling
4-
* or disabling the custom order. Any changes made by the user are automatically
5-
* propagated to the assigned QgsLayerTreeMapCanvasBridge. Also, any updates
6-
* to the layer tree cause refresh of the list.
7-
*
8-
* @see QgsLayerTreeMapCanvasBridge
9-
* @note added in 2.4
10-
*/
1+
/************************************************************************
2+
* This file has been generated automatically from *
3+
* *
4+
* src/gui/layertree/qgscustomlayerorderwidget.h *
5+
* *
6+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
7+
************************************************************************/
8+
9+
10+
11+
12+
1113
class QgsCustomLayerOrderWidget : QWidget
1214
{
13-
%TypeHeaderCode
14-
#include <qgscustomlayerorderwidget.h>
15+
%Docstring
16+
The QgsCustomLayerOrderWidget class provides a list box where the user can define
17+
custom order for drawing of layers. It also features a checkbox for enabling
18+
or disabling the custom order. Any changes made by the user are automatically
19+
propagated to the assigned QgsLayerTreeMapCanvasBridge. Also, any updates
20+
to the layer tree cause refresh of the list.
21+
22+
.. seealso:: QgsLayerTreeMapCanvasBridge
23+
.. versionadded:: 2.4
1524
%End
1625

26+
%TypeHeaderCode
27+
#include "qgscustomlayerorderwidget.h"
28+
%End
1729
public:
1830
explicit QgsCustomLayerOrderWidget( QgsLayerTreeMapCanvasBridge *bridge, QWidget *parent /TransferThis/ = 0 );
31+
32+
signals:
33+
1934
};
35+
36+
37+
38+
/************************************************************************
39+
* This file has been generated automatically from *
40+
* *
41+
* src/gui/layertree/qgscustomlayerorderwidget.h *
42+
* *
43+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
44+
************************************************************************/

‎python/gui/layertree/qgslayertreeembeddedconfigwidget.sip‎

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,44 @@
1+
/************************************************************************
2+
* This file has been generated automatically from *
3+
* *
4+
* src/gui/layertree/qgslayertreeembeddedconfigwidget.h *
5+
* *
6+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
7+
************************************************************************/
8+
19

2-
/** \ingroup gui
3-
* \class QgsLayerTreeEmbeddedConfigWidget
4-
* A widget to configure layer tree embedded widgets for a particular map layer.
5-
* @note introduced in QGIS 2.16
6-
*/
7-
class QgsLayerTreeEmbeddedConfigWidget : public QWidget
8-
{
9-
%TypeHeaderCode
10-
#include <qgslayertreeembeddedconfigwidget.h>
11-
%End
1210

11+
12+
class QgsLayerTreeEmbeddedConfigWidget : public QWidget, protected Ui::QgsLayerTreeEmbeddedConfigWidget
13+
%Docstring
14+
A widget to configure layer tree embedded widgets for a particular map layer.
15+
.. versionadded:: 2.16
16+
%End
17+
{
1318
public:
19+
1420
QgsLayerTreeEmbeddedConfigWidget( QWidget *parent /TransferThis/ = 0 );
21+
%Docstring
22+
A widget to configure layer tree embedded widgets for a particular map layer.
23+
\param parent The parent of the widget.
24+
%End
1525

16-
//! Initialize widget with a map layer
1726
void setLayer( QgsMapLayer *layer );
27+
%Docstring
28+
Initialize widget with a map layer
29+
%End
1830

19-
//! Store changes made in the widget to the layer
2031
void applyToLayer();
32+
%Docstring
33+
Store changes made in the widget to the layer
34+
%End
2135

2236
};
37+
38+
/************************************************************************
39+
* This file has been generated automatically from *
40+
* *
41+
* src/gui/layertree/qgslayertreeembeddedconfigwidget.h *
42+
* *
43+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
44+
************************************************************************/

‎python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip‎

Lines changed: 85 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,123 @@
1+
/************************************************************************
2+
* This file has been generated automatically from *
3+
* *
4+
* src/gui/layertree/qgslayertreeembeddedwidgetregistry.h *
5+
* *
6+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
7+
************************************************************************/
8+
9+
10+
11+
112

2-
/** \ingroup gui
3-
* \class QgsLayerTreeEmbeddedWidgetProvider
4-
* Provider interface to be implemented in order to introduce new kinds of embedded widgets for use in layer tree.
5-
* Embedded widgets are assigned per individual map layers and they are shown before any legend entries.
6-
* @see QgsLayerTreeEmbeddedWidgetRegistry
7-
* @note introduced in QGIS 2.16
8-
*/
913
class QgsLayerTreeEmbeddedWidgetProvider
1014
{
11-
%TypeHeaderCode
12-
#include <qgslayertreeembeddedwidgetregistry.h>
15+
%Docstring
16+
Provider interface to be implemented in order to introduce new kinds of embedded widgets for use in layer tree.
17+
Embedded widgets are assigned per individual map layers and they are shown before any legend entries.
18+
.. seealso:: QgsLayerTreeEmbeddedWidgetRegistry
19+
.. versionadded:: 2.16
1320
%End
1421

22+
%TypeHeaderCode
23+
#include "qgslayertreeembeddedwidgetregistry.h"
24+
%End
1525
public:
1626
virtual ~QgsLayerTreeEmbeddedWidgetProvider();
1727

18-
//! Unique name of the provider (among other providers)
1928
virtual QString id() const = 0;
29+
%Docstring
30+
Unique name of the provider (among other providers)
31+
:rtype: str
32+
%End
2033

21-
//! Human readable name - may be translatable with tr()
2234
virtual QString name() const = 0;
35+
%Docstring
36+
Human readable name - may be translatable with tr()
37+
:rtype: str
38+
%End
2339

24-
//! Factory to create widgets. The returned widget is owned by the caller.
25-
//! The widgetIndex argument may be used to identify which widget is being
26-
//! created (useful when using multiple widgets from the same provider for one layer).
2740
virtual QWidget *createWidget( QgsMapLayer *layer, int widgetIndex ) = 0 /Factory/;
41+
%Docstring
42+
created (useful when using multiple widgets from the same provider for one layer).
43+
:rtype: QWidget
44+
%End
2845

29-
//! Whether it makes sense to use this widget for a particular layer
3046
virtual bool supportsLayer( QgsMapLayer *layer ) = 0;
47+
%Docstring
48+
Whether it makes sense to use this widget for a particular layer
49+
:rtype: bool
50+
%End
3151
};
3252

33-
/** \ingroup gui
34-
* \class QgsLayerTreeEmbeddedWidgetRegistry
35-
* Registry of widgets that may be embedded into layer tree view.
36-
* Embedded widgets are assigned per individual map layers and they are shown before any legend entries.
37-
* Layer tree must have UseEmbeddedWidgets flag enabled in order to show assigned widgets.
38-
*
39-
* @see QgsLayerTreeEmbeddedWidgetRegistry
40-
* @note introduced in QGIS 2.16
41-
*/
4253
class QgsLayerTreeEmbeddedWidgetRegistry
4354
{
44-
%TypeHeaderCode
45-
#include <qgslayertreeembeddedwidgetregistry.h>
55+
%Docstring
56+
Registry of widgets that may be embedded into layer tree view.
57+
Embedded widgets are assigned per individual map layers and they are shown before any legend entries.
58+
Layer tree must have UseEmbeddedWidgets flag enabled in order to show assigned widgets.
59+
60+
QgsLayerTreeEmbeddedWidgetRegistry is not usually directly created, but rather accessed through
61+
QgsGui.layerTreeEmbeddedWidgetRegistry().
62+
63+
.. seealso:: QgsLayerTreeEmbeddedWidgetRegistry
64+
.. versionadded:: 2.16
4665
%End
4766

67+
%TypeHeaderCode
68+
#include "qgslayertreeembeddedwidgetregistry.h"
69+
%End
4870
public:
4971

5072
QgsLayerTreeEmbeddedWidgetRegistry();
73+
%Docstring
74+
Constructor for QgsLayerTreeEmbeddedWidgetRegistry
75+
76+
QgsLayerTreeEmbeddedWidgetRegistry is not usually directly created, but rather accessed through
77+
QgsGui.layerTreeEmbeddedWidgetRegistry().
78+
%End
5179

5280
~QgsLayerTreeEmbeddedWidgetRegistry();
5381

54-
/** Return list of all registered providers */
82+
5583
QStringList providers() const;
84+
%Docstring
85+
Return list of all registered providers
86+
:rtype: list of str
87+
%End
5688

57-
/** Get provider object from the provider's ID */
5889
QgsLayerTreeEmbeddedWidgetProvider *provider( const QString &providerId ) const;
90+
%Docstring
91+
Get provider object from the provider's ID
92+
:rtype: QgsLayerTreeEmbeddedWidgetProvider
93+
%End
5994
60-
/** Register a provider, takes ownership of the object.
61-
* Returns true on success, false if the provider is already registered. */
6295
bool addProvider( QgsLayerTreeEmbeddedWidgetProvider *provider /Transfer/ );
96+
%Docstring
97+
Register a provider, takes ownership of the object.
98+
Returns true on success, false if the provider is already registered. *
99+
:rtype: bool
100+
%End
63101
64-
/** Unregister a provider, the provider object is deleted.
65-
* Returns true on success, false if the provider was not registered. */
66102
bool removeProvider( const QString &providerId );
103+
%Docstring
104+
Unregister a provider, the provider object is deleted.
105+
Returns true on success, false if the provider was not registered. *
106+
:rtype: bool
107+
%End
108+
109+
protected:
67110
68-
private:
69111
112+
private:
70113
QgsLayerTreeEmbeddedWidgetRegistry( const QgsLayerTreeEmbeddedWidgetRegistry &other );
71114
};
115+
116+
117+
/************************************************************************
118+
* This file has been generated automatically from *
119+
* *
120+
* src/gui/layertree/qgslayertreeembeddedwidgetregistry.h *
121+
* *
122+
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
123+
************************************************************************/

0 commit comments

Comments
 (0)