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-version.xml"/>
  79     <xi:include href="xml/hildon-sound.xml"/>
  80     <xi:include href="xml/hildon-program.xml"/>
  81   </part>
  82
  83   <part id="hildonobjects">
  84     <title>Hildon Widgets and Objects</title>
  85
  86     <chapter>
  87       <title>Object Hierarchy</title>
  88       <xi:include href="xml/tree_index.sgml"/>
  89     </chapter>
  90
  91     <chapter>
  92       <title>Widgets gallery</title>
  93       <xi:include href="visual_index.xml"/>
  94     </chapter>
  95
  96     <chapter>
  97       <title>Toplevel Widgets</title>
  98       <xi:include href="xml/hildon-window.xml"/>
  99       <xi:include href="xml/hildon-stackable-window.xml"/>
 100     </chapter>
 101
 102     <chapter>
 103       <title>Window Stacking</title>
 104       <xi:include href="xml/hildon-window-stack.xml"/>
 105     </chapter>
 106
 107     <chapter>
 108       <title>Buttons and Toggles</title>
 109       <xi:include href="xml/hildon-button.xml"/>
 110       <xi:include href="xml/hildon-check-button.xml"/>
 111       <xi:include href="xml/hildon-picker-button.xml"/>
 112       <xi:include href="xml/hildon-date-button.xml"/>
 113       <xi:include href="xml/hildon-time-button.xml"/>
 114     </chapter>
 115
 116     <chapter>
 117       <title>Display and Notification Widgets</title>
 118       <xi:include href="xml/hildon-caption.xml"/>
 119       <xi:include href="xml/hildon-banner.xml"/>
 120       <xi:include href="xml/hildon-note.xml"/>
 121     </chapter>
 122
 123     <chapter>
 124       <title>Data Selection and Handling</title>
 125       <xi:include href="xml/hildon-touch-selector.xml"/>
 126       <xi:include href="xml/hildon-touch-selector-column.xml"/>
 127       <xi:include href="xml/hildon-touch-selector-entry.xml"/>
 128       <xi:include href="xml/hildon-date-selector.xml"/>
 129       <xi:include href="xml/hildon-time-selector.xml"/>
 130     </chapter>
 131
 132     <chapter>
 133       <title>Navigation Widgets</title>
 134       <xi:include href="xml/hildon-pannable-area.xml"/>
 135     </chapter>
 136
 137     <chapter>
 138       <title>Text Display and Handling</title>
 139       <xi:include href="xml/hildon-entry.xml"/>
 140       <xi:include href="xml/hildon-text-view.xml"/>
 141     </chapter>
 142
 143     <chapter>
 144       <title>Menus and Toolbars</title>
 145       <xi:include href="xml/hildon-app-menu.xml"/>
 146       <xi:include href="xml/hildon-find-toolbar.xml"/>
 147       <xi:include href="xml/hildon-edit-toolbar.xml"/>
 148     </chapter>
 149
 150     <chapter>
 151       <title>Dialogs</title>
 152       <xi:include href="xml/hildon-wizard-dialog.xml"/>
 153       <xi:include href="xml/hildon-picker-dialog.xml"/>
 154     </chapter>
 155
 156     <chapter>
 157       <title>Other</title>
 158       <xi:include href="xml/hildon-animation-actor.xml"/>
 159       <xi:include href="xml/hildon-remote-texture.xml"/>
 160     </chapter>
 161
 162     <chapter>
 163       <title>Deprecated</title>
 164       <xi:include href="xml/hildon-color-button.xml"/>
 165       <xi:include href="xml/hildon-color-chooser.xml"/>
 166       <xi:include href="xml/hildon-controlbar.xml"/>
 167       <xi:include href="xml/hildon-volumebar.xml"/>
 168       <xi:include href="xml/hildon-vvolumebar.xml"/>
 169       <xi:include href="xml/hildon-hvolumebar.xml"/>
 170       <xi:include href="xml/hildon-seekbar.xml"/>
 171       <xi:include href="xml/hildon-calendar.xml"/>
 172       <xi:include href="xml/hildon-calendar-popup.xml"/>
 173       <xi:include href="xml/hildon-weekday-picker.xml"/>
 174       <xi:include href="xml/hildon-time-picker.xml"/>
 175       <xi:include href="xml/hildon-number-editor.xml"/>
 176       <xi:include href="xml/hildon-range-editor.xml"/>
 177       <xi:include href="xml/hildon-time-editor.xml"/>
 178       <xi:include href="xml/hildon-date-editor.xml"/>
 179       <xi:include href="xml/hildon-bread-crumb-trail.xml"/>
 180       <xi:include href="xml/hildon-dialog.xml"/>
 181       <xi:include href="xml/hildon-color-chooser-dialog.xml"/>
 182       <xi:include href="xml/hildon-set-password-dialog.xml"/>
 183       <xi:include href="xml/hildon-get-password-dialog.xml"/>
 184       <xi:include href="xml/hildon-login-dialog.xml"/>
 185       <xi:include href="xml/hildon-sort-dialog.xml"/>
 186       <xi:include href="xml/hildon-font-selection-dialog.xml"/>
 187       <xi:include href="xml/hildon-code-dialog.xml"/>
 188       <xi:include href="xml/hildon-bread-crumb.xml"/>
 189     </chapter>
 190
 191   </part>
 192
 193   <part id="hildonmigration">
 194     <title>Migration</title>
 195     <partintro>
 196       <para>This section helps you migrate widgets that are deprecated by
 197       providing an alternative to them. Most sections have examples
 198       of how a given deprecated widget was used and provide another example
 199       of how the functionality of that widget should be accomplished in
 200       newly written code.</para>
 201     </partintro>
 202     &hildon-Migration;
 203   </part>
 204
 205   <index>
 206     <title>Index</title>
 207   </index>
 208
 209   <index role="deprecated">
 210     <title>Index of deprecated symbols</title>
 211   </index>
 212
 213   <index role="2.2">
 214     <title>Index of new symbols in 2.2</title>
 215   </index>
 216
 217   <!-- New symbols index -->
 218
 219 </book>