vcs.maemo.org Git - hildon/blob - doc/tmpl/hildon-program.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 HildonProgram
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An object that represents an application running in the Hildon framework.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10
  11 The HildonProgram is an object used to represent an application running
  12 in the Hildon framework.
  13
  14 Such an application is thought to have one or more HildonWindow. These
  15 shall be registered to the HildonProgram with hildon_program_add_window,
  16 and can be unregistered similarly with hildon_program_remove_window.
  17
  18 The HildonProgram provides the programmer with commodities such
  19 as applying a common toolbar and menu to all the HildonWindow
  20 registered to it. This is done with hildon_program_set_common_menu()
  21 and hildon_program_set_common_toolbar().
  22
  23 The HildonProgram is also used to apply program-wide properties that
  24 are specific to the Hildon framework. For instance
  25 hildon_program_set_can_hibernate() sets whether or not an application
  26 can be set to hibernate by the Hildon task navigator, in situations of
  27 low memory.
  28
  29 <informalexample>
  30 <programlisting>
  31 HildonProgram *program;
  32 HildonWindow *first_window;
  33 HildonWindow *second_window;
  34 GtkToolbar *common_toolbar, *window_specific_toolbar;
  35 GtkMenu *menu;
  36
  37 program = HILDON_PROGRAM (hildon_program_new());
  38
  39 window1 = HILDON_WINDOW (hildon_window_new());
  40 window2 = HILDON_WINDOW (hildon_window_new());
  41
  42 common_toolbar = create_common_toolbar();
  43 window_specific_toolbar = create_window_specific_toolbar();
  44
  45 menu = create_menu();
  46
  47 hildon_program_add (program, window1);
  48 hildon_program_add (program, window2);
  49
  50 hildon_program_set_common_menu (program, menu);
  51
  52 hildon_program_set_common_toolbar (program, common_toolbar);
  53 hildon_window_add_toolbar (first_window, window_specific_toolbar);
  54
  55 hildon_program_set_can_hibernate (program, TRUE);
  56
  57 </programlisting>
  58 </informalexample>
  59
  60
  61
  62
  63
  64 </para>
  65
  66 <!-- ##### SECTION See_Also ##### -->
  67 <para>
  68
  69 </para>
  70
  71 <!-- ##### SECTION Stability_Level ##### -->
  72
  73
  74 <!-- ##### STRUCT HildonProgram ##### -->
  75 <para>
  76
  77 </para>
  78
  79
  80 <!-- ##### ARG HildonProgram:can-hibernate ##### -->
  81 <para>
  82
  83 </para>
  84
  85 <!-- ##### ARG HildonProgram:is-topmost ##### -->
  86 <para>
  87
  88 </para>
  89
  90 <!-- ##### FUNCTION hildon_program_get_instance ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @Returns:
  96
  97
  98 <!-- ##### FUNCTION hildon_program_add_window ##### -->
  99 <para>
 100
 101 </para>
 102
 103 @self:
 104 @window:
 105
 106
 107 <!-- ##### FUNCTION hildon_program_remove_window ##### -->
 108 <para>
 109
 110 </para>
 111
 112 @self:
 113 @window:
 114
 115
 116 <!-- ##### FUNCTION hildon_program_set_can_hibernate ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @self:
 122 @killable:
 123
 124
 125 <!-- ##### FUNCTION hildon_program_get_can_hibernate ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @self:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION hildon_program_set_common_menu ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @self:
 140 @menu:
 141
 142
 143 <!-- ##### FUNCTION hildon_program_get_common_menu ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @self:
 149 @Returns:
 150
 151
 152 <!-- ##### FUNCTION hildon_program_set_common_toolbar ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @self:
 158 @toolbar:
 159
 160
 161 <!-- ##### FUNCTION hildon_program_get_common_toolbar ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @self:
 167 @Returns:
 168
 169