File: qgsstyleitemslistwidget.sip.in

package info (click to toggle)
qgis 3.22.16%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,186,020 kB
  • sloc: cpp: 1,275,562; python: 194,091; xml: 15,597; perl: 3,471; sh: 3,368; sql: 2,485; ansic: 2,219; yacc: 1,056; lex: 574; javascript: 504; lisp: 411; makefile: 227
file content (119 lines) | stat: -rw-r--r-- 3,363 bytes parent folder | download
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsstyleitemslistwidget.h                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/







class QgsStyleItemsListWidget : QWidget
{
%Docstring(signature="appended")
A reusable widget for showing a filtered list of entities from a :py:class:`QgsStyle` database.

.. versionadded:: 3.10
%End

%TypeHeaderCode
#include "qgsstyleitemslistwidget.h"
%End
  public:

    QgsStyleItemsListWidget( QWidget *parent /TransferThis/ );
%Docstring
Constructor for QgsStyleItemsListWidget, with the specified ``parent`` widget.
%End

    void setStyle( QgsStyle *style );
%Docstring
Sets the ``style`` database associated with the widget.

Ownership of ``style`` is not transferred, and the caller is responsible for ensuring that
it exists for the lifetime of the widget.
%End

    void setEntityType( QgsStyle::StyleEntity type );
%Docstring
Sets the ``type`` of style entity to show in the widget.

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


    void setSymbolType( Qgis::SymbolType type );
%Docstring
Sets the ``type`` of symbols to show in the widget.

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

    void setLayerType( QgsWkbTypes::GeometryType type );
%Docstring
Sets the layer ``type`` to show in the widget. Set ``type`` to :py:class:`QgsWkbTypes`.UnknownGeometry if no
layer type filter is desired.

This setting only applies to label settings and 3d style entities.
%End

    QString currentTagFilter() const;
%Docstring
Returns the current tag filter set for the widget, if any is set.
%End


    QString currentItemName() const;
%Docstring
Returns the name of the item currently selected in the widget.

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

    QgsStyle::StyleEntity currentEntityType() const;
%Docstring
Returns the type of the item currently selected in the widget.

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

  protected:

    virtual void showEvent( QShowEvent *event );


  signals:

    void selectionChanged( const QString &name, QgsStyle::StyleEntity type );
%Docstring
Emitted when the selected item is changed in the widget.

:param name: Newly selected item name
:param type: Newly selected item type
%End

    void saveEntity();
%Docstring
Emitted when the user has opted to save a new entity to the style
database, by clicking the "Save" button in the widget.

It is the caller's responsibility to handle this in an appropriate
manner given the context of the widget.
%End

};




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