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);
46 #undef HILDON_DISABLE_DEPRECATED
52 #include "hildon-vvolumebar.h"
53 #include "hildon-volumebar-range.h"
54 #include "hildon-volumebar-private.h"
57 #define DEFAULT_BAR_WIDTH 60
59 #define MINIMUM_BAR_HEIGHT 165
63 #define DEFAULT_VERTICAL_TBUTTON_WIDTH 60
65 #define DEFAULT_VERTICAL_TBUTTON_HEIGHT 60
67 #define DEFAULT_ENDING_SIZE 0
69 /* Gap to leave for mute button */
71 #define HORIZONTAL_MUTE_GAP 0
73 #define VERTICAL_MUTE_GAP 0
75 static HildonVolumebarClass* parent_class;
78 hildon_vvolumebar_class_init (HildonVVolumebarClass * klass);
81 hildon_vvolumebar_init (HildonVVolumebar * vvolumebar);
84 hildon_vvolumebar_expose (GtkWidget * widget,
85 GdkEventExpose * event);
88 hildon_vvolumebar_size_request (GtkWidget * widget,
89 GtkRequisition * requisition);
92 hildon_vvolumebar_size_allocate (GtkWidget * widget,
93 GtkAllocation * allocation);
96 * hildon_vvolumebar_get_type:
98 * Initializes and returns the type of a hildon vvolumebar.
100 * @Returns: GType of #HildonVVolumebar
103 hildon_vvolumebar_get_type (void)
105 static GType type = 0;
108 static const GTypeInfo info = {
109 sizeof (HildonVVolumebarClass),
110 NULL, /* base_init */
111 NULL, /* base_finalize */
112 (GClassInitFunc) hildon_vvolumebar_class_init, /* class_init */
113 NULL, /* class_finalize */
114 NULL, /* class_data */
115 sizeof (HildonVVolumebar),
117 (GInstanceInitFunc) hildon_vvolumebar_init,
120 g_type_register_static (HILDON_TYPE_VOLUMEBAR,
121 "HildonVVolumebar", &info, 0);
127 hildon_vvolumebar_class_init (HildonVVolumebarClass *klass)
129 GtkWidgetClass *volumebar_class = GTK_WIDGET_CLASS(klass);
131 parent_class = g_type_class_peek_parent(klass);
133 volumebar_class->size_request = hildon_vvolumebar_size_request;
134 volumebar_class->size_allocate = hildon_vvolumebar_size_allocate;
135 volumebar_class->expose_event = hildon_vvolumebar_expose;
139 hildon_vvolumebar_init (HildonVVolumebar *vvolumebar)
141 HildonVolumebarPrivate *priv;
143 priv = HILDON_VOLUMEBAR_GET_PRIVATE (vvolumebar);
146 priv->volumebar = HILDON_VOLUMEBAR_RANGE (hildon_volumebar_range_new
147 (GTK_ORIENTATION_VERTICAL));
149 gtk_widget_set_parent (GTK_WIDGET (priv->tbutton), GTK_WIDGET (vvolumebar));
150 gtk_widget_set_parent (GTK_WIDGET (priv->volumebar), GTK_WIDGET (vvolumebar));
152 gtk_scale_set_draw_value (GTK_SCALE (priv->volumebar), FALSE);
155 g_signal_connect_swapped(G_OBJECT(priv->volumebar), "value-changed",
156 G_CALLBACK(hildon_volumebar_level_change),
159 g_signal_connect_swapped(priv->tbutton, "toggled",
160 G_CALLBACK(hildon_volumebar_mute_toggled), vvolumebar);
162 /* FIXME Not sure why this is here */
163 gtk_widget_show (GTK_WIDGET (priv->volumebar));
167 * hildon_vvolumebar_new:
169 * Creates a new #HildonVVolumebar widget.
171 * Returns: a new #HildonVVolumebar
174 hildon_vvolumebar_new (void)
176 return GTK_WIDGET (g_object_new(HILDON_TYPE_VVOLUMEBAR, NULL));
180 hildon_vvolumebar_expose (GtkWidget *widget,
181 GdkEventExpose *event)
184 HildonVolumebarPrivate *priv;
186 priv = HILDON_VOLUMEBAR_GET_PRIVATE(HILDON_VOLUMEBAR(widget));
189 if (GTK_WIDGET_DRAWABLE (widget)) {
190 /* Paint background */
191 gtk_paint_box (widget->style, widget->window,
192 GTK_WIDGET_STATE (priv->volumebar), GTK_SHADOW_OUT,
193 NULL, widget, "background",
194 widget->allocation.x,
195 widget->allocation.y,
196 widget->allocation.width,
197 widget->allocation.height);
199 /* The contents of the widget can paint themselves */
200 (*GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
207 hildon_vvolumebar_size_request (GtkWidget *widget,
208 GtkRequisition *requisition)
210 requisition->height = MINIMUM_BAR_HEIGHT;
211 requisition->width = DEFAULT_BAR_WIDTH;
215 hildon_vvolumebar_size_allocate (GtkWidget *widget,
216 GtkAllocation *allocation)
218 HildonVolumebarPrivate *priv;
220 GtkAllocation range_allocation, button_allocation;
222 priv = HILDON_VOLUMEBAR_GET_PRIVATE(widget);
225 /* Center the widget horizontally */
226 if (allocation->width > DEFAULT_BAR_WIDTH) {
228 (allocation->width - DEFAULT_BAR_WIDTH) / 2;
229 allocation->width = DEFAULT_BAR_WIDTH;
232 GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
234 if (priv->volumebar && GTK_WIDGET_VISIBLE (priv->volumebar)) {
235 /* Allocate space for the slider */
236 range_allocation.x = allocation->x;
237 range_allocation.y = allocation->y + DEFAULT_ENDING_SIZE;
239 range_allocation.width = DEFAULT_BAR_WIDTH;
241 if (priv->tbutton && GTK_WIDGET_VISIBLE (priv->tbutton))
243 /* Leave room for the mute button */
244 range_allocation.height = MAX (0,
246 - 2 * DEFAULT_ENDING_SIZE
247 - DEFAULT_VERTICAL_TBUTTON_HEIGHT
248 - VERTICAL_MUTE_GAP);
253 range_allocation.height = MAX (0,
255 - 2 * DEFAULT_ENDING_SIZE);
258 gtk_widget_size_allocate (GTK_WIDGET (priv->volumebar),
262 if (priv->tbutton && GTK_WIDGET_VISIBLE (priv->tbutton)) {
263 /* Allocate space for the mute button */
264 button_allocation.x = allocation->x + HORIZONTAL_MUTE_GAP;
265 button_allocation.y = allocation->y + allocation->height -
266 DEFAULT_VERTICAL_TBUTTON_HEIGHT -
267 VERTICAL_MUTE_GAP - 2 * DEFAULT_ENDING_SIZE;
268 button_allocation.width = DEFAULT_VERTICAL_TBUTTON_WIDTH;
269 button_allocation.height = DEFAULT_VERTICAL_TBUTTON_HEIGHT;
270 gtk_widget_size_allocate (GTK_WIDGET (priv->tbutton),