summaryrefslogtreecommitdiffstats
path: root/subprojects/libhandy/doc/handy-docs.xml
blob: 0bf7eab696b1f72b8e9706b853835d9b2aa8f8ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<book id="index">
  <bookinfo>
    <title>&package_name; Reference Manual</title>
    <releaseinfo>
      <para>This document is the API reference for &package_name; &package_version;.</para>
      <para>
        <ulink type="http" url="&package_url;">Handy</ulink> is a library to help you write apps for GTK/GNOME based mobile phones.
      </para>
      <para>
        If you find any issues in this API reference, please report it using
        <ulink type="http" url="&package_bugreport;">the bugtracker</ulink>.
      </para>
    </releaseinfo>

    <copyright>
      <year>2017-2020</year>
      <holder>Purism SPC</holder>
    </copyright>
  </bookinfo>

  <chapter id="intro">
    <title>Introduction</title>

    <xi:include href="build-howto.xml"/>
    <xi:include href="visual-index.xml"/>
  </chapter>

  <chapter id="core-api">
    <title>Widgets and Objects</title>
    <xi:include href="xml/hdy-action-row.xml"/>
    <xi:include href="xml/hdy-animation.xml"/>
    <xi:include href="xml/hdy-application-window.xml"/>
    <xi:include href="xml/hdy-avatar.xml"/>
    <xi:include href="xml/hdy-carousel.xml"/>
    <xi:include href="xml/hdy-carousel-indicator-dots.xml"/>
    <xi:include href="xml/hdy-carousel-indicator-lines.xml"/>
    <xi:include href="xml/hdy-clamp.xml"/>
    <xi:include href="xml/hdy-combo-row.xml"/>
    <xi:include href="xml/hdy-deck.xml"/>
    <xi:include href="xml/hdy-enum-value-object.xml"/>
    <xi:include href="xml/hdy-expander-row.xml"/>
    <xi:include href="xml/hdy-header-bar.xml"/>
    <xi:include href="xml/hdy-header-group.xml"/>
    <xi:include href="xml/hdy-keypad.xml"/>
    <xi:include href="xml/hdy-leaflet.xml"/>
    <xi:include href="xml/hdy-navigation-direction.xml"/>
    <xi:include href="xml/hdy-preferences-group.xml"/>
    <xi:include href="xml/hdy-preferences-page.xml"/>
    <xi:include href="xml/hdy-preferences-row.xml"/>
    <xi:include href="xml/hdy-preferences-window.xml"/>
    <xi:include href="xml/hdy-search-bar.xml"/>
    <xi:include href="xml/hdy-squeezer.xml"/>
    <xi:include href="xml/hdy-swipeable.xml"/>
    <xi:include href="xml/hdy-swipe-group.xml"/>
    <xi:include href="xml/hdy-swipe-tracker.xml"/>
    <xi:include href="xml/hdy-title-bar.xml"/>
    <xi:include href="xml/hdy-value-object.xml"/>
    <xi:include href="xml/hdy-view-switcher.xml"/>
    <xi:include href="xml/hdy-view-switcher-bar.xml"/>
    <xi:include href="xml/hdy-view-switcher-title.xml"/>
    <xi:include href="xml/hdy-window.xml"/>
    <xi:include href="xml/hdy-window-handle.xml"/>
  </chapter>

  <chapter id="helpers">
    <title>Helpers</title>
    <xi:include href="xml/hdy-version.xml"/>
    <xi:include href="xml/hdy-main.xml"/>
  </chapter>

  <chapter id="migrating">
    <title>Migrating from Previous Versions of Handy</title>

    <xi:include href="hdy-migrating-0-0-to-1.xml"/>
  </chapter>

  <chapter id="object-tree">
    <title>Object Hierarchy</title>
    <xi:include href="xml/tree_index.sgml"/>
  </chapter>

  <index id="api-index-full">
    <title>API Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
  </index>

  <index id="deprecated-api-index" role="deprecated">
    <title>Index of deprecated API</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-0-6" role="0.0.6">
    <title>Index of new symbols in 0.0.6</title>
    <xi:include href="xml/api-index-0.0.6.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-0-7" role="0.0.7">
    <title>Index of new symbols in 0.0.7</title>
    <xi:include href="xml/api-index-0.0.7.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-0-8" role="0.0.8">
    <title>Index of new symbols in 0.0.8</title>
    <xi:include href="xml/api-index-0.0.8.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-0-10" role="0.0.10">
    <title>Index of new symbols in 0.0.10</title>
    <xi:include href="xml/api-index-0.0.10.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-0-11" role="0.0.11">
    <title>Index of new symbols in 0.0.11</title>
    <xi:include href="xml/api-index-0.0.11.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-0-0-12" role="0.0.12">
    <title>Index of new symbols in 0.0.12</title>
    <xi:include href="xml/api-index-0.0.12.xml"><xi:fallback /></xi:include>
  </index>

  <index id="api-index-1-0" role="1.0">
    <title>Index of new symbols in 1.0</title>
    <xi:include href="xml/api-index-1.0.xml"><xi:fallback /></xi:include>
  </index>

  <index id="annotations-glossary">
  <title>Annotations glossary</title>
  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
  </index>

</book>