2 * This file is a part of hildon
4 * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
6 * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; version 2.1 of
11 * the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
26 * SECTION:hildon-vvolumebar
27 * @short_description: A widget that displays a vertical volume bar.
28 * @see_also: #HildonVolumebar, #HildonHVolumebar
30 * #HildonVVolumebar is a subclass of #HildonVolumebar. It displays a
31 * vertical volume bar that allows increasing or decreasing volume
32 * within a predefined range, and muting when users click the mute icon.
34 * Here is an example that creates a vertical volume bar and connects
37 * <title>HildonVVolumebar example</title>
39 * GtkWidget *volbar = hildon_vvolumebar_new ();
40 * g_signal_connect (G_OBJECT (volbar), "mute_toggled", G_CALLBACK (mute_toggle), NULL);
41 * g_signal_connect (G_OBJECT (volbar), "level_changed", G_CALLBACK (level_change), NULL);
50 #include "hildon-vvolumebar.h"
51 #include "hildon-volumebar-range.h"
52 #include "hildon-volumebar-private.h"
55 #define DEFAULT_BAR_WIDTH 58
57 #define MINIMUM_BAR_HEIGHT 165
61 #define DEFAULT_VERTICAL_TBUTTON_WIDTH 26
63 #define DEFAULT_VERTICAL_TBUTTON_HEIGHT 26
65 #define DEFAULT_ENDING_SIZE 20
67 /* Gap to leave for mute button */
69 #define HORIZONTAL_MUTE_GAP 16
71 #define VERTICAL_MUTE_GAP 6
73 static HildonVolumebarClass* parent_class;
76 hildon_vvolumebar_class_init (HildonVVolumebarClass * klass);
79 hildon_vvolumebar_init (HildonVVolumebar * vvolumebar);
82 hildon_vvolumebar_expose (GtkWidget * widget,
83 GdkEventExpose * event);
86 hildon_vvolumebar_size_request (GtkWidget * widget,
87 GtkRequisition * requisition);
90 hildon_vvolumebar_size_allocate (GtkWidget * widget,
91 GtkAllocation * allocation);
94 * hildon_vvolumebar_get_type:
96 * Initializes and returns the type of a hildon vvolumebar.
98 * @Returns: GType of #HildonVVolumebar
101 hildon_vvolumebar_get_type (void)
103 static GType type = 0;
106 static const GTypeInfo info = {
107 sizeof (HildonVVolumebarClass),
108 NULL, /* base_init */
109 NULL, /* base_finalize */
110 (GClassInitFunc) hildon_vvolumebar_class_init, /* class_init */
111 NULL, /* class_finalize */
112 NULL, /* class_data */
113 sizeof (HildonVVolumebar),
115 (GInstanceInitFunc) hildon_vvolumebar_init,
118 g_type_register_static (HILDON_TYPE_VOLUMEBAR,
119 "HildonVVolumebar", &info, 0);
125 hildon_vvolumebar_class_init (HildonVVolumebarClass *klass)
127 GtkWidgetClass *volumebar_class = GTK_WIDGET_CLASS(klass);
129 parent_class = g_type_class_peek_parent(klass);
131 volumebar_class->size_request = hildon_vvolumebar_size_request;
132 volumebar_class->size_allocate = hildon_vvolumebar_size_allocate;
133 volumebar_class->expose_event = hildon_vvolumebar_expose;
137 hildon_vvolumebar_init (HildonVVolumebar *vvolumebar)
139 HildonVolumebarPrivate *priv;
141 priv = HILDON_VOLUMEBAR_GET_PRIVATE (vvolumebar);
144 priv->volumebar = HILDON_VOLUMEBAR_RANGE (hildon_volumebar_range_new
145 (GTK_ORIENTATION_VERTICAL));
147 gtk_widget_set_parent (GTK_WIDGET (priv->tbutton), GTK_WIDGET (vvolumebar));
148 gtk_widget_set_parent (GTK_WIDGET (priv->volumebar), GTK_WIDGET (vvolumebar));
150 gtk_scale_set_draw_value (GTK_SCALE (priv->volumebar), FALSE);
153 g_signal_connect_swapped(G_OBJECT(priv->volumebar), "value-changed",
154 G_CALLBACK(hildon_volumebar_level_change),
157 g_signal_connect_swapped(priv->tbutton, "toggled",
158 G_CALLBACK(hildon_volumebar_mute_toggled), vvolumebar);
160 /* FIXME Not sure why this is here */
161 gtk_widget_show (GTK_WIDGET (priv->volumebar));
165 * hildon_vvolumebar_new:
167 * Creates a new #HildonVVolumebar widget.
169 * Returns: a new #HildonVVolumebar
172 hildon_vvolumebar_new (void)
174 return GTK_WIDGET (g_object_new(HILDON_TYPE_VVOLUMEBAR, NULL));
178 hildon_vvolumebar_expose (GtkWidget *widget,
179 GdkEventExpose *event)
182 HildonVolumebarPrivate *priv;
184 priv = HILDON_VOLUMEBAR_GET_PRIVATE(HILDON_VOLUMEBAR(widget));
187 if (GTK_WIDGET_DRAWABLE (widget)) {
188 /* Paint background */
189 gtk_paint_box (widget->style, widget->window,
190 GTK_WIDGET_STATE (priv->volumebar), GTK_SHADOW_OUT,
191 NULL, widget, "background",
192 widget->allocation.x,
193 widget->allocation.y,
194 widget->allocation.width,
195 widget->allocation.height);
197 /* The contents of the widget can paint themselves */
198 (*GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
205 hildon_vvolumebar_size_request (GtkWidget *widget,
206 GtkRequisition *requisition)
208 requisition->height = MINIMUM_BAR_HEIGHT;
209 requisition->width = DEFAULT_BAR_WIDTH;
213 hildon_vvolumebar_size_allocate (GtkWidget *widget,
214 GtkAllocation *allocation)
216 HildonVolumebarPrivate *priv;
218 GtkAllocation range_allocation, button_allocation;
220 priv = HILDON_VOLUMEBAR_GET_PRIVATE(widget);
223 /* Center the widget horizontally */
224 if (allocation->width > DEFAULT_BAR_WIDTH) {
226 (allocation->width - DEFAULT_BAR_WIDTH) / 2;
227 allocation->width = DEFAULT_BAR_WIDTH;
230 GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
232 if (priv->volumebar && GTK_WIDGET_VISIBLE (priv->volumebar)) {
233 /* Allocate space for the slider */
234 range_allocation.x = allocation->x;
235 range_allocation.y = allocation->y + DEFAULT_ENDING_SIZE;
237 range_allocation.width = DEFAULT_BAR_WIDTH;
239 if (priv->tbutton && GTK_WIDGET_VISIBLE (priv->tbutton))
241 /* Leave room for the mute button */
242 range_allocation.height = MAX (0,
244 - 2 * DEFAULT_ENDING_SIZE
245 - DEFAULT_VERTICAL_TBUTTON_HEIGHT
246 - VERTICAL_MUTE_GAP);
251 range_allocation.height = MAX (0,
253 - 2 * DEFAULT_ENDING_SIZE);
256 gtk_widget_size_allocate (GTK_WIDGET (priv->volumebar),
260 if (priv->tbutton && GTK_WIDGET_VISIBLE (priv->tbutton)) {
261 /* Allocate space for the mute button */
262 button_allocation.x = allocation->x + HORIZONTAL_MUTE_GAP;
263 button_allocation.y = allocation->y + allocation->height -
264 VERTICAL_MUTE_GAP - 2 * DEFAULT_ENDING_SIZE;
265 button_allocation.width = DEFAULT_VERTICAL_TBUTTON_WIDTH;
266 button_allocation.height = DEFAULT_VERTICAL_TBUTTON_HEIGHT;
267 gtk_widget_size_allocate (GTK_WIDGET (priv->tbutton),