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

   1 <!-- ##### SECTION Title ##### -->
   2 HildonWindow
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 Widget representing a top-level window in the Hildon framework.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10
  11 The HildonWindow is a GTK widget which represents a top-level
  12 window in the Hildon framework. It is derived from the GtkWindow
  13 and provides additional commodities specific to the Hildon
  14 framework.
  15
  16 Among these windows in the Hildon framework can have a single menu
  17 attached, which is toggled with a hardware key or by tapping
  18 a custom button in the window frame. This menu can be set
  19 by providing a GtkMenu to the hildon_window_set_menu() method.
  20
  21 Similarly a window in the Hildon framework can have several toolbars
  22 attached. These can be added to the HildonWindow with
  23 hildon_window_add_toolbar().
  24
  25
  26 <informalexample>
  27 <programlisting>
  28 HildonWindow *window;
  29 GtkToolbar *toolbar;
  30 GtkMenu *menu;
  31 GdkPixbuf *icon_pixbuf;
  32
  33 window = HILDON_WINDOW (hildon_window_new());
  34
  35 toolbar = create_toolbar();
  36
  37 menu = create_menu();
  38
  39 icon_pixbuf = create_icon();
  40
  41 hildon_window_set_menu (window, menu);
  42
  43 hildon_window_add_toolbar (window, toolbar);
  44
  45 /* Can be used to set the window fullscreen */
  46 gtk_window_fullscreen (GTK_WINDOW (window));
  47
  48 /* Used to trigger the blinking of the window's icon in the task navigator */
  49 gtk_window_set_urgency_hint (GTK_WINDOW (window), TRUE);
  50
  51 /* Change the window's icon in the task navigator */
  52 gtk_window_set_icon (GTK_WINDOW (window), icon_pixbuf);
  53
  54 </programlisting>
  55 </informalexample>
  56
  57
  58 </para>
  59
  60 <!-- ##### SECTION See_Also ##### -->
  61 <para>
  62
  63 </para>
  64
  65 <!-- ##### STRUCT HildonWindowPrivate ##### -->
  66 <para>
  67
  68 </para>
  69
  70
  71 <!-- ##### FUNCTION hildon_window_new ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @Returns:
  77 <!-- # Unused Parameters # -->
  78 @title:
  79
  80
  81 <!-- ##### FUNCTION hildon_window_add_with_scrollbar ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @self:
  87 @child:
  88
  89
  90 <!-- ##### FUNCTION hildon_window_get_menu ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @self:
  96 @Returns:
  97
  98
  99 <!-- ##### FUNCTION hildon_window_set_menu ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @self:
 105 @menu:
 106
 107
 108 <!-- ##### FUNCTION hildon_window_add_toolbar ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @self:
 114 @toolbar:
 115
 116
 117 <!-- ##### FUNCTION hildon_window_remove_toolbar ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @self:
 123 @toolbar:
 124
 125
 126 <!-- ##### FUNCTION hildon_window_get_is_topmost ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @self:
 132 @Returns:
 133
 134
 135 <!-- ##### ARG HildonWindow:is-topmost ##### -->
 136 <para>
 137
 138 </para>
 139
 140 <!-- ##### ARG HildonWindow:borders ##### -->
 141 <para>
 142
 143 </para>
 144
 145 <!-- ##### ARG HildonWindow:toolbar-borders ##### -->
 146 <para>
 147
 148 </para>
 149