Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkcolorsel.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkColorSelection
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 a widget used to select a color.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkColorSelection is a widget that is used to select
  10 a color.  It consists of a color wheel and number of sliders
  11 and entry boxes for color parameters such as hue, saturation,
  12 value, red, green, blue, and opacity.  It is found on the standard
  13 color selection dialog box #GtkColorSelectionDialog.
  14 </para>
  15
  16 <!-- ##### SECTION See_Also ##### -->
  17 <para>
  18
  19 </para>
  20
  21 <!-- ##### STRUCT GtkColorSelection ##### -->
  22 <para>
  23 The #GtkColorSelection-struct struct contains private data only,
  24 and should be accessed using the functions below.
  25 </para>
  26
  27
  28 <!-- ##### FUNCTION gtk_color_selection_new ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @Returns:
  34
  35
  36 <!-- ##### FUNCTION gtk_color_selection_set_update_policy ##### -->
  37 <para>
  38 Sets the policy controlling when the color_changed signals are emitted.
  39 The available policies are:
  40 <itemizedlist>
  41 <listitem>
  42 <para>
  43 %GTK_UPDATE_CONTINUOUS - signals are sent continuously as the color
  44 selection changes.
  45 </para>
  46 </listitem>
  47 <listitem>
  48 <para>
  49 %GTK_UPDATE_DISCONTINUOUS - signals are sent only when the mouse
  50 button is released.
  51 </para>
  52 </listitem>
  53 <listitem>
  54 <para>
  55 %GTK_UPDATE_DELAYED - signals are sent when the mouse button is
  56 released or when the mouse has been motionless for a period of
  57 time.
  58 </para>
  59 </listitem>
  60 </itemizedlist>
  61 </para>
  62
  63 @colorsel: a #GtkColorSelection.
  64 @policy: a #GtkUpdateType value indicating the desired policy.
  65
  66
  67 <!-- ##### FUNCTION gtk_color_selection_set_has_opacity_control ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @colorsel:
  73 @has_opacity:
  74
  75
  76 <!-- ##### FUNCTION gtk_color_selection_get_has_opacity_control ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @colorsel:
  82 @Returns:
  83
  84
  85 <!-- ##### FUNCTION gtk_color_selection_set_has_palette ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @colorsel:
  91 @has_palette:
  92
  93
  94 <!-- ##### FUNCTION gtk_color_selection_get_has_palette ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @colorsel:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION gtk_color_selection_get_current_alpha ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @colorsel:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION gtk_color_selection_set_current_alpha ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @colorsel:
 118 @alpha:
 119
 120
 121 <!-- ##### FUNCTION gtk_color_selection_get_current_color ##### -->
 122 <para>
 123
 124 </para>
 125
 126 @colorsel:
 127 @color:
 128
 129
 130 <!-- ##### FUNCTION gtk_color_selection_set_current_color ##### -->
 131 <para>
 132
 133 </para>
 134
 135 @colorsel:
 136 @color:
 137
 138
 139 <!-- ##### FUNCTION gtk_color_selection_get_previous_alpha ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @colorsel:
 145 @Returns:
 146
 147
 148 <!-- ##### FUNCTION gtk_color_selection_set_previous_alpha ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @colorsel:
 154 @alpha:
 155
 156
 157 <!-- ##### FUNCTION gtk_color_selection_get_previous_color ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @colorsel:
 163 @color:
 164
 165
 166 <!-- ##### FUNCTION gtk_color_selection_set_previous_color ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @colorsel:
 172 @color:
 173
 174
 175 <!-- ##### FUNCTION gtk_color_selection_is_adjusting ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @colorsel:
 181 @Returns:
 182
 183
 184 <!-- ##### FUNCTION gtk_color_selection_palette_from_string ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @str:
 190 @colors:
 191 @n_colors:
 192 @Returns:
 193
 194
 195 <!-- ##### FUNCTION gtk_color_selection_palette_to_string ##### -->
 196 <para>
 197
 198 </para>
 199
 200 @colors:
 201 @n_colors:
 202 @Returns:
 203
 204
 205 <!-- ##### FUNCTION gtk_color_selection_set_change_palette_hook ##### -->
 206 <para>
 207
 208 </para>
 209
 210 @func:
 211 @Returns:
 212
 213
 214 <!-- ##### USER_FUNCTION GtkColorSelectionChangePaletteFunc ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @colors:
 220 @n_colors:
 221
 222
 223 <!-- ##### FUNCTION gtk_color_selection_set_change_palette_with_screen_hook ##### -->
 224 <para>
 225
 226 </para>
 227
 228 @func:
 229 @Returns:
 230
 231
 232 <!-- ##### USER_FUNCTION GtkColorSelectionChangePaletteWithScreenFunc ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @screen:
 238 @colors:
 239 @n_colors:
 240
 241
 242 <!-- ##### FUNCTION gtk_color_selection_set_color ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @colorsel:
 248 @color:
 249
 250
 251 <!-- ##### FUNCTION gtk_color_selection_get_color ##### -->
 252 <para>
 253
 254 </para>
 255
 256 @colorsel:
 257 @color:
 258
 259
 260 <!-- ##### SIGNAL GtkColorSelection::color-changed ##### -->
 261 <para>
 262 This signal is emitted when the color changes in the #GtkColorSelection
 263 according to its update policy.
 264 </para>
 265
 266 @colorselection: the object which received the signal.
 267
 268 <!-- ##### ARG GtkColorSelection:has-palette ##### -->
 269 <para>
 270
 271 </para>
 272
 273 <!-- ##### ARG GtkColorSelection:has-opacity-control ##### -->
 274 <para>
 275
 276 </para>
 277
 278 <!-- ##### ARG GtkColorSelection:current-color ##### -->
 279 <para>
 280
 281 </para>
 282
 283 <!-- ##### ARG GtkColorSelection:current-alpha ##### -->
 284 <para>
 285
 286 </para>
 287