git.maemo.org Git - hildon/blob - doc/tmpl/hildon-appview.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 HildonAppView
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget which present one view of an application.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A widget which present one view of an application.
  10 Application can have many different views and the appview helps to organize.
  11 It has automatic fullscreen and menu handling. It also helps to handle components
  12 like a toolbar.
  13
  14 <informalexample>
  15 <programlisting>
  16
  17 appview = hildon_appview_new( "This is an application view" );
  18 hildon_appview_set_fullscreen_key_allowed( appview, TRUE );
  19 hildon_appview_set_toolbar( appview, toolbar );
  20
  21 hildon_app_set_appview( appview );
  22
  23 hildon_appview_set_fullscreen( appview, TRUE );
  24
  25 </programlisting>
  26 </informalexample>
  27
  28 By default, HildonAppView doesn't toggle fullscreen from the fullscreen
  29 hardware key. This is because there might be applications that are not intended to
  30 have ability to switch to fullscreen mode at all. To enable fullscreen
  31 toggling from fullscreen hardware key, use #hildon_appview_set_fullscreen_key_allowed -function.
  32
  33 </para>
  34
  35 <!-- ##### SECTION See_Also ##### -->
  36 <para>
  37
  38 </para>
  39
  40 <!-- ##### STRUCT HildonAppViewPrivate ##### -->
  41 <para>
  42
  43 </para>
  44
  45
  46 <!-- ##### STRUCT HildonAppView ##### -->
  47 <para>
  48
  49 </para>
  50
  51
  52 <!-- ##### FUNCTION hildon_appview_new ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @title:
  58 @Returns:
  59
  60
  61 <!-- ##### FUNCTION hildon_appview_add_with_scrollbar ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @self:
  67 @child:
  68
  69
  70 <!-- ##### FUNCTION hildon_appview_set_fullscreen_key_allowed ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @self:
  76 @allow:
  77
  78
  79 <!-- ##### FUNCTION hildon_appview_get_fullscreen_key_allowed ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @self:
  85 @Returns:
  86
  87
  88 <!-- ##### FUNCTION hildon_appview_get_fullscreen ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @self:
  94 @Returns:
  95
  96
  97 <!-- ##### FUNCTION hildon_appview_set_fullscreen ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @self:
 103 @fullscreen:
 104
 105
 106 <!-- ##### FUNCTION hildon_appview_get_menu ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @self:
 112 @Returns:
 113
 114
 115 <!-- ##### FUNCTION hildon_appview_set_toolbar ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @self:
 121 @toolbar:
 122
 123
 124 <!-- ##### FUNCTION hildon_appview_get_toolbar ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @self:
 130 @Returns:
 131
 132
 133 <!-- ##### FUNCTION hildon_appview_set_title ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @self:
 139 @newname:
 140
 141
 142 <!-- ##### FUNCTION hildon_appview_get_title ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @self:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION hildon_appview_set_connected_adjustment ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @self:
 157 @adjustment:
 158
 159
 160 <!-- ##### FUNCTION hildon_appview_get_connected_adjustment ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @self:
 166 @Returns:
 167
 168
 169 <!-- ##### SIGNAL HildonAppView::decrease-button-event ##### -->
 170 <para>
 171
 172 </para>
 173
 174 @hildonappview: the object which received the signal.
 175 @arg1: the Gdk key state.
 176
 177 <!-- ##### SIGNAL HildonAppView::fullscreen-state-change ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @hildonappview: the object which received the signal.
 183 @arg1:
 184
 185 <!-- ##### SIGNAL HildonAppView::increase-button-event ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @hildonappview: the object which received the signal.
 191 @arg1: the Gdk key state.
 192
 193 <!-- ##### SIGNAL HildonAppView::switched-from ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @hildonappview: the object which received the signal.
 199
 200 <!-- ##### SIGNAL HildonAppView::switched-to ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @hildonappview: the object which received the signal.
 206
 207 <!-- ##### SIGNAL HildonAppView::title-change ##### -->
 208 <para>
 209
 210 </para>
 211
 212 @hildonappview: the object which received the signal.
 213
 214 <!-- ##### SIGNAL HildonAppView::toolbar-changed ##### -->
 215 <para>
 216 This is not a valid signal to listen to. Since HildonAppView supports
 217  multi-toolbar, and packing of these toolbars is in the hand of the
 218  programmers. Please access the public member GtkVBox in HildonAppView
 219  to set/get your toolbars.
 220
 221 </para>
 222
 223 @hildonappview: the object which received the signal.
 224
 225 <!-- ##### SIGNAL HildonAppView::toolbar-toggle-request ##### -->
 226 <para>
 227 This is not a valid signal to listen to. Since HildonAppView supports
 228  multi-toolbar, and showing/hiding of the these toolbars is required from
 229  the programmers.
 230
 231 </para>
 232
 233 @hildonappview: the object which received the signal.
 234
 235 <!-- ##### ARG HildonAppView:connected-adjustment ##### -->
 236 <para>
 237
 238 </para>
 239
 240 <!-- ##### ARG HildonAppView:fullscreen ##### -->
 241 <para>
 242
 243 </para>
 244
 245 <!-- ##### ARG HildonAppView:fullscreen-key-allowed ##### -->
 246 <para>
 247
 248 </para>
 249
 250 <!-- ##### ARG HildonAppView:title ##### -->
 251 <para>
 252
 253 </para>
 254