← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/xml/mg-work-matrix.xml

  • 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/xml/mg-work-matrix.xml
1
 
<refentry id="MgWorkMatrix">
2
 
<refmeta>
3
 
<refentrytitle>MgWorkMatrix</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBMERGEANT Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>MgWorkMatrix</refname><refpurpose>Widget to modify the assoctations between two tables</refpurpose>
10
 
</refnamediv>
11
 
 
12
 
<refsynopsisdiv><title>Synopsis</title>
13
 
 
14
 
<synopsis>
15
 
 
16
 
 
17
 
 
18
 
struct      <link linkend="MgWorkMatrix-struct">MgWorkMatrix</link>;
19
 
enum        <link linkend="MgWorkMatrixType">MgWorkMatrixType</link>;
20
 
<link linkend="guint">guint</link>       <link linkend="mg-work-matrix-get-type">mg_work_matrix_get_type</link>         (void);
21
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="mg-work-matrix-new">mg_work_matrix_new</link>              (<link linkend="MgConf">MgConf</link> *conf,
22
 
                                             <link linkend="MgQuery">MgQuery</link> *rows_select_query,
23
 
                                             <link linkend="MgTarget">MgTarget</link> *rows_target,
24
 
                                             <link linkend="MgQuery">MgQuery</link> *cols_select_query,
25
 
                                             <link linkend="MgTarget">MgTarget</link> *cols_target,
26
 
                                             <link linkend="MgDbTable">MgDbTable</link> *modif_table,
27
 
                                             <link linkend="GSList">GSList</link> *modif_table_fields);
28
 
<link linkend="void">void</link>        <link linkend="mg-work-matrix-set-view-type">mg_work_matrix_set_view_type</link>    (<link linkend="MgWorkMatrix">MgWorkMatrix</link> *matrix,
29
 
                                             <link linkend="MgWorkMatrixType">MgWorkMatrixType</link> type);
30
 
</synopsis>
31
 
</refsynopsisdiv>
32
 
 
33
 
<refsect1>
34
 
<title>Object Hierarchy</title>
35
 
<synopsis>
36
 
 
37
 
  <link linkend="GObject">GObject</link>
38
 
   +----<link linkend="GtkObject">GtkObject</link>
39
 
         +----<link linkend="GtkWidget">GtkWidget</link>
40
 
               +----<link linkend="GtkContainer">GtkContainer</link>
41
 
                     +----<link linkend="GtkBox">GtkBox</link>
42
 
                           +----<link linkend="GtkVBox">GtkVBox</link>
43
 
                                 +----MgWorkMatrix
44
 
</synopsis>
45
 
 
46
 
</refsect1>
47
 
 
48
 
 
49
 
 
50
 
<refsect1>
51
 
<title>Implemented Interfaces</title>
52
 
<para>
53
 
MgWorkMatrix implements
54
 
 <link linkend="MgWorkWidget">MgWorkWidget</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
55
 
 
56
 
</refsect1>
57
 
 
58
 
 
59
 
<refsect1>
60
 
<title>Properties</title>
61
 
<synopsis>
62
 
 
63
 
  &quot;<link linkend="MgWorkMatrix--assoc-data-only">assoc-data-only</link>&quot;      <link linkend="gboolean">gboolean</link>             : Write
64
 
  &quot;<link linkend="MgWorkMatrix--layout-nb-columns">layout-nb-columns</link>&quot;    <link linkend="gint">gint</link>                 : Read / Write
65
 
  &quot;<link linkend="MgWorkMatrix--title-string">title-string</link>&quot;         <link linkend="gchararray">gchararray</link>           : Write
66
 
  &quot;<link linkend="MgWorkMatrix--title-visible">title-visible</link>&quot;        <link linkend="gboolean">gboolean</link>             : Write
67
 
</synopsis>
68
 
</refsect1>
69
 
 
70
 
 
71
 
 
72
 
<refsect1>
73
 
<title>Description</title>
74
 
<para>
75
 
This widget provides an easy way of modifying the contents of an association table (a table
76
 
which purpose is to store the primary keys of two or more tables, as foreign keys, and
77
 
optionnaly some associated data).
78
 
</para>
79
 
<para>
80
 
Upon widget creation, the SELECT queries limiting the values of the two associated tables are required,
81
 
as well as the <link linkend="MgDbTable"><type>MgDbTable</type></link> table which will be modified. The widget then uses the Foreign key constraints
82
 
defined in the data dictionnary to define the real modification queries.
83
 
</para>
84
 
</refsect1>
85
 
 
86
 
<refsect1>
87
 
<title>Details</title>
88
 
<refsect2>
89
 
<title><anchor id="MgWorkMatrix-struct"/>struct MgWorkMatrix</title>
90
 
<indexterm><primary>MgWorkMatrix</primary></indexterm><programlisting>struct MgWorkMatrix;</programlisting>
91
 
<para>
92
 
 
93
 
</para></refsect2>
94
 
<refsect2>
95
 
<title><anchor id="MgWorkMatrixType"/>enum MgWorkMatrixType</title>
96
 
<indexterm><primary>MgWorkMatrixType</primary></indexterm><programlisting>typedef enum {
97
 
        MG_WORK_MATRIX_TABULAR_SYNTHETIC = 0,
98
 
        MG_WORK_MATRIX_LIST_DETAILLED    = 1,
99
 
        MG_WORK_MATRIX_LIST_SYNTHETIC    = 2,
100
 
} MgWorkMatrixType;
101
 
</programlisting>
102
 
<para>
103
 
 
104
 
</para></refsect2>
105
 
<refsect2>
106
 
<title><anchor id="mg-work-matrix-get-type"/>mg_work_matrix_get_type ()</title>
107
 
<indexterm><primary>mg_work_matrix_get_type</primary></indexterm><programlisting><link linkend="guint">guint</link>       mg_work_matrix_get_type         (void);</programlisting>
108
 
<para>
109
 
 
110
 
</para><variablelist role="params">
111
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
112
 
 
113
 
 
114
 
</simpara></listitem></varlistentry>
115
 
</variablelist></refsect2>
116
 
<refsect2>
117
 
<title><anchor id="mg-work-matrix-new"/>mg_work_matrix_new ()</title>
118
 
<indexterm><primary>mg_work_matrix_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  mg_work_matrix_new              (<link linkend="MgConf">MgConf</link> *conf,
119
 
                                             <link linkend="MgQuery">MgQuery</link> *rows_select_query,
120
 
                                             <link linkend="MgTarget">MgTarget</link> *rows_target,
121
 
                                             <link linkend="MgQuery">MgQuery</link> *cols_select_query,
122
 
                                             <link linkend="MgTarget">MgTarget</link> *cols_target,
123
 
                                             <link linkend="MgDbTable">MgDbTable</link> *modif_table,
124
 
                                             <link linkend="GSList">GSList</link> *modif_table_fields);</programlisting>
125
 
<para>
126
 
Creates a new <link linkend="MgWorkMatrix"><type>MgWorkMatrix</type></link> widget.
127
 
</para>
128
 
<para>
129
 
<parameter>rows_select_query</parameter> and <parameter>cols_select_query</parameter> must be SELECT queries, from their results depend what
130
 
will be displayed in each row and column of the associated matrix widget.
131
 
</para>
132
 
<para>
133
 
The <parameter>rows_target</parameter> and <parameter>cols_target</parameter> targets are used as reference for primary key values.</para>
134
 
<para>
135
 
 
136
 
</para><variablelist role="params">
137
 
<varlistentry><term><parameter>conf</parameter>&nbsp;:</term>
138
 
<listitem><simpara> a <link linkend="MgConf"><type>MgConf</type></link> object
139
 
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><parameter>rows_select_query</parameter>&nbsp;:</term>
141
 
<listitem><simpara>
142
 
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><parameter>rows_target</parameter>&nbsp;:</term>
144
 
<listitem><simpara>
145
 
</simpara></listitem></varlistentry>
146
 
<varlistentry><term><parameter>cols_select_query</parameter>&nbsp;:</term>
147
 
<listitem><simpara>
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><parameter>cols_target</parameter>&nbsp;:</term>
150
 
<listitem><simpara>
151
 
</simpara></listitem></varlistentry>
152
 
<varlistentry><term><parameter>modif_table</parameter>&nbsp;:</term>
153
 
<listitem><simpara>
154
 
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><parameter>modif_table_fields</parameter>&nbsp;:</term>
156
 
<listitem><simpara>
157
 
</simpara></listitem></varlistentry>
158
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new widget
159
 
</simpara></listitem></varlistentry>
160
 
</variablelist></refsect2>
161
 
<refsect2>
162
 
<title><anchor id="mg-work-matrix-set-view-type"/>mg_work_matrix_set_view_type ()</title>
163
 
<indexterm><primary>mg_work_matrix_set_view_type</primary></indexterm><programlisting><link linkend="void">void</link>        mg_work_matrix_set_view_type    (<link linkend="MgWorkMatrix">MgWorkMatrix</link> *matrix,
164
 
                                             <link linkend="MgWorkMatrixType">MgWorkMatrixType</link> type);</programlisting>
165
 
<para>
166
 
Select which way the <parameter>matrix</parameter> widget must present its interface</para>
167
 
<para>
168
 
 
169
 
</para><variablelist role="params">
170
 
<varlistentry><term><parameter>matrix</parameter>&nbsp;:</term>
171
 
<listitem><simpara> a <link linkend="MgWorkMatrix"><type>MgWorkMatrix</type></link> widget
172
 
</simpara></listitem></varlistentry>
173
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
174
 
<listitem><simpara> a <link linkend="MgWorkMatrixType"><type>MgWorkMatrixType</type></link> value
175
 
</simpara></listitem></varlistentry>
176
 
</variablelist></refsect2>
177
 
 
178
 
</refsect1>
179
 
<refsect1>
180
 
<title>Properties</title>
181
 
<variablelist>
182
 
<varlistentry><term><anchor id="MgWorkMatrix--assoc-data-only"/>&quot;<literal>assoc-data-only</literal>&quot; (<link linkend="gboolean">gboolean</link> : Write)</term>
183
 
<listitem>
184
 
<para>Disallow INSERT and DELETE on the modified table.</para>
185
 
</listitem></varlistentry>
186
 
<varlistentry><term><anchor id="MgWorkMatrix--layout-nb-columns"/>&quot;<literal>layout-nb-columns</literal>&quot; (<link linkend="gint">gint</link> : Read / Write)</term>
187
 
<listitem>
188
 
<para>Number of columns when the chosen view involves a table layout.</para>
189
 
</listitem></varlistentry>
190
 
<varlistentry><term><anchor id="MgWorkMatrix--title-string"/>&quot;<literal>title-string</literal>&quot; (<link linkend="gchararray">gchararray</link> : Write)</term>
191
 
<listitem>
192
 
<para>String to display in the widget's title.</para>
193
 
</listitem></varlistentry>
194
 
<varlistentry><term><anchor id="MgWorkMatrix--title-visible"/>&quot;<literal>title-visible</literal>&quot; (<link linkend="gboolean">gboolean</link> : Write)</term>
195
 
<listitem>
196
 
<para>Show of hide the title of the widget.</para>
197
 
</listitem></varlistentry>
198
 
 
199
 
</variablelist>
200
 
</refsect1>
201
 
 
202
 
 
203
 
 
204
 
 
205
 
</refentry>