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 <!-- ##### FUNCTION hildon_program_get_instance ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @Returns:
  77
  78
  79 <!-- ##### FUNCTION hildon_program_add_window ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @self:
  85 @window:
  86
  87
  88 <!-- ##### FUNCTION hildon_program_remove_window ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @self:
  94 @window:
  95
  96
  97 <!-- ##### FUNCTION hildon_program_set_can_hibernate ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @self:
 103 @killable:
 104
 105
 106 <!-- ##### FUNCTION hildon_program_get_can_hibernate ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @self:
 112 @Returns:
 113
 114
 115 <!-- ##### FUNCTION hildon_program_set_common_menu ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @self:
 121 @menu:
 122
 123
 124 <!-- ##### FUNCTION hildon_program_get_common_menu ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @self:
 130 @Returns:
 131
 132
 133 <!-- ##### FUNCTION hildon_program_set_common_toolbar ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @self:
 139 @toolbar:
 140
 141
 142 <!-- ##### FUNCTION hildon_program_get_common_toolbar ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @self:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION hildon_program_get_is_topmost ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @self:
 157 @Returns:
 158
 159