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

diff --git a/doc/tmpl/hildon-program.sgml b/doc/tmpl/hildon-program.sgml
new file mode 100644 (file)
index 0000000..4d44eb7
--- /dev/null
@@ -0,0 +1,169 @@
+<!-- ##### SECTION Title ##### -->
+HildonProgram
+
+<!-- ##### SECTION Short_Description ##### -->
+An object that represents an application running in the Hildon framework.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+
+The HildonProgram is an object used to represent an application running
+in the Hildon framework.
+
+Such an application is thought to have one or more HildonWindow. These
+shall be registered to the HildonProgram with hildon_program_add_window,
+and can be unregistered similarly with hildon_program_remove_window.
+
+The HildonProgram provides the programmer with commodities such
+as applying a common toolbar and menu to all the HildonWindow
+registered to it. This is done with hildon_program_set_common_menu()
+and hildon_program_set_common_toolbar().
+
+The HildonProgram is also used to apply program-wide properties that
+are specific to the Hildon framework. For instance
+hildon_program_set_can_hibernate() sets whether or not an application
+can be set to hibernate by the Hildon task navigator, in situations of
+low memory.
+
+<informalexample>
+<programlisting>
+HildonProgram *program;
+HildonWindow *first_window;
+HildonWindow *second_window;
+GtkToolbar *common_toolbar, *window_specific_toolbar;
+GtkMenu *menu;
+
+program = HILDON_PROGRAM (hildon_program_new());
+
+window1 = HILDON_WINDOW (hildon_window_new());
+window2 = HILDON_WINDOW (hildon_window_new());
+
+common_toolbar = create_common_toolbar();
+window_specific_toolbar = create_window_specific_toolbar();
+
+menu = create_menu();
+
+hildon_program_add (program, window1);
+hildon_program_add (program, window2);
+
+hildon_program_set_common_menu (program, menu);
+
+hildon_program_set_common_toolbar (program, common_toolbar);
+hildon_window_add_toolbar (first_window, window_specific_toolbar);
+
+hildon_program_set_can_hibernate (program, TRUE);
+
+</programlisting>
+</informalexample>
+
+
+
+
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT HildonProgram ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG HildonProgram:can-hibernate ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG HildonProgram:is-topmost ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION hildon_program_get_instance ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION hildon_program_add_window ##### -->
+<para>
+
+</para>
+
+@self: 
+@window: 
+
+
+<!-- ##### FUNCTION hildon_program_remove_window ##### -->
+<para>
+
+</para>
+
+@self: 
+@window: 
+
+
+<!-- ##### FUNCTION hildon_program_set_can_hibernate ##### -->
+<para>
+
+</para>
+
+@self: 
+@killable: 
+
+
+<!-- ##### FUNCTION hildon_program_get_can_hibernate ##### -->
+<para>
+
+</para>
+
+@self: 
+@Returns: 
+
+
+<!-- ##### FUNCTION hildon_program_set_common_menu ##### -->
+<para>
+
+</para>
+
+@self: 
+@menu: 
+
+
+<!-- ##### FUNCTION hildon_program_get_common_menu ##### -->
+<para>
+
+</para>
+
+@self: 
+@Returns: 
+
+
+<!-- ##### FUNCTION hildon_program_set_common_toolbar ##### -->
+<para>
+
+</para>
+
+@self: 
+@toolbar: 
+
+
+<!-- ##### FUNCTION hildon_program_get_common_toolbar ##### -->
+<para>
+
+</para>
+
+@self: 
+@Returns: 
+
+