git.maemo.org Git - hildon/blob - doc/hildon-docs.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY version SYSTEM "version.xml">
   5 <!ENTITY hildon-Building SYSTEM "building.sgml">
   6 <!ENTITY hildon-Compiling SYSTEM "compiling.sgml">
   7 <!ENTITY hildon-Building SYSTEM "building.sgml">
   8 <!ENTITY hildon-Running SYSTEM "running.sgml">
   9 <!ENTITY hildon-Resources SYSTEM "resources.sgml">
  10 <!ENTITY hildon-Migration SYSTEM "migration.sgml">
  11 <!ENTITY hildon-main SYSTEM "xml/hildon-main.xml">
  12 <!ENTITY hildon-gtk SYSTEM "xml/hildon-gtk.xml">
  13 <!ENTITY hildon-defines SYSTEM "xml/hildon-defines.xml">
  14 <!ENTITY HildonWindowStack SYSTEM "xml/hildon-window-stack.xml">
  15 <!ENTITY hildon-sound SYSTEM "xml/hildon-sound.xml">
  16 ]>
  17
  18 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  19   <bookinfo>
  20     <title>Hildon Reference Manual</title>
  21     <releaseinfo>for Hildon &version;</releaseinfo>
  22   </bookinfo>
  23
  24   <part id="hildon">
  25     <title>Hildon Overview</title>
  26     <partintro>
  27       <para>
  28         Hildon Widgets is a set of widgets present in the Hildon framework.
  29         Its aim is to create finger-friendly graphical interfaces specially
  30         designed for use in mobile devices.
  31       </para>
  32       <para>
  33         This set of widgets is based on GTK+ and were first developed for
  34         the Maemo platform, used by Nokia Internet Tablets.
  35       </para>
  36       <para>
  37         Hildon depends on the following libraries:
  38         <variablelist>
  39
  40           <varlistentry>
  41             <term>GTK+</term>
  42             <listitem>
  43               <para>
  44                 GTK+ is a library for creating graphical user interfaces.
  45               </para></listitem>
  46           </varlistentry>
  47
  48           <varlistentry>
  49             <term>GConf</term>
  50             <listitem><para>
  51                 GConf is a system for storing application preferences. It is intended for user preferences; not configuration of something like Apache, or arbitrary data storage.
  52               </para></listitem>
  53           </varlistentry>
  54
  55           <varlistentry>
  56             <term>libcanberra</term>
  57             <listitem><para>
  58                 libcanberra is an implementation of the XDG Sound Theme and Name Specifications, for generating event sounds on free desktops, such as GNOME.
  59               </para></listitem>
  60           </varlistentry>
  61
  62         </variablelist>
  63
  64       </para>
  65     </partintro>
  66     &hildon-Building;
  67     &hildon-Compiling;
  68     &hildon-Running;
  69     &hildon-Resources;
  70   </part>
  71
  72   <part id="hildonbase">
  73     <title>Hildon Core Reference</title>
  74     <xi:include href="xml/hildon-main.xml"/>
  75     <xi:include href="xml/hildon-gtk.xml"/>
  76     <xi:include href="xml/hildon-defines.xml"/>
  77     <xi:include href="xml/hildon-helper.xml"/>
  78     <xi:include href="xml/hildon-sound.xml"/>
  79     <xi:include href="xml/hildon-program.xml"/>
  80   </part>
  81
  82   <part id="hildonobjects">
  83     <title>Hildon Widgets and Objects</title>
  84
  85     <chapter>
  86       <title>Object Hierarchy</title>
  87       <xi:include href="xml/tree_index.sgml"/>
  88     </chapter>
  89
  90     <chapter>
  91       <title>Widgets gallery</title>
  92       <xi:include href="visual_index.xml"/>
  93     </chapter>
  94
  95     <chapter>
  96       <title>Toplevel Widgets</title>
  97       <xi:include href="xml/hildon-window.xml"/>
  98       <xi:include href="xml/hildon-stackable-window.xml"/>
  99     </chapter>
 100
 101     <chapter>
 102       <title>Window Stacking</title>
 103       <xi:include href="xml/hildon-window-stack.xml"/>
 104     </chapter>
 105
 106     <chapter>
 107       <title>Buttons and Toggles</title>
 108       <xi:include href="xml/hildon-button.xml"/>
 109       <xi:include href="xml/hildon-check-button.xml"/>
 110       <xi:include href="xml/hildon-picker-button.xml"/>
 111       <xi:include href="xml/hildon-date-button.xml"/>
 112       <xi:include href="xml/hildon-time-button.xml"/>
 113     </chapter>
 114
 115     <chapter>
 116       <title>Display and Notification Widgets</title>
 117       <xi:include href="xml/hildon-caption.xml"/>
 118       <xi:include href="xml/hildon-banner.xml"/>
 119       <xi:include href="xml/hildon-note.xml"/>
 120     </chapter>
 121
 122     <chapter>
 123       <title>Data Selection and Handling</title>
 124       <xi:include href="xml/hildon-touch-selector.xml"/>
 125       <xi:include href="xml/hildon-touch-selector-column.xml"/>
 126       <xi:include href="xml/hildon-touch-selector-entry.xml"/>
 127       <xi:include href="xml/hildon-date-selector.xml"/>
 128       <xi:include href="xml/hildon-time-selector.xml"/>
 129     </chapter>
 130
 131     <chapter>
 132       <title>Navigation Widgets</title>
 133       <xi:include href="xml/hildon-pannable-area.xml"/>
 134     </chapter>
 135
 136     <chapter>
 137       <title>Text Display and Handling</title>
 138       <xi:include href="xml/hildon-entry.xml"/>
 139       <xi:include href="xml/hildon-text-view.xml"/>
 140     </chapter>
 141
 142     <chapter>
 143       <title>Menus and Toolbars</title>
 144       <xi:include href="xml/hildon-app-menu.xml"/>
 145       <xi:include href="xml/hildon-find-toolbar.xml"/>
 146       <xi:include href="xml/hildon-edit-toolbar.xml"/>
 147     </chapter>
 148
 149     <chapter>
 150       <title>Dialogs</title>
 151       <xi:include href="xml/hildon-wizard-dialog.xml"/>
 152       <xi:include href="xml/hildon-picker-dialog.xml"/>
 153     </chapter>
 154
 155     <chapter>
 156       <title>Deprecated</title>
 157       <xi:include href="xml/hildon-color-button.xml"/>
 158       <xi:include href="xml/hildon-color-chooser.xml"/>
 159       <xi:include href="xml/hildon-controlbar.xml"/>
 160       <xi:include href="xml/hildon-volumebar.xml"/>
 161       <xi:include href="xml/hildon-vvolumebar.xml"/>
 162       <xi:include href="xml/hildon-hvolumebar.xml"/>
 163       <xi:include href="xml/hildon-seekbar.xml"/>
 164       <xi:include href="xml/hildon-calendar.xml"/>
 165       <xi:include href="xml/hildon-calendar-popup.xml"/>
 166       <xi:include href="xml/hildon-weekday-picker.xml"/>
 167       <xi:include href="xml/hildon-time-picker.xml"/>
 168       <xi:include href="xml/hildon-number-editor.xml"/>
 169       <xi:include href="xml/hildon-range-editor.xml"/>
 170       <xi:include href="xml/hildon-time-editor.xml"/>
 171       <xi:include href="xml/hildon-date-editor.xml"/>
 172       <xi:include href="xml/hildon-bread-crumb-trail.xml"/>
 173       <xi:include href="xml/hildon-dialog.xml"/>
 174       <xi:include href="xml/hildon-color-chooser-dialog.xml"/>
 175       <xi:include href="xml/hildon-set-password-dialog.xml"/>
 176       <xi:include href="xml/hildon-get-password-dialog.xml"/>
 177       <xi:include href="xml/hildon-login-dialog.xml"/>
 178       <xi:include href="xml/hildon-sort-dialog.xml"/>
 179       <xi:include href="xml/hildon-font-selection-dialog.xml"/>
 180       <xi:include href="xml/hildon-code-dialog.xml"/>
 181       <xi:include href="xml/hildon-bread-crumb.xml"/>
 182     </chapter>
 183
 184   </part>
 185
 186   <part id="hildonmigration">
 187     <title>Migration</title>
 188     <partintro>
 189       <para>This section helps you migrate widgets that are deprecated by
 190       providing an alternative to them. Most sections have examples
 191       of how a given deprecated widget was used and provide another example
 192       of how the functionality of that widget should be accomplished in
 193       newly written code.</para>
 194     </partintro>
 195     &hildon-Migration;
 196   </part>
 197
 198   <index>
 199     <title>Index</title>
 200   </index>
 201
 202   <index role="deprecated">
 203     <title>Index of deprecated symbols</title>
 204   </index>
 205
 206   <index role="2.2">
 207     <title>Index of new symbols in 2.2</title>
 208   </index>
 209
 210   <!-- New symbols index -->
 211
 212 </book>