]> Pileus Git - ~andy/gtk/blob - gtk/gtkcolorchooserdialog.c
Add docs
[~andy/gtk] / gtk / gtkcolorchooserdialog.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 2012 Red Hat, Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #include "config.h"
21
22 #include "gtkdialog.h"
23 #include "gtkstock.h"
24 #include "gtkbox.h"
25 #include "gtkprivate.h"
26 #include "gtkintl.h"
27
28 #include "gtkcolorchooserprivate.h"
29 #include "gtkcolorchooserdialog.h"
30 #include "gtkcolorchooserwidget.h"
31
32 /**
33  * SECTION:gtkcolorchooserdialog
34  * @Short_description: A dialog for choosing colors
35  * @Title: GtkColorChooserDialog
36  * @See_also: #GtkColorChooser, #GtkDialog
37  *
38  * The #GtkColorChooserDialog widget is a dialog for choosing
39  * a color. It implements the #GtkColorChooser interface.
40  *
41  * Since: 3.4
42  */
43
44 struct _GtkColorChooserDialogPrivate
45 {
46   GtkWidget *chooser;
47
48   GtkWidget *select_button;
49   GtkWidget *cancel_button;
50 };
51
52 enum
53 {
54   PROP_ZERO,
55   PROP_RGBA,
56   PROP_USE_ALPHA,
57   PROP_SHOW_EDITOR
58 };
59
60 static void gtk_color_chooser_dialog_iface_init (GtkColorChooserInterface *iface);
61
62 G_DEFINE_TYPE_WITH_CODE (GtkColorChooserDialog, gtk_color_chooser_dialog, GTK_TYPE_DIALOG,
63                          G_IMPLEMENT_INTERFACE (GTK_TYPE_COLOR_CHOOSER,
64                                                 gtk_color_chooser_dialog_iface_init))
65
66 static void
67 propagate_notify (GObject               *o,
68                   GParamSpec            *pspec,
69                   GtkColorChooserDialog *cc)
70 {
71   g_object_notify (G_OBJECT (cc), "rgba");
72 }
73
74 static void
75 color_activated_cb (GtkColorChooser *chooser,
76                     GdkRGBA         *color,
77                     GtkDialog       *dialog)
78 {
79   gtk_dialog_response (dialog, GTK_RESPONSE_OK);
80 }
81
82 static void
83 gtk_color_chooser_dialog_init (GtkColorChooserDialog *cc)
84 {
85   GtkColorChooserDialogPrivate *priv;
86   GtkDialog *dialog = GTK_DIALOG (cc);
87   GtkWidget *action_area, *content_area;
88
89   cc->priv = G_TYPE_INSTANCE_GET_PRIVATE (cc,
90                                           GTK_TYPE_COLOR_CHOOSER_DIALOG,
91                                           GtkColorChooserDialogPrivate);
92   priv = cc->priv;
93
94   content_area = gtk_dialog_get_content_area (dialog);
95   action_area = gtk_dialog_get_action_area (dialog);
96
97   gtk_container_set_border_width (GTK_CONTAINER (dialog), 5);
98   gtk_box_set_spacing (GTK_BOX (content_area), 2); /* 2 * 5 + 2 = 12 */
99   gtk_container_set_border_width (GTK_CONTAINER (action_area), 5);
100   gtk_box_set_spacing (GTK_BOX (action_area), 6);
101
102   gtk_widget_push_composite_child ();
103
104   gtk_window_set_resizable (GTK_WINDOW (cc), FALSE);
105
106   /* Create the content area */
107   priv->chooser = gtk_color_chooser_widget_new ();
108   gtk_container_set_border_width (GTK_CONTAINER (priv->chooser), 5);
109   gtk_widget_show (priv->chooser);
110   gtk_box_pack_start (GTK_BOX (content_area),
111                       priv->chooser, TRUE, TRUE, 0);
112
113   g_signal_connect (priv->chooser, "notify::rgba",
114                     G_CALLBACK (propagate_notify), cc);
115
116   g_signal_connect (priv->chooser, "color-activated",
117                     G_CALLBACK (color_activated_cb), cc);
118
119   /* Create the action area */
120   priv->cancel_button = gtk_dialog_add_button (dialog,
121                                                GTK_STOCK_CANCEL,
122                                                GTK_RESPONSE_CANCEL);
123   priv->select_button = gtk_dialog_add_button (dialog,
124                                                _("_Select"),
125                                                GTK_RESPONSE_OK);
126   gtk_widget_grab_default (priv->select_button);
127
128   gtk_dialog_set_alternative_button_order (dialog,
129                                            GTK_RESPONSE_OK,
130                                            GTK_RESPONSE_CANCEL,
131                                            -1);
132
133   gtk_window_set_title (GTK_WINDOW (cc), _("Select a Color"));
134
135   gtk_widget_pop_composite_child ();
136 }
137
138 static void
139 gtk_color_chooser_dialog_response (GtkDialog *dialog,
140                                    gint       response_id)
141 {
142   if (response_id == GTK_RESPONSE_OK)
143     {
144       GdkRGBA color;
145
146       gtk_color_chooser_get_rgba (GTK_COLOR_CHOOSER (dialog), &color);
147       gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (dialog), &color);
148     }
149
150   g_object_set (GTK_COLOR_CHOOSER_DIALOG (dialog)->priv->chooser,
151                 "show-editor", FALSE, NULL);
152 }
153
154 static void
155 gtk_color_chooser_dialog_get_property (GObject    *object,
156                                        guint       prop_id,
157                                        GValue     *value,
158                                        GParamSpec *pspec)
159 {
160   GtkColorChooserDialog *cd = GTK_COLOR_CHOOSER_DIALOG (object);
161   GtkColorChooser *cc = GTK_COLOR_CHOOSER (object);
162
163   switch (prop_id)
164     {
165     case PROP_RGBA:
166       {
167         GdkRGBA color;
168
169         gtk_color_chooser_get_rgba (cc, &color);
170         g_value_set_boxed (value, &color);
171       }
172       break;
173     case PROP_USE_ALPHA:
174       g_value_set_boolean (value, gtk_color_chooser_get_use_alpha (GTK_COLOR_CHOOSER (cd->priv->chooser)));
175       break;
176     case PROP_SHOW_EDITOR:
177       {
178         gboolean show_editor;
179         g_object_get (cd->priv->chooser, "show-editor", &show_editor, NULL);
180         g_value_set_boolean (value, show_editor);
181       }
182       break;
183     default:
184       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
185       break;
186     }
187 }
188
189 static void
190 gtk_color_chooser_dialog_set_property (GObject      *object,
191                                        guint         prop_id,
192                                        const GValue *value,
193                                        GParamSpec   *pspec)
194 {
195   GtkColorChooserDialog *cd = GTK_COLOR_CHOOSER_DIALOG (object);
196   GtkColorChooser *cc = GTK_COLOR_CHOOSER (object);
197
198   switch (prop_id)
199     {
200     case PROP_RGBA:
201       gtk_color_chooser_set_rgba (cc, g_value_get_boxed (value));
202       break;
203     case PROP_USE_ALPHA:
204       gtk_color_chooser_set_use_alpha (GTK_COLOR_CHOOSER (cd->priv->chooser), g_value_get_boolean (value));
205       break;
206     case PROP_SHOW_EDITOR:
207       g_object_set (cd->priv->chooser,
208                     "show-editor", g_value_get_boolean (value),
209                     NULL);
210       break;
211     default:
212       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
213       break;
214     }
215 }
216
217 static void
218 gtk_color_chooser_dialog_class_init (GtkColorChooserDialogClass *class)
219 {
220   GObjectClass *object_class = G_OBJECT_CLASS (class);
221   GtkDialogClass *dialog_class = GTK_DIALOG_CLASS (class);
222
223   object_class->get_property = gtk_color_chooser_dialog_get_property;
224   object_class->set_property = gtk_color_chooser_dialog_set_property;
225
226   dialog_class->response = gtk_color_chooser_dialog_response;
227
228   g_object_class_override_property (object_class, PROP_RGBA, "rgba");
229   g_object_class_override_property (object_class, PROP_USE_ALPHA, "use-alpha");
230   g_object_class_install_property (object_class, PROP_SHOW_EDITOR,
231       g_param_spec_boolean ("show-editor", P_("Show editor"), P_("Show editor"),
232                             FALSE, GTK_PARAM_READWRITE));
233
234
235   g_type_class_add_private (class, sizeof (GtkColorChooserDialogPrivate));
236 }
237
238 static void
239 gtk_color_chooser_dialog_get_rgba (GtkColorChooser *chooser,
240                                    GdkRGBA         *color)
241 {
242   GtkColorChooserDialog *cc = GTK_COLOR_CHOOSER_DIALOG (chooser);
243
244   gtk_color_chooser_get_rgba (GTK_COLOR_CHOOSER (cc->priv->chooser), color);
245 }
246
247 static void
248 gtk_color_chooser_dialog_set_rgba (GtkColorChooser *chooser,
249                                    const GdkRGBA   *color)
250 {
251   GtkColorChooserDialog *cc = GTK_COLOR_CHOOSER_DIALOG (chooser);
252
253   gtk_color_chooser_set_rgba (GTK_COLOR_CHOOSER (cc->priv->chooser), color);
254 }
255
256 static void
257 gtk_color_chooser_dialog_iface_init (GtkColorChooserInterface *iface)
258 {
259   iface->get_rgba = gtk_color_chooser_dialog_get_rgba;
260   iface->set_rgba = gtk_color_chooser_dialog_set_rgba;
261 }
262
263 /**
264  * gtk_color_chooser_dialog_new:
265  * @title: (allow-none): Title of the dialog, or %NULL
266  * @parent: (allow-none): Transient parent of the dialog, or %NULL
267  *
268  * Creates a new #GtkColorChooserDialog.
269  *
270  * Return value: a new #GtkColorChooserDialog
271  *
272  * Since: 3.4
273  */
274 GtkWidget *
275 gtk_color_chooser_dialog_new (const gchar *title,
276                               GtkWindow   *parent)
277 {
278   GtkColorChooserDialog *dialog;
279
280   dialog = g_object_new (GTK_TYPE_COLOR_CHOOSER_DIALOG,
281                          "title", title,
282                          "transient-for", parent,
283                          NULL);
284
285   return GTK_WIDGET (dialog);
286 }