← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gtkmm3.0/quantal

« back to all changes in this revision

Viewing changes to gtk/gtkmm/colorbutton.h

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-03-01 23:42:36 UTC
  • mfrom: (1.1.8)
  • Revision ID: package-import@ubuntu.com-20120301234236-12w6m0hkomhi7h53
Tags: 3.3.16-0ubuntu1
* New upstream version
* debian/control.in: updated the glib requirement

Show diffs side-by-side

added added

removed removed

Lines of Context:
gtk/gtkmm/colorbutton.h
106
106
  //GTK+ Virtual Functions (override these to change behaviour):
107
107
 
108
108
  //Default Signal Handlers::
 
109
  /// This is a default handler for the signal signal_color_set().
109
110
  virtual void on_color_set();
110
111
 
111
112
 
125
126
  ColorButton();
126
127
  
127
128
 
 
129
#ifndef GTKMM_DISABLE_DEPRECATED
128
130
  /** Creates a new color button with a predefined color.
129
131
   *
130
132
   * Same as Gtk::ColorButton::ColorButton(). Additionally takes a Gdk::Color and
134
136
   * @param color A Gdk::Color to set the current color with.
135
137
   *
136
138
   * @newin{2,4}
 
139
   * @deprecated "Use the constructor that takes a Gdk::RGBA instead."
137
140
   */
138
141
    explicit ColorButton(const Gdk::Color& color);
139
142
 
 
143
#endif //GTKMM_DISABLE_DEPRECATED
140
144
 
141
145
  /** Creates a new color button with a predefined color.
142
146
   *
151
155
    explicit ColorButton(const Gdk::RGBA& rgba);
152
156
 
153
157
 
 
158
#ifndef GTKMM_DISABLE_DEPRECATED
 
159
 
154
160
  /** Sets the current color to be @a color.
155
161
   * 
156
162
   * @newin{2,4}
 
163
   * 
 
164
   * Deprecated: Use set_rgba() instead.
 
165
   * @deprecated Use set_rgba() instead.
157
166
   * @param color A Gdk::Color to set the current color with.
158
167
   */
159
168
  void set_color(const Gdk::Color& color);
160
 
  
 
169
#endif // GTKMM_DISABLE_DEPRECATED
 
170
 
 
171
 
 
172
#ifndef GTKMM_DISABLE_DEPRECATED
 
173
 
161
174
  /** Sets the current opacity to be @a alpha.
162
175
   * 
163
176
   * @newin{2,4}
 
177
   * @deprecated Use set_rgba() instead.
164
178
   * @param alpha An integer between 0 and 65535.
165
179
   */
166
180
  void set_alpha(guint16 alpha);
167
 
  
 
181
#endif // GTKMM_DISABLE_DEPRECATED
 
182
 
 
183
 
168
184
  /** Sets the current color to be @a rgba.
169
185
   * 
170
186
   * @newin{3,0}
235
251
  Glib::ustring get_title() const;
236
252
 
237
253
  #ifdef GLIBMM_PROPERTIES_ENABLED
238
 
/** Whether to give the color an alpha value.
 
254
/** 
239
255
   *
240
256
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
241
257
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
255
271
#endif //#GLIBMM_PROPERTIES_ENABLED
256
272
 
257
273
  #ifdef GLIBMM_PROPERTIES_ENABLED
258
 
/** The title of the color selection dialog.
 
274
/** 
259
275
   *
260
276
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
261
277
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
274
290
  Glib::PropertyProxy_ReadOnly< Glib::ustring > property_title() const;
275
291
#endif //#GLIBMM_PROPERTIES_ENABLED
276
292
 
277
 
  #ifdef GLIBMM_PROPERTIES_ENABLED
278
 
/** The selected color.
 
293
  
 
294
#ifndef GTKMM_DISABLE_DEPRECATED
 
295
 
 
296
#ifdef GLIBMM_PROPERTIES_ENABLED
 
297
/** 
279
298
   *
280
299
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
281
300
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
286
305
 
287
306
#ifdef GLIBMM_PROPERTIES_ENABLED
288
307
/** The selected color.
 
308
   * @deprecated Use property_rgba() instead.
289
309
   *
290
310
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
291
311
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
293
313
   */
294
314
  Glib::PropertyProxy_ReadOnly< Gdk::Color > property_color() const;
295
315
#endif //#GLIBMM_PROPERTIES_ENABLED
296
 
 //TODO: Deprecated
 
316
 
 
317
#endif // GTKMM_DISABLE_DEPRECATED
 
318
 
297
319
  #ifdef GLIBMM_PROPERTIES_ENABLED
298
 
/** The selected RGBA color.
 
320
/** 
299
321
   *
300
322
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
301
323
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
315
337
#endif //#GLIBMM_PROPERTIES_ENABLED
316
338
 
317
339
  #ifdef GLIBMM_PROPERTIES_ENABLED
318
 
/** The selected opacity value (0 fully transparent, 65535 fully opaque).
 
340
/** 
319
341
   *
320
342
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
321
343
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
335
357
#endif //#GLIBMM_PROPERTIES_ENABLED
336
358
 //Todo: Remove thsi when we remove the "color" property too.
337
359
 
338
 
  /** The color_set signal is emitted when the user selects a color. When handling this signal,
339
 
   * use get_color() and get_alpha() to find out which color
340
 
   * was just selected.
341
 
   *
342
 
   * @par Prototype:
 
360
  
 
361
  /**
 
362
   * @par Slot Prototype:
343
363
   * <tt>void on_my_%color_set()</tt>
 
364
   *
 
365
   * The signal_color_set() signal is emitted when the user selects a color.
 
366
   * When handling this signal, use Gtk::ColorButton::get_color() and
 
367
   * Gtk::ColorButton::get_alpha() (or Gtk::ColorButton::get_rgba()) to
 
368
   * find out which color was just selected.
 
369
   * 
 
370
   * Note that this signal is only emitted when the <em>user</em>
 
371
   * changes the color. If you need to react to programmatic color changes
 
372
   * as well, use the notify::color signal.
 
373
   * 
 
374
   * @newin{2,4}
344
375
   */
345
376
 
 
377
 
346
378
  Glib::SignalProxy0< void > signal_color_set();
347
379
 
348
380