← Back to branch summary

~ubuntu-branches/ubuntu/karmic/mergeant/karmic

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/libmergeant-docs.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo R. Montesino
  • Date: 2007-11-29 08:44:48 UTC
  • mfrom: (2.1.4 hardy)
  • Revision ID: james.westby@ubuntu.com-20071129084448-6aon73d22bv6hzfw
Tags: 0.67-3
* Re-enable installation of the mime files in mergeant.install
* mergeant.dirs: create usr/share/mime/packages to make dh_installmime add
  the update-mime-database code snippets

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libmergeant/C/libmergeant-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 index-Object-Tree SYSTEM "xml/tree_index.sgml">
5
 
<!ENTITY libmergeant-Intro SYSTEM "intro.sgml">
6
 
<!ENTITY libmergeant-Example SYSTEM "example.sgml">
7
 
<!ENTITY fullexample SYSTEM "examples/full_example.c" NDATA linespecific>
8
 
<!ENTITY libmergeant-MgConf SYSTEM "xml/mg-conf.xml">
9
 
<!ENTITY libmergeant-MgServer SYSTEM "xml/mg-server.xml">
10
 
<!ENTITY libmergeant-MgBase SYSTEM "xml/mg-base.xml">
11
 
<!ENTITY libmergeant-MgXmlStorage SYSTEM "xml/mg-xml-storage.xml">
12
 
<!ENTITY libmergeant-MgResultSet SYSTEM "xml/mg-result-set.xml">
13
 
<!ENTITY libmergeant-MgServerDataType SYSTEM "xml/mg-server-data-type.xml">
14
 
<!ENTITY libmergeant-MgServerFunction SYSTEM "xml/mg-server-function.xml">
15
 
<!ENTITY libmergeant-MgServerAggregate SYSTEM "xml/mg-server-aggregate.xml">
16
 
<!ENTITY libmergeant-MgDataHandler SYSTEM "xml/mg-data-handler.xml">
17
 
<!ENTITY libmergeant-MgDataEntry SYSTEM "xml/mg-data-entry.xml">
18
 
<!ENTITY libmergeant-MgEntryShell SYSTEM "xml/mg-entry-shell.xml">
19
 
<!ENTITY libmergeant-MgEntryString SYSTEM "xml/mg-entry-string.xml">
20
 
<!ENTITY libmergeant-MgEntryCombo SYSTEM "xml/mg-entry-combo.xml">
21
 
<!ENTITY libmergeant-MgEntryWrapper SYSTEM "xml/mg-entry-wrapper.xml">
22
 
<!ENTITY libmergeant-MgHandlerString SYSTEM "xml/mg-handler-string.xml">
23
 
<!ENTITY libmergeant-MgHandlerBoolean SYSTEM "xml/mg-handler-boolean.xml">
24
 
<!ENTITY libmergeant-MgHandlerTime SYSTEM "xml/mg-handler-time.xml">
25
 
<!ENTITY libmergeant-MgHandlerNumerical SYSTEM "xml/mg-handler-numerical.xml">
26
 
<!ENTITY libmergeant-MgEntryBoolean SYSTEM "xml/mg-entry-boolean.xml">
27
 
<!ENTITY libmergeant-MgHandlerNone SYSTEM "xml/mg-handler-none.xml">
28
 
<!ENTITY libmergeant-MgEntryNone SYSTEM "xml/mg-entry-none.xml">
29
 
<!ENTITY libmergeant-MgEntryTime SYSTEM "xml/mg-entry-time.xml">
30
 
<!ENTITY libmergeant-MgHandlerText SYSTEM "xml/mg-handler-text.xml">
31
 
<!ENTITY libmergeant-MgHandlerCidr SYSTEM "xml/mg-handler-cidr.xml">
32
 
<!ENTITY libmergeant-MgHandlerPassmd5 SYSTEM "xml/mg-handler-passmd5.xml">
33
 
<!ENTITY libmergeant-MgEntryCidr SYSTEM "xml/mg-entry-cidr.xml">
34
 
<!ENTITY libmergeant-MgEntryPassmd5 SYSTEM "xml/mg-entry-passmd5.xml">
35
 
<!ENTITY libmergeant-MgSelector SYSTEM "xml/mg-selector.xml">
36
 
<!ENTITY libmergeant-MgDbmsUpdateViewer SYSTEM "xml/mg-dbms-update-viewer.xml">
37
 
<!ENTITY libmergeant-TreeIndex SYSTEM "xml/tree_index.xml">
38
 
<!ENTITY libmergeant-ObjectIndex SYSTEM "xml/object_index.xml">
39
 
<!ENTITY libmergeant-MgDatabase SYSTEM "xml/mg-database.xml">
40
 
<!ENTITY libmergeant-MgDbTable SYSTEM "xml/mg-db-table.xml">
41
 
<!ENTITY libmergeant-MgDbField SYSTEM "xml/mg-db-field.xml">
42
 
<!ENTITY libmergeant-MgEntity SYSTEM "xml/mg-entity.xml">
43
 
<!ENTITY libmergeant-MgField SYSTEM "xml/mg-field.xml">
44
 
<!ENTITY libmergeant-MgRenderer SYSTEM "xml/mg-renderer.xml">
45
 
<!ENTITY libmergeant-MgReferer SYSTEM "xml/mg-referer.xml">
46
 
<!ENTITY libmergeant-MgDbConstraint SYSTEM "xml/mg-db-constraint.xml">
47
 
<!ENTITY libmergeant-MgRefBase SYSTEM "xml/mg-ref-base.xml">
48
 
<!ENTITY libmergeant-MgQuery SYSTEM "xml/mg-query.xml">
49
 
<!ENTITY libmergeant-MgTarget SYSTEM "xml/mg-target.xml">
50
 
<!ENTITY libmergeant-QueryIntro SYSTEM "query.sgml">
51
 
<!ENTITY libmergeant-QFintro SYSTEM "query-fields.sgml">
52
 
<!ENTITY libmergeant-MgQfield SYSTEM "xml/mg-qfield.xml">
53
 
<!ENTITY libmergeant-MgQfAll SYSTEM "xml/mg-qf-all.xml">
54
 
<!ENTITY libmergeant-MgQfField SYSTEM "xml/mg-qf-field.xml">
55
 
<!ENTITY libmergeant-MgQfFunc SYSTEM "xml/mg-qf-func.xml">
56
 
<!ENTITY libmergeant-MgQfValue SYSTEM "xml/mg-qf-value.xml">
57
 
<!ENTITY libmergeant-MgJoin SYSTEM "xml/mg-join.xml">
58
 
<!ENTITY libmergeant-MgParameter SYSTEM "xml/mg-parameter.xml">
59
 
<!ENTITY libmergeant-MgCondition SYSTEM "xml/mg-condition.xml">
60
 
<!ENTITY libmergeant-MgForm SYSTEM "xml/mg-form.xml">
61
 
<!ENTITY libmergeant-MgContext SYSTEM "xml/mg-context.xml">
62
 
<!ENTITY libmergeant-MgWorkCore SYSTEM "xml/mg-work-core.xml">
63
 
<!ENTITY libmergeant-MgWorkForm SYSTEM "xml/mg-work-form.xml">
64
 
<!ENTITY libmergeant-MgWorkGrid SYSTEM "xml/mg-work-grid.xml">
65
 
<!ENTITY libmergeant-MgWorkMatrix SYSTEM "xml/mg-work-matrix.xml">
66
 
<!ENTITY libmergeant-MgWorkWidget SYSTEM "xml/mg-work-widget.xml">
67
 
<!ENTITY libmergeant-MgGraphviz SYSTEM "xml/mg-graphviz.xml">
68
 
<!ENTITY libmergeant-MgDataCellRendererInfo SYSTEM "xml/mg-data-cell-renderer-info.xml">
69
 
<!ENTITY libmergeant-MgDataCellRendererTextual SYSTEM "xml/mg-data-cell-renderer-textual.xml">
70
 
<!ENTITY libmergeant-MgDataCellRendererBoolean SYSTEM "xml/mg-data-cell-renderer-boolean.xml">
71
 
<!ENTITY libmergeant-MgGraph SYSTEM "xml/mg-graph.xml">
72
 
<!ENTITY libmergeant-MgGraphItem SYSTEM "xml/mg-graph-item.xml">
73
 
<!ENTITY libmergeant-MgCanvas SYSTEM "xml/mg-canvas.xml">
74
 
<!ENTITY libmergeant-MgCanvasItem SYSTEM "xml/mg-canvas-item.xml">
75
 
<!ENTITY libmergeant-MgCanvasCursor SYSTEM "xml/mg-canvas-cursor.xml">
76
 
<!ENTITY libmergeant-MgCanvasTip SYSTEM "xml/mg-canvas-tip.xml">
77
 
<!ENTITY libmergeant-MgCanvasText SYSTEM "xml/mg-canvas-text.xml">
78
 
<!ENTITY libmergeant-MgCanvasField SYSTEM "xml/mg-canvas-field.xml">
79
 
<!ENTITY libmergeant-MgCanvasEntity SYSTEM "xml/mg-canvas-entity.xml">
80
 
<!ENTITY libmergeant-MgCanvasDbRelations SYSTEM "xml/mg-canvas-db-relations.xml">
81
 
<!ENTITY libmergeant-MgCustomLayout SYSTEM "xml/mg-custom-layout.xml">
82
 
<!ENTITY libmergeant-MgWorkLayout SYSTEM "xml/mg-work-layout.xml">
83
 
]>
84
 
<book id="index">
85
 
  <bookinfo>
86
 
    <title>Libmergeant Reference Manual</title>
87
 
    <authorgroup>
88
 
      <author>
89
 
      <firstname>Vivien</firstname>
90
 
      <surname>Malerba</surname>
91
 
      <affiliation>
92
 
        <address><email>malerba@gnome-db.org</email></address>
93
 
      </affiliation>
94
 
      </author>
95
 
    </authorgroup>
96
 
    <date>2003 March</date>
97
 
    <abstract>
98
 
      <para>
99
 
        The Libmergeant library aims at making relational database's data easy to manage by providing
100
 
        a complete meta-data dictionnary and several powerfull widgets to build applications upon.
101
 
      </para>
102
 
    </abstract>
103
 
  </bookinfo>
104
 
  &libmergeant-Intro;
105
 
  <chapter>
106
 
    <title>Objects related to the DBMS server</title>
107
 
    &libmergeant-MgConf;
108
 
    &libmergeant-MgServer;
109
 
    &libmergeant-MgResultSet;
110
 
    &libmergeant-MgServerDataType;
111
 
    &libmergeant-MgServerFunction;
112
 
    &libmergeant-MgServerAggregate;
113
 
    <para>Related interface: <link linkend="MgXmlStorage">MgXmlStorage</link></para>
114
 
  </chapter>
115
 
  <chapter>
116
 
    <title>Objects related to the database structure</title>
117
 
    <para>
118
 
      These objects participate in the elaboration of an in memory representation of a database structure (Tables, fields, ...). Related interfaces:  
119
 
      <link linkend="MgXmlStorage">MgXmlStorage</link>, <link linkend="MgEntity">MgEntity</link>,
120
 
      <link linkend="MgField">MgField</link>, <link linkend="MgRenderer">MgRenderer</link> and 
121
 
      <link linkend="MgReferer">MgReferer</link>.
122
 
    </para>
123
 
    &libmergeant-MgDatabase;
124
 
    &libmergeant-MgDbTable;
125
 
    &libmergeant-MgDbField;
126
 
    &libmergeant-MgDbConstraint;
127
 
  </chapter>
128
 
  <chapter>
129
 
    <title>Objects related to queries</title>
130
 
    &libmergeant-QueryIntro;
131
 
    &libmergeant-MgQuery;
132
 
    &libmergeant-MgTarget;
133
 
    &libmergeant-QFintro;
134
 
    &libmergeant-MgJoin;
135
 
    &libmergeant-MgCondition;
136
 
    &libmergeant-MgParameter;
137
 
    &libmergeant-MgContext;
138
 
  </chapter>
139
 
  <chapter>
140
 
   <title>Interfaces</title>
141
 
    &libmergeant-MgXmlStorage;
142
 
    &libmergeant-MgDataHandler;
143
 
    &libmergeant-MgDataEntry;
144
 
    &libmergeant-MgEntity;
145
 
    &libmergeant-MgField;
146
 
    &libmergeant-MgRenderer;
147
 
    &libmergeant-MgReferer;
148
 
    &libmergeant-MgWorkWidget;
149
 
  </chapter>
150
 
  <chapter>
151
 
   <title>Widgets</title>
152
 
   &libmergeant-MgSelector;
153
 
   &libmergeant-MgWorkForm;
154
 
   &libmergeant-MgWorkGrid;
155
 
   &libmergeant-MgWorkMatrix;
156
 
   &libmergeant-MgWorkLayout;
157
 
   &libmergeant-MgDbmsUpdateViewer;
158
 
   &libmergeant-MgForm;
159
 
  </chapter>
160
 
  <chapter>
161
 
   <title>Graphing objects and widgets</title>
162
 
   &libmergeant-MgGraph;
163
 
   &libmergeant-MgGraphItem;
164
 
   &libmergeant-MgCanvas;
165
 
   &libmergeant-MgCanvasDbRelations;
166
 
   &libmergeant-MgCanvasItem;
167
 
   &libmergeant-MgCanvasEntity;
168
 
   &libmergeant-MgCanvasField;
169
 
   &libmergeant-MgCanvasTip;
170
 
   &libmergeant-MgCanvasCursor;
171
 
   &libmergeant-MgCanvasText;
172
 
  </chapter>
173
 
  <chapter>
174
 
   <title>Data handlers</title>
175
 
    <para>
176
 
    The objects listed in this section implement the <link linkend="MgDataHandler">MgDataHandler</link> interface.
177
 
    </para>
178
 
    <sect1>
179
 
    <title>Built in data handlers</title>
180
 
    &libmergeant-MgHandlerString;
181
 
    &libmergeant-MgHandlerBoolean;
182
 
    &libmergeant-MgHandlerTime;
183
 
    &libmergeant-MgHandlerNumerical;
184
 
    &libmergeant-MgHandlerNone;
185
 
    </sect1>
186
 
    <sect1>
187
 
    <title>Plugins data handlers</title>
188
 
    &libmergeant-MgHandlerText;
189
 
    &libmergeant-MgHandlerCidr;
190
 
    &libmergeant-MgHandlerPassmd5;
191
 
    </sect1>
192
 
  </chapter>
193
 
  <chapter>
194
 
   <title>Data Entry widgets</title>
195
 
   <para>
196
 
   The widgets listed in this section implement the MgDataEntry interface. They are useally created using the
197
 
   corresponding MgDataHandler data handler.
198
 
   </para>
199
 
   <sect1>
200
 
   <title>Built in</title>
201
 
     &libmergeant-MgEntryString;
202
 
     &libmergeant-MgEntryBoolean;
203
 
     &libmergeant-MgEntryTime;
204
 
     &libmergeant-MgEntryNone;
205
 
     &libmergeant-MgEntryCombo;
206
 
   </sect1>
207
 
   <sect1>
208
 
   <title>Plugins</title>
209
 
     &libmergeant-MgEntryCidr;
210
 
     &libmergeant-MgEntryPassmd5;
211
 
   </sect1>
212
 
   <sect1>
213
 
   <title>Cell Renderers (used in GtkTreeView widgets)</title>
214
 
     &libmergeant-MgDataCellRendererInfo;
215
 
     &libmergeant-MgDataCellRendererTextual;
216
 
     &libmergeant-MgDataCellRendererBoolean;
217
 
   </sect1>
218
 
  </chapter>
219
 
  <chapter>
220
 
   <title>Utility objects</title>
221
 
    &libmergeant-MgRefBase;
222
 
    &libmergeant-MgCustomLayout;
223
 
    &libmergeant-MgGraphviz;
224
 
    &libmergeant-MgWorkCore;
225
 
  </chapter>
226
 
  <chapter>
227
 
   <title>Non instantiable objects and widgets</title>
228
 
    &libmergeant-MgBase;
229
 
    &libmergeant-MgEntryShell;
230
 
    &libmergeant-MgEntryWrapper;
231
 
  </chapter>
232
 
  <chapter>
233
 
  <title>Object Hierarchy</title>
234
 
    &index-Object-Tree;
235
 
  </chapter>
236
 
</book>