File: qgslabelsettingswidgetbase.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (146 lines) | stat: -rw-r--r-- 4,310 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/labeling/qgslabelsettingswidgetbase.h                        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsLabelSettingsWidgetBase : QgsPanelWidget, protected QgsExpressionContextGenerator
{
%Docstring(signature="appended")
Base class for widgets which allow customization of label engine
properties, such as label placement settings.

.. versionadded:: 3.12
%End

%TypeHeaderCode
#include "qgslabelsettingswidgetbase.h"
%End
  public:
    QgsLabelSettingsWidgetBase( QWidget *parent /TransferThis/ = 0, QgsVectorLayer *vl = 0 );
%Docstring
Constructor for QgsLabelSettingsWidgetBase.

:param parent: parent widget
:param vl: associated vector layer
%End

    virtual void setContext( const QgsSymbolWidgetContext &context );
%Docstring
Sets the ``context`` in which the symbol widget is shown, e.g., the
associated map canvas and expression contexts.

.. seealso:: :py:func:`context`
%End

    QgsSymbolWidgetContext context() const;
%Docstring
Returns the context in which the symbol widget is shown, e.g., the
associated map canvas and expression contexts.

.. seealso:: :py:func:`setContext`
%End

    virtual void setGeometryType( Qgis::GeometryType type );
%Docstring
Sets the geometry ``type`` of the features to customize the widget
accordingly.
%End

    QgsPropertyCollection dataDefinedProperties() const;
%Docstring
Returns the current data defined properties state as specified in the
widget.

.. seealso:: :py:func:`updateDataDefinedProperties`

.. seealso:: :py:func:`setDataDefinedProperties`
%End

    void setDataDefinedProperties( const QgsPropertyCollection &dataDefinedProperties );
%Docstring
Sets the current data defined properties to show in the widget.

.. seealso:: :py:func:`dataDefinedProperties`
%End

    virtual void updateDataDefinedProperties( QgsPropertyCollection &properties );
%Docstring
Updates a data defined ``properties`` collection, correctly setting the
values for any properties related to this widget.

.. seealso:: :py:func:`setDataDefinedProperties`

.. seealso:: :py:func:`dataDefinedProperties`
%End

  signals:

    void changed();
%Docstring
Emitted when any of the settings described by the widget are changed.
%End

    void auxiliaryFieldCreated();
%Docstring
Emitted when an auxiliary field is created in the widget.
%End

  protected:
    virtual QgsExpressionContext createExpressionContext() const;


    void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsPalLayerSettings::Property key );
%Docstring
Registers a data defined override ``button``. Handles setting up
connections for the button and initializing the button to show the
correct descriptions and help text for the associated property.
%End


};

class QgsLabelSettingsWidgetDialog : QDialog
{
%Docstring(signature="appended")
A blocking dialog containing a :py:class:`QgsLabelSettingsWidgetBase`.

.. versionadded:: 3.12
%End

%TypeHeaderCode
#include "qgslabelsettingswidgetbase.h"
%End
  public:
    QgsLabelSettingsWidgetDialog( QgsLabelSettingsWidgetBase *widget /Transfer/, QWidget *parent = 0 );
%Docstring
Constructor for QgsLabelSettingsWidgetDialog.

:param widget: label settings widget to embed in the dialog. Ownership
               is transferred to the dialog.
:param parent: parent widget
%End


    QDialogButtonBox *buttonBox();
%Docstring
Returns the dialog's button box.

.. versionadded:: 3.14
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/labeling/qgslabelsettingswidgetbase.h                        *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/