Pileus Git - ~andy/gtk/blob - 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
  38 /**
  39  * SECTION:gtkvolumebutton
  40  * @Short_description: A button which pops up a volume control
  41  * @Title: GtkVolumeButton
  42  *
  43  * #GtkVolumeButton is a subclass of #GtkScaleButton that has
  44  * been tailored for use as a volume control widget with suitable
  45  * icons, tooltips and accessible labels.
  46  */
  47
  48 #define EPSILON (1e-10)
  49
  50
  51 static gboolean cb_query_tooltip (GtkWidget       *button,
  52                                   gint             x,
  53                                   gint             y,
  54                                   gboolean         keyboard_mode,
  55                                   GtkTooltip      *tooltip,
  56                                   gpointer         user_data);
  57 static void     cb_value_changed (GtkVolumeButton *button,
  58                                   gdouble          value,
  59                                   gpointer         user_data);
  60
  61 G_DEFINE_TYPE (GtkVolumeButton, gtk_volume_button, GTK_TYPE_SCALE_BUTTON)
  62
  63 static void
  64 gtk_volume_button_class_init (GtkVolumeButtonClass *klass)
  65 {
  66 }
  67
  68 static void
  69 gtk_volume_button_init (GtkVolumeButton *button)
  70 {
  71   GtkScaleButton *sbutton = GTK_SCALE_BUTTON (button);
  72   GtkObject *adj;
  73   const char *icons[] = {
  74         "audio-volume-muted",
  75         "audio-volume-high",
  76         "audio-volume-low",
  77         "audio-volume-medium",
  78         NULL
  79   };
  80
  81   atk_object_set_name (gtk_widget_get_accessible (GTK_WIDGET (button)),
  82                        _("Volume"));
  83   atk_object_set_description (gtk_widget_get_accessible (GTK_WIDGET (button)),
  84                        _("Turns volume down or up"));
  85   atk_action_set_description (ATK_ACTION (gtk_widget_get_accessible (GTK_WIDGET (button))),
  86                               1,
  87                               _("Adjusts the volume"));
  88
  89   atk_object_set_name (gtk_widget_get_accessible (sbutton->minus_button),
  90                        _("Volume Down"));
  91   atk_object_set_description (gtk_widget_get_accessible (sbutton->minus_button),
  92                        _("Decreases the volume"));
  93   gtk_widget_set_tooltip_text (sbutton->minus_button, _("Volume Down"));
  94
  95   atk_object_set_name (gtk_widget_get_accessible (sbutton->plus_button),
  96                        _("Volume Up"));
  97   atk_object_set_description (gtk_widget_get_accessible (sbutton->plus_button),
  98                        _("Increases the volume"));
  99   gtk_widget_set_tooltip_text (sbutton->plus_button, _("Volume Up"));
 100
 101   gtk_scale_button_set_icons (sbutton, icons);
 102
 103   adj = gtk_adjustment_new (0., 0., 1., 0.02, 0.2, 0.);
 104   g_object_set (G_OBJECT (button),
 105                 "adjustment", adj,
 106                 "size", GTK_ICON_SIZE_SMALL_TOOLBAR,
 107                 "has-tooltip", TRUE,
 108                 NULL);
 109
 110   g_signal_connect (G_OBJECT (button), "query-tooltip",
 111                     G_CALLBACK (cb_query_tooltip), NULL);
 112   g_signal_connect (G_OBJECT (button), "value-changed",
 113                     G_CALLBACK (cb_value_changed), NULL);
 114 }
 115
 116 /**
 117  * gtk_volume_button_new
 118  *
 119  * Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with
 120  * a stepping of 0.02. Volume values can be obtained and modified using
 121  * the functions from #GtkScaleButton.
 122  *
 123  * Return value: a new #GtkVolumeButton
 124  *
 125  * Since: 2.12
 126  */
 127 GtkWidget *
 128 gtk_volume_button_new (void)
 129 {
 130   GObject *button;
 131   button = g_object_new (GTK_TYPE_VOLUME_BUTTON, NULL);
 132   return GTK_WIDGET (button);
 133 }
 134
 135 static gboolean
 136 cb_query_tooltip (GtkWidget  *button,
 137                   gint        x,
 138                   gint        y,
 139                   gboolean    keyboard_mode,
 140                   GtkTooltip *tooltip,
 141                   gpointer    user_data)
 142 {
 143   GtkScaleButton *scale_button = GTK_SCALE_BUTTON (button);
 144   GtkAdjustment *adj;
 145   gdouble val;
 146   char *str;
 147   AtkImage *image;
 148
 149   image = ATK_IMAGE (gtk_widget_get_accessible (button));
 150
 151   adj = gtk_scale_button_get_adjustment (scale_button);
 152   val = gtk_scale_button_get_value (scale_button);
 153
 154   if (val < (adj->lower + EPSILON))
 155     {
 156       str = g_strdup (_("Muted"));
 157     }
 158   else if (val >= (adj->upper - EPSILON))
 159     {
 160       str = g_strdup (_("Full Volume"));
 161     }
 162   else
 163     {
 164       int percent;
 165
 166       percent = (int) (100. * val / (adj->upper - adj->lower) + .5);
 167
 168       /* Translators: this is the percentage of the current volume,
 169        * as used in the tooltip, eg. "49 %".
 170        * Translate the "%d" to "%Id" if you want to use localised digits,
 171        * or otherwise translate the "%d" to "%d".
 172        */
 173       str = g_strdup_printf (C_("volume percentage", "%d %%"), percent);
 174     }
 175
 176   gtk_tooltip_set_text (tooltip, str);
 177   atk_image_set_image_description (image, str);
 178   g_free (str);
 179
 180   return TRUE;
 181 }
 182
 183 static void
 184 cb_value_changed (GtkVolumeButton *button, gdouble value, gpointer user_data)
 185 {
 186   gtk_widget_trigger_tooltip_query (GTK_WIDGET (button));
 187 }