2 * This file is a part of hildon
4 * Copyright (C) 2008 Nokia Corporation, all rights reserved.
6 * Contact: Rodrigo Novo <rodrigo.novo@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-stackable-window
27 * @short_description: Widget representing a stackable, top-level window in the Hildon framework.
28 * @see_also: #HildonWindowStack
30 * The #HildonStackableWindow is a GTK+ widget which represents a
31 * top-level window in the Hildon framework. It is derived from
32 * #HildonWindow. Applications that use stackable windows are organized
33 * in a hierarchical way so users can go from any window back to the
34 * application's root window.
36 * The user can only see and interact with the window on top of the
37 * stack. Although all other windows are mapped and visible, they are
38 * obscured by the topmost one so in practice they appear as if they
41 * To add a window to the stack, just use gtk_widget_show(). The
42 * previous one will be obscured by the new one. When the new window
43 * is destroyed, the previous one will appear again.
45 * Alternatively, you can remove a window from the top of the stack
46 * without destroying it by using hildon_window_stack_pop(). The
47 * window will be automatically hidden and the previous one will
50 * For advanced details on stack handling, see #HildonWindowStack
53 * <title>Basic HildonStackableWindow example</title>
56 * show_new_window (void)
60 * win = hildon_stackable_window_new ();
62 * // ... configure new window
64 * gtk_widget_show (win);
68 * main (int argc, char **argv)
73 * gtk_init (&argc, &args);
75 * win = hildon_stackable_window_new ();
76 * gtk_window_set_title (GTK_WINDOW (win), "Main window);
78 * // ... add some widgets to the window
80 * g_signal_connect (button, "clicked", G_CALLBACK (show_new_window), NULL);
81 * g_signal_connect (win, "destroy", G_CALLBACK (gtk_main_quit), NULL);
83 * gtk_widget_show_all (win);
93 #include <X11/Xatom.h>
96 #include "hildon-stackable-window.h"
97 #include "hildon-stackable-window-private.h"
98 #include "hildon-app-menu-private.h"
99 #include "hildon-window-stack.h"
100 #include "hildon-window-stack-private.h"
101 #include "hildon-window-private.h"
102 #include "hildon-program.h"
104 G_DEFINE_TYPE (HildonStackableWindow, hildon_stackable_window, HILDON_TYPE_WINDOW);
107 hildon_stackable_window_set_stack (HildonStackableWindow *self,
108 HildonWindowStack *stack,
111 HildonStackableWindowPrivate *priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (self);
114 g_object_ref (stack);
117 g_object_unref (priv->stack);
120 priv->stack_position = position;
124 * hildon_stackable_window_get_stack:
125 * @self: a #HildonStackableWindow
127 * Returns the stack where window @self is on, or %NULL if the window
130 * Return value: a #HildonWindowStack, or %NULL
135 hildon_stackable_window_get_stack (HildonStackableWindow *self)
137 HildonStackableWindowPrivate *priv;
139 g_return_val_if_fail (HILDON_IS_STACKABLE_WINDOW (self), NULL);
141 priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (self);
147 * hildon_stackable_window_set_main_menu:
148 * @self: a #HildonStackableWindow
149 * @menu: a #HildonAppMenu to be used for this window
151 * Sets the menu to be used for this window. Pass %NULL to remove the
152 * current menu. Any reference to a previous menu will be dropped.
153 * #HildonStackableWindow takes ownership of the passed menu and
154 * you're not supposed to free it yourself anymore.
156 * Note that #HildonStackableWindow widgets use #HildonAppMenu rather
157 * than #GtkMenu, so you're not supposed to use
158 * hildon_window_set_main_menu() with a #HildonStackableWindow.
163 hildon_stackable_window_set_main_menu (HildonStackableWindow *self,
166 HildonStackableWindowPrivate *priv;
167 HildonAppMenu *old_menu;
169 g_return_if_fail (HILDON_IS_STACKABLE_WINDOW (self));
170 g_return_if_fail (!menu || HILDON_IS_APP_MENU (menu));
171 priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (self);
173 old_menu = priv->app_menu;
176 priv->app_menu = menu;
178 g_object_ref_sink (menu);
182 g_object_unref (old_menu);
186 hildon_stackable_window_toggle_menu (HildonWindow *self,
190 HildonStackableWindowPrivate *priv;
191 HildonAppMenu *menu_to_use = NULL;
193 g_return_val_if_fail (HILDON_IS_STACKABLE_WINDOW (self), FALSE);
194 priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (self);
195 g_assert (priv != NULL);
197 if (priv->app_menu) {
198 menu_to_use = priv->app_menu;
200 HildonProgram *program = HILDON_WINDOW_GET_PRIVATE (self)->program;
203 menu_to_use = hildon_program_get_common_app_menu (program);
205 if (self != hildon_app_menu_get_parent_window (HILDON_APP_MENU (menu_to_use)))
206 gtk_widget_hide (GTK_WIDGET (menu_to_use));
212 if (GTK_WIDGET_MAPPED (GTK_WIDGET (menu_to_use))) {
213 gtk_widget_hide (GTK_WIDGET (menu_to_use));
215 hildon_app_menu_set_parent_window (menu_to_use, GTK_WINDOW (self));
216 gtk_widget_show (GTK_WIDGET (menu_to_use));
220 } else if (HILDON_WINDOW_CLASS (hildon_stackable_window_parent_class)->toggle_menu) {
221 return HILDON_WINDOW_CLASS (hildon_stackable_window_parent_class)->toggle_menu (self, button, time);
228 hildon_stackable_window_map (GtkWidget *widget)
233 HildonStackableWindowPrivate *priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (widget);
235 val = priv->stack_position;
237 /* Set additional property "_HILDON_STACKABLE_WINDOW", to allow the WM to manage
238 it as a stackable window. */
239 display = gdk_drawable_get_display (widget->window);
240 atom = gdk_x11_get_xatom_by_name_for_display (display, "_HILDON_STACKABLE_WINDOW");
241 XChangeProperty (GDK_DISPLAY_XDISPLAY (display), GDK_WINDOW_XID (widget->window), atom,
242 XA_INTEGER, 32, PropModeReplace,
243 (unsigned char *) &val, 1);
245 GTK_WIDGET_CLASS (hildon_stackable_window_parent_class)->map (widget);
249 hildon_stackable_window_show (GtkWidget *widget)
251 HildonStackableWindowPrivate *priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (widget);
253 /* Stack the window if not already stacked */
254 if (priv->stack == NULL) {
255 HildonWindowStack *stack = hildon_window_stack_get_default ();
256 _hildon_window_stack_do_push (stack, HILDON_STACKABLE_WINDOW (widget));
259 GTK_WIDGET_CLASS (hildon_stackable_window_parent_class)->show (widget);
263 hildon_stackable_window_hide (GtkWidget *widget)
265 HildonStackableWindowPrivate *priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (widget);
266 GTK_WIDGET_CLASS (hildon_stackable_window_parent_class)->hide (widget);
269 hildon_window_stack_remove (HILDON_STACKABLE_WINDOW (widget));
274 hildon_stackable_window_finalize (GObject *object)
276 HildonStackableWindowPrivate *priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (object);
278 if (priv->app_menu) {
279 hildon_app_menu_set_parent_window (priv->app_menu, NULL);
280 g_object_unref (GTK_WIDGET (priv->app_menu));
283 if (G_OBJECT_CLASS (hildon_stackable_window_parent_class)->finalize)
284 G_OBJECT_CLASS (hildon_stackable_window_parent_class)->finalize (object);
288 hildon_stackable_window_class_init (HildonStackableWindowClass *klass)
290 GObjectClass *obj_class = G_OBJECT_CLASS (klass);
291 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
292 HildonWindowClass *window_class = HILDON_WINDOW_CLASS (klass);
294 obj_class->finalize = hildon_stackable_window_finalize;
296 widget_class->map = hildon_stackable_window_map;
297 widget_class->show = hildon_stackable_window_show;
298 widget_class->hide = hildon_stackable_window_hide;
300 window_class->toggle_menu = hildon_stackable_window_toggle_menu;
302 g_type_class_add_private (klass, sizeof (HildonStackableWindowPrivate));
306 hildon_stackable_window_init (HildonStackableWindow *self)
308 HildonStackableWindowPrivate *priv = HILDON_STACKABLE_WINDOW_GET_PRIVATE (self);
310 priv->app_menu = NULL;
312 priv->stack_position = -1;
316 * hildon_stackable_window_new:
318 * Creates a new #HildonStackableWindow.
320 * Return value: A #HildonStackableWindow
325 hildon_stackable_window_new (void)
327 HildonStackableWindow *newwindow = g_object_new (HILDON_TYPE_STACKABLE_WINDOW, NULL);
329 return GTK_WIDGET (newwindow);