]> Pileus Git - ~andy/gtk/blob - gtk/gtkvolumebutton.c
[docs] Move documentation to inline comments: GtkVolumeButton
[~andy/gtk] / gtk / gtkvolumebutton.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 2007 Red Hat, Inc.
3  *
4  * Authors:
5  * - Bastien Nocera <bnocera@redhat.com>
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 /*
24  * Modified by the GTK+ Team and others 2007.  See the AUTHORS
25  * file for a list of people on the GTK+ Team.  See the ChangeLog
26  * files for a list of changes.  These files are distributed with
27  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
28  */
29
30 #include "config.h"
31
32 #include "gtkvolumebutton.h"
33 #include "gtkstock.h"
34 #include "gtktooltip.h"
35 #include "gtkintl.h"
36
37 #include "gtkalias.h"
38
39 /**
40  * SECTION:gtkvolumebutton
41  * @Short_description: A button which pops up a volume control
42  * @Title: GtkVolumeButton
43  *
44  * #GtkVolumeButton is a subclass of #GtkScaleButton that has
45  * been tailored for use as a volume control widget with suitable
46  * icons, tooltips and accessible labels.
47  */
48
49 #define EPSILON (1e-10)
50
51
52 static gboolean cb_query_tooltip (GtkWidget       *button,
53                                   gint             x,
54                                   gint             y,
55                                   gboolean         keyboard_mode,
56                                   GtkTooltip      *tooltip,
57                                   gpointer         user_data);
58 static void     cb_value_changed (GtkVolumeButton *button,
59                                   gdouble          value,
60                                   gpointer         user_data);
61
62 G_DEFINE_TYPE (GtkVolumeButton, gtk_volume_button, GTK_TYPE_SCALE_BUTTON)
63
64 static void
65 gtk_volume_button_class_init (GtkVolumeButtonClass *klass)
66 {
67 }
68
69 static void
70 gtk_volume_button_init (GtkVolumeButton *button)
71 {
72   GtkScaleButton *sbutton = GTK_SCALE_BUTTON (button);
73   GtkObject *adj;
74   const char *icons[] = {
75         "audio-volume-muted",
76         "audio-volume-high",
77         "audio-volume-low",
78         "audio-volume-medium",
79         NULL
80   };
81
82   atk_object_set_name (gtk_widget_get_accessible (GTK_WIDGET (button)),
83                        _("Volume"));
84   atk_object_set_description (gtk_widget_get_accessible (GTK_WIDGET (button)),
85                        _("Turns volume down or up"));
86   atk_action_set_description (ATK_ACTION (gtk_widget_get_accessible (GTK_WIDGET (button))),
87                               1,
88                               _("Adjusts the volume"));
89
90   atk_object_set_name (gtk_widget_get_accessible (sbutton->minus_button),
91                        _("Volume Down"));
92   atk_object_set_description (gtk_widget_get_accessible (sbutton->minus_button),
93                        _("Decreases the volume"));
94   gtk_widget_set_tooltip_text (sbutton->minus_button, _("Volume Down"));
95
96   atk_object_set_name (gtk_widget_get_accessible (sbutton->plus_button),
97                        _("Volume Up"));
98   atk_object_set_description (gtk_widget_get_accessible (sbutton->plus_button),
99                        _("Increases the volume"));
100   gtk_widget_set_tooltip_text (sbutton->plus_button, _("Volume Up"));
101
102   gtk_scale_button_set_icons (sbutton, icons);
103
104   adj = gtk_adjustment_new (0., 0., 1., 0.02, 0.2, 0.);
105   g_object_set (G_OBJECT (button),
106                 "adjustment", adj,
107                 "size", GTK_ICON_SIZE_SMALL_TOOLBAR,
108                 "has-tooltip", TRUE,
109                 NULL);
110
111   g_signal_connect (G_OBJECT (button), "query-tooltip",
112                     G_CALLBACK (cb_query_tooltip), NULL);
113   g_signal_connect (G_OBJECT (button), "value-changed",
114                     G_CALLBACK (cb_value_changed), NULL);
115 }
116
117 /**
118  * gtk_volume_button_new
119  *
120  * Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with
121  * a stepping of 0.02. Volume values can be obtained and modified using
122  * the functions from #GtkScaleButton.
123  *
124  * Return value: a new #GtkVolumeButton
125  *
126  * Since: 2.12
127  */
128 GtkWidget *
129 gtk_volume_button_new (void)
130 {
131   GObject *button;
132   button = g_object_new (GTK_TYPE_VOLUME_BUTTON, NULL);
133   return GTK_WIDGET (button);
134 }
135
136 static gboolean
137 cb_query_tooltip (GtkWidget  *button,
138                   gint        x,
139                   gint        y,
140                   gboolean    keyboard_mode,
141                   GtkTooltip *tooltip,
142                   gpointer    user_data)
143 {
144   GtkScaleButton *scale_button = GTK_SCALE_BUTTON (button);
145   GtkAdjustment *adj;
146   gdouble val;
147   char *str;
148   AtkImage *image;
149
150   image = ATK_IMAGE (gtk_widget_get_accessible (button));
151
152   adj = gtk_scale_button_get_adjustment (scale_button);
153   val = gtk_scale_button_get_value (scale_button);
154
155   if (val < (adj->lower + EPSILON))
156     {
157       str = g_strdup (_("Muted"));
158     }
159   else if (val >= (adj->upper - EPSILON))
160     {
161       str = g_strdup (_("Full Volume"));
162     }
163   else
164     {
165       int percent;
166
167       percent = (int) (100. * val / (adj->upper - adj->lower) + .5);
168
169       /* Translators: this is the percentage of the current volume,
170        * as used in the tooltip, eg. "49 %".
171        * Translate the "%d" to "%Id" if you want to use localised digits,
172        * or otherwise translate the "%d" to "%d".
173        */
174       str = g_strdup_printf (C_("volume percentage", "%d %%"), percent);
175     }
176
177   gtk_tooltip_set_text (tooltip, str);
178   atk_image_set_image_description (image, str);
179   g_free (str);
180
181   return TRUE;
182 }
183
184 static void
185 cb_value_changed (GtkVolumeButton *button, gdouble value, gpointer user_data)
186 {
187   gtk_widget_trigger_tooltip_query (GTK_WIDGET (button));
188 }
189
190 #define __GTK_VOLUME_BUTTON_C__
191 #include "gtkaliasdef.c"