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

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