Add the GtkVolumeButton widget, a button that pops up a scale when clicked

2007-05-20  Bastien Nocera  <hadess@hadess.net>

	* gtk/Makefile.am:
	* gtk/gtk.h:
	* gtk/gtk.symbols:
	* gtk/gtkvolumebutton.[ch]: Add the GtkVolumeButton widget,
	a button that pops up a scale when clicked (Closes: #415775)
	* tests/Makefile.am:
	* tests/testvolumebutton.c: Add a test program for the
	volume button

2007-05-20  Bastien Nocera  <hadess@hadess.net>

	* POTFILES.in: Add volume button to the list

2007-05-20  Bastien Nocera  <hadess@hadess.net>

        * gtk/gtk-sections.txt: Add the GtkVolumeButton widget
	to the docs


svn path=/trunk/; revision=17877

1 files changed, 176 insertions, 0 deletions

diff --git a/gtk/gtkvolumebutton.c b/gtk/gtkvolumebutton.c
new file mode 100644
index 0000000000..d913997179
--- /dev/null
+++ b/gtk/gtkvolumebutton.c
@@ -0,0 +1,176 @@
+/* GTK - The GIMP Toolkit
+ * Copyright (C) 2007 Red Hat, Inc.
+ *
+ * Authors:
+ * - Bastien Nocera <bnocera@redhat.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+/*
+ * Modified by the GTK+ Team and others 2007.  See the AUTHORS
+ * file for a list of people on the GTK+ Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
+ */
+
+#include <config.h>
+
+#include <glib/gi18n.h>
+#include <atk/atk.h>
+
+#include "gtkvolumebutton.h"
+#include "gtktooltips.h"
+#include "gtkstock.h"
+
+struct _GtkVolumeButton
+{
+  GtkScaleButton  parent;
+  GtkTooltips    *tooltips;
+};
+
+static void	gtk_volume_button_class_init	(GtkVolumeButtonClass *klass);
+static void	gtk_volume_button_init		(GtkVolumeButton      *button);
+static void	gtk_volume_button_dispose	(GObject *object);
+static void	gtk_volume_button_update_tooltip(GtkVolumeButton *button);
+static void	cb_value_changed		(GtkVolumeButton      *button,
+						 gdouble               value,
+						 gpointer              user_data);
+
+static GtkScaleButtonClass *parent_class = NULL;
+
+G_DEFINE_TYPE (GtkVolumeButton, gtk_volume_button, GTK_TYPE_SCALE_BUTTON)
+
+static void
+gtk_volume_button_class_init (GtkVolumeButtonClass *klass)
+{
+  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+
+  parent_class = g_type_class_peek_parent (klass);
+  gobject_class->dispose = gtk_volume_button_dispose;
+}
+
+static void
+gtk_volume_button_init (GtkVolumeButton *button)
+{
+  GtkScaleButton *sbutton = GTK_SCALE_BUTTON (button);
+  GtkObject *adj;
+  const char *icons[] = {
+	"audio-volume-muted",
+	"audio-volume-high",
+	"audio-volume-low",
+	"audio-volume-medium",
+	NULL
+  };
+
+  atk_object_set_name (gtk_widget_get_accessible (GTK_WIDGET (button)),
+		       _("Volume"));
+  atk_object_set_name (gtk_widget_get_accessible (sbutton->minus_button),
+		       _("Volume Down"));
+  atk_object_set_name (gtk_widget_get_accessible (sbutton->plus_button),
+		       _("Volume Up"));
+
+  gtk_scale_button_set_icons (sbutton, icons);
+
+  adj = gtk_adjustment_new (0, 0, 100, 2, 10 * 2, 0);
+  g_object_set (G_OBJECT (button),
+		"adjustment", adj,
+		"size", GTK_ICON_SIZE_SMALL_TOOLBAR,
+	       	NULL);
+
+  button->tooltips = gtk_tooltips_new ();
+  g_object_ref_sink (button->tooltips);
+  gtk_volume_button_update_tooltip (button);
+
+  g_signal_connect (G_OBJECT (button), "value-changed",
+		    G_CALLBACK (cb_value_changed), NULL);
+}
+
+static void
+gtk_volume_button_dispose (GObject *object)
+{
+  GtkVolumeButton *button;
+
+  button = GTK_VOLUME_BUTTON (object);
+
+  if (button->tooltips)
+    g_object_unref (button->tooltips);
+  button->tooltips = NULL;
+
+  G_OBJECT_CLASS (parent_class)->dispose (object);
+}
+
+/**
+ * gtk_volume_button_new
+ *
+ * Creates a #GtkVolumeButton, with a range between 0 and 100, with
+ * a stepping of 2. Volume values can be obtained and modified using
+ * the functions from #GtkScaleButton.
+ *
+ * Return value: a new #GtkVolumeButton
+ *
+ * Since: 2.12
+ */
+GtkWidget *
+gtk_volume_button_new (void)
+{
+  GObject *button;
+  button = g_object_new (GTK_TYPE_VOLUME_BUTTON, NULL);
+  return GTK_WIDGET (button);
+}
+
+static void
+gtk_volume_button_update_tooltip (GtkVolumeButton *button)
+{
+  gdouble val;
+  char *str;
+
+  val = gtk_scale_button_get_value (GTK_SCALE_BUTTON (button));
+
+  if (val == 0.0)
+    {
+      str = g_strdup (_("Muted"));
+    }
+  else if (val == 100.0)
+    {
+      str = g_strdup (_("Full Volume"));
+    }
+  else
+    {
+      int percent;
+
+      percent = (int) val;
+      /* translators, this is the percentage of the current volume,
+       * as used in the tooltip, eg. "49 %"
+       * do not translate the part before the | */
+      str = g_strdup_printf (Q_("volume percentage|%d %%"), percent);
+    }
+
+  gtk_tooltips_set_tip (button->tooltips,
+		       	GTK_WIDGET (button),
+			str, NULL);
+  g_free (str);
+}
+
+static void
+cb_value_changed (GtkVolumeButton *button, gdouble value, gpointer user_data)
+{
+  gtk_volume_button_update_tooltip (button);
+}
+
+/*
+ * vim: sw=2 ts=8 cindent noai bs=2
+ */