Add version info to API docs.
[platform/upstream/glib.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 <!ENTITY gobject-GType SYSTEM "xml/gtype.xml">
5 <!ENTITY gobject-GTypePlugin SYSTEM "xml/gtypeplugin.xml">
6 <!ENTITY gobject-GTypeModule SYSTEM "xml/gtypemodule.xml">
7 <!ENTITY gobject-The-Base-Object-Type SYSTEM "xml/objects.xml">
8 <!ENTITY gobject-Enumeration-and-Flag-Types SYSTEM "xml/enumerations_flags.xml">
9 <!ENTITY gobject-Boxed-Types SYSTEM "xml/gboxed.xml">
10 <!ENTITY gobject-Generic-values SYSTEM "xml/generic_values.xml">
11 <!ENTITY gobject-param-value-types SYSTEM "xml/param_value_types.xml">
12 <!ENTITY gobject-GParamSpec SYSTEM "xml/gparamspec.xml">
13 <!ENTITY gobject-Varargs-Value-Collection SYSTEM "xml/value_collection.xml">
14 <!ENTITY gobject-Signals SYSTEM "xml/signals.xml">
15 <!ENTITY gobject-Closures SYSTEM "xml/gclosure.xml">
16 <!ENTITY gobject-Value-Arrays SYSTEM "xml/value_arrays.xml">
17 <!ENTITY version SYSTEM "version.xml">
18 ]>
19 <book id="index">
20   <bookinfo>
21     <title>GObject Reference Manual</title>
22     <releaseinfo>for GLib &version;</releaseinfo>
23   </bookinfo>
24
25   <preface>
26     <title>Introduction</title>
27       <para>
28         Most modern programming languages come with their own native object
29         systems and additional fundamental algorithmic language constructs.
30         Just as GLib serves as an implementation of such fundamental
31         types and algorithms (linked lists, hash tables and so forth), the
32         GLib Object System provides the required implementations of a
33         flexible extensible and intentionally easy to map (into other
34         languages) object oriented framework for C.
35         The substantial elements that are provided can be summarized as:
36         <variablelist>
37           <varlistentry><term></term><listitem><para>
38             * A generic type system to register arbitrary single-inherited
39               flat and deep derived types as well as interfaces for
40               structured types.
41               It takes care of creation, initialization and memory management
42               of the assorted object and class structures, maintains
43               parent/child relationships and deals with dynamic implementations
44               of such types. That is, their type specific implementations are
45               relocatable/unloadable during runtime.
46           </para></listitem></varlistentry>
47           <varlistentry><term></term><listitem><para>
48             * A collection of fundamental type implementations, such as integers,
49               doubles, enums and structured types, to name a few.
50           </para></listitem></varlistentry>
51           <varlistentry><term></term><listitem><para>
52             * A sample fundamental type implementation to base object hierarchies
53               upon - the GObject fundamental type.
54           </para></listitem></varlistentry>
55           <varlistentry><term></term><listitem><para>
56             * A signal system that allows very flexible user customization of
57               virtual/overridable object methods and can serve as a powerful
58               notification mechanism.
59           </para></listitem></varlistentry>
60           <varlistentry><term></term><listitem><para>
61             * An extensible parameter/value system, supporting all the provided
62               fundamental types that can be used to generically handle object
63               properties or otherwise parameterized types.
64           </para></listitem></varlistentry>
65         </variablelist>
66       </para>
67   </preface>
68
69   <reference>
70     <title>API Reference</title>
71     
72       &gobject-GType;
73       &gobject-GTypePlugin;
74       &gobject-GTypeModule;
75       &gobject-The-Base-Object-Type;
76       &gobject-Enumeration-and-Flag-Types;
77       &gobject-Boxed-Types;
78       &gobject-Generic-values;
79       &gobject-param-value-types;
80       &gobject-Varargs-Value-Collection;
81       &gobject-GParamSpec;
82       &gobject-Signals;
83       &gobject-Closures;
84       &gobject-Value-Arrays;
85       
86   </reference>
87   
88 </book>