@@ -12,7 +12,7 @@ class QgsColorButton : QToolButton
12
12
{
13
13
%Docstring
14
14
A cross platform button subclass for selecting colors. Will open a color chooser dialog when clicked.
15
- Offers live updates to button from color chooser dialog. An attached drop down menu allows for copying
15
+ Offers live updates to button from color chooser dialog. An attached drop- down menu allows for copying
16
16
and pasting colors, picking colors from the screen, and selecting colors from color swatch grids.
17
17
.. versionadded:: 2.5
18
18
%End
@@ -40,7 +40,7 @@ class QgsColorButton : QToolButton
40
40
Construct a new color ramp button.
41
41
Use ``parent`` to attach a parent QWidget to the dialog.
42
42
Use ``cdt`` string to define the title to show in the color ramp dialog
43
- Use a color scheme ``registry`` for color swatch grids to show in the drop down menu. If not specified,
43
+ Use a color scheme ``registry`` for color swatch grids to show in the drop- down menu. If not specified,
44
44
the button will use the global color scheme registry instead
45
45
%End
46
46
@@ -106,16 +106,16 @@ class QgsColorButton : QToolButton
106
106
107
107
void setShowMenu( const bool showMenu );
108
108
%Docstring
109
- Sets whether the drop down menu should be shown for the button. The default behavior is to
109
+ Sets whether the drop- down menu should be shown for the button. The default behavior is to
110
110
show the menu.
111
- \param showMenu set to false to hide the drop down menu
111
+ \param showMenu set to false to hide the drop- down menu
112
112
.. seealso:: showMenu
113
113
%End
114
114
115
115
bool showMenu() const;
116
116
%Docstring
117
- Returns whether the drop down menu is shown for the button.
118
- :return: true if drop down menu is shown
117
+ Returns whether the drop- down menu is shown for the button.
118
+ :return: true if drop- down menu is shown
119
119
.. seealso:: setShowMenu
120
120
:rtype: bool
121
121
%End
@@ -138,7 +138,7 @@ class QgsColorButton : QToolButton
138
138
139
139
void setDefaultColor( const QColor &color );
140
140
%Docstring
141
- Sets the default color for the button, which is shown in the button's drop down menu for the
141
+ Sets the default color for the button, which is shown in the button's drop- down menu for the
142
142
"default color" option.
143
143
\param color default color for the button. Set to an invalid QColor to disable the default color
144
144
option.
@@ -147,7 +147,7 @@ class QgsColorButton : QToolButton
147
147
148
148
QColor defaultColor() const;
149
149
%Docstring
150
- Returns the default color for the button, which is shown in the button's drop down menu for the
150
+ Returns the default color for the button, which is shown in the button's drop- down menu for the
151
151
"default color" option.
152
152
:return: default color for the button. Returns an invalid QColor if the default color
153
153
option is disabled.
@@ -157,7 +157,7 @@ class QgsColorButton : QToolButton
157
157
158
158
void setShowNoColor( const bool showNoColorOption );
159
159
%Docstring
160
- Sets whether the "no color" option should be shown in the button's drop down menu. If selected,
160
+ Sets whether the "no color" option should be shown in the button's drop- down menu. If selected,
161
161
the "no color" option sets the color button's color to a totally transparent color.
162
162
\param showNoColorOption set to true to show the no color option. This is disabled by default.
163
163
.. seealso:: showNoColor
@@ -170,7 +170,7 @@ class QgsColorButton : QToolButton
170
170
171
171
bool showNoColor() const;
172
172
%Docstring
173
- Returns whether the "no color" option is shown in the button's drop down menu. If selected,
173
+ Returns whether the "no color" option is shown in the button's drop- down menu. If selected,
174
174
the "no color" option sets the color button's color to a totally transparent color.
175
175
:return: true if the no color option is shown.
176
176
.. seealso:: setShowNoColor
@@ -184,7 +184,7 @@ class QgsColorButton : QToolButton
184
184
185
185
void setNoColorString( const QString &noColorString );
186
186
%Docstring
187
- Sets the string to use for the "no color" option in the button's drop down menu.
187
+ Sets the string to use for the "no color" option in the button's drop- down menu.
188
188
\param noColorString string to use for the "no color" menu option
189
189
.. seealso:: noColorString
190
190
.. seealso:: setShowNoColor
@@ -196,7 +196,7 @@ class QgsColorButton : QToolButton
196
196
197
197
void setShowNull( bool showNull );
198
198
%Docstring
199
- Sets whether a set to null (clear) option is shown in the button's drop down menu.
199
+ Sets whether a set to null (clear) option is shown in the button's drop- down menu.
200
200
\param showNull set to true to show a null option
201
201
.. versionadded:: 2.16
202
202
.. seealso:: showNull()
@@ -205,7 +205,7 @@ class QgsColorButton : QToolButton
205
205
206
206
bool showNull() const;
207
207
%Docstring
208
- Returns whether the set to null (clear) option is shown in the button's drop down menu.
208
+ Returns whether the set to null (clear) option is shown in the button's drop- down menu.
209
209
.. versionadded:: 2.16
210
210
.. seealso:: setShowNull()
211
211
.. seealso:: isNull()
@@ -223,7 +223,7 @@ class QgsColorButton : QToolButton
223
223
224
224
QString noColorString() const;
225
225
%Docstring
226
- Returns the string used for the "no color" option in the button's drop down menu.
226
+ Returns the string used for the "no color" option in the button's drop- down menu.
227
227
:return: string used for the "no color" menu option
228
228
.. seealso:: setNoColorString
229
229
.. seealso:: showNoColor
@@ -237,7 +237,7 @@ class QgsColorButton : QToolButton
237
237
void setContext( const QString &context );
238
238
%Docstring
239
239
Sets the context string for the color button. The context string is passed to all color swatch
240
- grids shown in the button's drop down menu, to allow them to customise their display colors
240
+ grids shown in the button's drop- down menu, to allow them to customise their display colors
241
241
based on the context.
242
242
\param context context string for the color button's color swatch grids
243
243
.. seealso:: context
@@ -246,7 +246,7 @@ class QgsColorButton : QToolButton
246
246
QString context() const;
247
247
%Docstring
248
248
Returns the context string for the color button. The context string is passed to all color swatch
249
- grids shown in the button's drop down menu, to allow them to customise their display colors
249
+ grids shown in the button's drop- down menu, to allow them to customise their display colors
250
250
based on the context.
251
251
:return: context string for the color button's color swatch grids
252
252
.. seealso:: setContext
@@ -256,18 +256,18 @@ class QgsColorButton : QToolButton
256
256
void setColorSchemeRegistry( QgsColorSchemeRegistry *registry );
257
257
%Docstring
258
258
Sets the color scheme registry for the button, which controls the color swatch grids
259
- that are shown in the button's drop down menu.
259
+ that are shown in the button's drop- down menu.
260
260
\param registry color scheme registry for the button. Set to 0 to hide all color
261
- swatch grids from the button's drop down menu.
261
+ swatch grids from the button's drop- down menu.
262
262
.. seealso:: colorSchemeRegistry
263
263
%End
264
264
265
265
QgsColorSchemeRegistry *colorSchemeRegistry();
266
266
%Docstring
267
267
Returns the color scheme registry for the button, which controls the color swatch grids
268
- that are shown in the button's drop down menu.
268
+ that are shown in the button's drop- down menu.
269
269
:return: color scheme registry for the button. If returned value is 0 then all color
270
- swatch grids are hidden from the button's drop down menu.
270
+ swatch grids are hidden from the button's drop- down menu.
271
271
.. seealso:: setColorSchemeRegistry
272
272
:rtype: QgsColorSchemeRegistry
273
273
%End
0 commit comments