File: qgscolordialog.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 (100 lines) | stat: -rw-r--r-- 3,054 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgscolordialog.h                                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsColorDialog : QDialog
{
%Docstring(signature="appended")
A custom QGIS dialog for selecting a color. Has many improvements over
the standard Qt color picker dialog, including hue wheel supports, color
swatches, and a color sampler.
%End

%TypeHeaderCode
#include "qgscolordialog.h"
%End
  public:
    QgsColorDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, const QColor &color = QColor() );
%Docstring
Create a new color picker dialog

:param parent: parent widget
:param fl: window flags
:param color: initial color for dialog
%End

    QColor color() const;
%Docstring
Returns the current color for the dialog

:return: dialog color
%End

    void setTitle( const QString &title );
%Docstring
Sets the title for the color dialog

:param title: title for dialog box
%End

    void setAllowOpacity( bool allowOpacity );
%Docstring
Sets whether opacity modification (transparency) is permitted for the
color dialog. Defaults to ``True``.

:param allowOpacity: set to ``False`` to disable opacity modification
%End

    static QColor getColor( const QColor &initialColor, QWidget *parent, const QString &title = QString(), bool allowOpacity = false );
%Docstring
Returns a color selection from a color dialog.

:param initialColor: the initial color of the selection dialog.
:param parent: parent widget
:param title: the title of the dialog.
:param allowOpacity: set to ``True`` to allow modification of color
                     opacity value (transparency)

:return: Selected color on :py:func:`~QgsColorDialog.accepted` or
         initialColor on :py:func:`~QgsColorDialog.rejected`.
%End

  signals:

    void currentColorChanged( const QColor &color );
%Docstring
Emitted when the dialog's color changes

:param color: current color
%End

  public slots:

    void setColor( const QColor &color );
%Docstring
Sets the current color for the dialog

:param color: desired color
%End

  protected:
    virtual void closeEvent( QCloseEvent *e );


};

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