Tizen 2.1 base
[platform/upstream/glib2.0.git] / docs / reference / gobject / gobject-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
5 <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
6 <!ENTITY version SYSTEM "version.xml">
7 ]>
8 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
9   <bookinfo>
10     <title>GObject Reference Manual</title>
11     <releaseinfo>
12       for GObject &version;
13       The latest version of this documentation can be found on-line at
14       <ulink role="online-location" url="http://library.gnome.org/devel/gobject/unstable/">http://library.gnome.org/devel/gobject/unstable/</ulink>.
15     </releaseinfo>
16   </bookinfo>
17
18   <preface>
19     <title>Introduction</title>
20       <para>
21                         Most modern programming languages come with their own native object
22                         systems and additional fundamental algorithmic language constructs.
23                         Just as GLib serves as an implementation of such fundamental
24                         types and algorithms (linked lists, hash tables and so forth), the
25                         GLib Object System provides the required implementations of a
26                         flexible extensible and intentionally easy to map (into other
27                         languages) object-oriented framework for C.
28                         The substantial elements that are provided can be summarized as:
29                         <itemizedlist>
30                                 <listitem><para>
31                                          A generic type system to register arbitrary single-inherited
32                                                 flat and deep derived types as well as interfaces for
33                                                 structured types.
34                                                 It takes care of creation, initialization and memory management
35                                                 of the assorted object and class structures, maintains
36                                                 parent/child relationships and deals with dynamic implementations
37                                                 of such types. That is, their type specific implementations are
38                                                 relocatable/unloadable during runtime.
39                                 </para></listitem>
40                                 <listitem><para>
41                                                 A collection of fundamental type implementations, such as integers,
42                                                 doubles, enums and structured types, to name a few.
43                                 </para></listitem>
44                                 <listitem><para>
45                                                 A sample fundamental type implementation to base object hierarchies
46                                                 upon - the GObject fundamental type.
47                                 </para></listitem>
48                                 <listitem><para>
49                                                 A signal system that allows very flexible user customization of
50                                                 virtual/overridable object methods and can serve as a powerful
51                                                 notification mechanism.
52                                 </para></listitem>
53                                 <listitem><para>
54                                                 An extensible parameter/value system, supporting all the provided
55                                                 fundamental types that can be used to generically handle object
56                                                 properties or otherwise parameterized types.
57                                 </para></listitem>
58                         </itemizedlist>
59                 </para>
60   </preface>
61
62   <part label="I">
63     <title>Concepts</title>
64
65     <xi:include href="tut_intro.xml" />
66     <xi:include href="tut_gtype.xml" />
67     <xi:include href="tut_gobject.xml" />
68     <xi:include href="tut_gsignal.xml" />
69   </part>
70   <reference label="II">
71     <title>API Reference</title>
72
73       <xi:include href="xml/gtype.xml" />
74       <xi:include href="xml/gtypeplugin.xml" />
75       <xi:include href="xml/gtypemodule.xml" />
76       <xi:include href="xml/objects.xml" />
77       <xi:include href="xml/enumerations_flags.xml" />
78       <xi:include href="xml/gboxed.xml" />
79       <xi:include href="xml/generic_values.xml" />
80       <xi:include href="xml/param_value_types.xml" />
81       <xi:include href="xml/gparamspec.xml" />
82       <xi:include href="xml/value_collection.xml" />
83       <xi:include href="xml/signals.xml" />
84       <xi:include href="xml/gclosure.xml" />
85       <xi:include href="xml/value_arrays.xml" />
86       <xi:include href="xml/gbinding.xml" />
87   </reference>
88   <reference label="III">
89     <title>Tools Reference</title>
90
91     <xi:include href="glib-mkenums.xml" />
92     <xi:include href="glib-genmarshal.xml" />
93     <xi:include href="gobject-query.xml" />
94   </reference>
95
96   <xi:include href="tut_howto.xml" />
97   <xi:include href="tut_tools.xml" />
98
99   <index id="api-index-full">
100     <title>Index</title>
101     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
102   </index>
103   <index id="api-index-deprecated" role="deprecated">
104     <title>Index of deprecated symbols</title>
105     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
106   </index>
107   <index id="api-index-2-2" role="2.2">
108     <title>Index of new symbols in 2.2</title>
109     <xi:include href="xml/api-index-2.2.xml"><xi:fallback /></xi:include>
110   </index>
111   <index id="api-index-2-4" role="2.4">
112     <title>Index of new symbols in 2.4</title>
113     <xi:include href="xml/api-index-2.4.xml"><xi:fallback /></xi:include>
114   </index>
115   <index id="api-index-2-6" role="2.6">
116     <title>Index of new symbols in 2.6</title>
117     <xi:include href="xml/api-index-2.6.xml"><xi:fallback /></xi:include>
118   </index>
119   <index id="api-index-2-8" role="2.8">
120     <title>Index of new symbols in 2.8</title>
121     <xi:include href="xml/api-index-2.8.xml"><xi:fallback /></xi:include>
122   </index>
123   <index id="api-index-2-10" role="2.10">
124     <title>Index of new symbols in 2.10</title>
125     <xi:include href="xml/api-index-2.10.xml"><xi:fallback /></xi:include>
126   </index>
127   <index id="api-index-2-12" role="2.12">
128     <title>Index of new symbols in 2.12</title>
129     <xi:include href="xml/api-index-2.12.xml"><xi:fallback /></xi:include>
130   </index>
131   <index id="api-index-2-14" role="2.14">
132     <title>Index of new symbols in 2.14</title>
133     <xi:include href="xml/api-index-2.14.xml"><xi:fallback /></xi:include>
134   </index>
135   <index id="api-index-2-18" role="2.18">
136     <title>Index of new symbols in 2.18</title>
137     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
138   </index>
139   <index id="api-index-2-22" role="2.22">
140     <title>Index of new symbols in 2.22</title>
141     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
142   </index>
143   <index id="api-index-2-24" role="2.24">
144     <title>Index of new symbols in 2.24</title>
145     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
146   </index>
147   <index id="api-index-2-26" role="2.26">
148     <title>Index of new symbols in 2.26</title>
149     <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
150   </index>
151   <index id="api-index-2-28" role="2.28">
152     <title>Index of new symbols in 2.28</title>
153     <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
154   </index>
155   <index id="api-index-2-30" role="2.30">
156     <title>Index of new symbols in 2.30</title>
157     <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
158   </index>
159   <index id="api-index-2-32" role="2.32">
160     <title>Index of new symbols in 2.32</title>
161     <xi:include href="xml/api-index-2.32.xml"><xi:fallback /></xi:include>
162   </index>
163
164   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
165
166 </book>