Merging to trunk
authorJohan Bilien <johan.bilien@nokia.com>
Tue, 21 Feb 2006 13:18:25 +0000 (13:18 +0000)
committerJohan Bilien <johan.bilien@nokia.com>
Tue, 21 Feb 2006 13:18:25 +0000 (13:18 +0000)
doc/tmpl/hildon-window.sgml [new file with mode: 0644]

diff --git a/doc/tmpl/hildon-window.sgml b/doc/tmpl/hildon-window.sgml
new file mode 100644 (file)
index 0000000..7b26df5
--- /dev/null
@@ -0,0 +1,138 @@
+<!-- ##### SECTION Title ##### -->
+HildonWindow
+
+<!-- ##### SECTION Short_Description ##### -->
+
+Widget representing a top-level window in the Hildon framework.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+The HildonWindow is a GTK widget which represents a top-level
+window in the Hildon framework. It is derived from the GtkWindow
+and provides additional commodities specific to the Hildon
+framework.
+
+Among these windows in the Hildon framework can have a single menu
+attached, which is toggled with a hardware key or by tapping
+a custom button in the window frame. This menu can be set
+by providing a GtkMenu to the hildon_window_set_menu() method.
+
+Similarly a window in the Hildon framework can have several toolbars
+attached. These can be added to the HildonWindow with
+hildon_window_add_toolbar().
+
+
+<informalexample>
+<programlisting>
+HildonWindow *window;
+GtkToolbar *toolbar;
+GtkMenu *menu;
+GdkPixbuf *icon_pixbuf;
+
+window = HILDON_WINDOW (hildon_window_new());
+
+toolbar = create_toolbar();
+
+menu = create_menu();
+
+icon_pixbuf = create_icon();
+
+hildon_window_set_menu (window, menu);
+
+hildon_window_add_toolbar (window, toolbar);
+
+/* Can be used to set the window fullscreen */
+gtk_window_fullscreen (GTK_WINDOW (window));
+
+/* Used to trigger the blinking of the window's icon in the task navigator */
+gtk_window_set_urgency_hint (GTK_WINDOW (window), TRUE);
+
+/* Change the window's icon in the task navigator */
+gtk_window_set_icon (GTK_WINDOW (window), icon_pixbuf);
+
+</programlisting>
+</informalexample>
+
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT HildonWindow ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG HildonWindow:is-topmost ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG HildonWindow:borders ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION hildon_window_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+<!-- # Unused Parameters # -->
+@title: 
+
+
+<!-- ##### FUNCTION hildon_window_add_with_scrollbar ##### -->
+<para>
+
+</para>
+
+@self: 
+@child: 
+
+
+<!-- ##### FUNCTION hildon_window_get_menu ##### -->
+<para>
+
+</para>
+
+@self: 
+@Returns: 
+
+
+<!-- ##### FUNCTION hildon_window_set_menu ##### -->
+<para>
+
+</para>
+
+@self: 
+@menu: 
+
+
+<!-- ##### FUNCTION hildon_window_add_toolbar ##### -->
+<para>
+
+</para>
+
+@self: 
+@toolbar: 
+
+
+<!-- ##### FUNCTION hildon_window_remove_toolbar ##### -->
+<para>
+
+</para>
+
+@self: 
+@toolbar: 
+
+