← 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-grid.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-grid.xml
1
 
<refentry id="MgWorkGrid">
2
 
<refmeta>
3
 
<refentrytitle>MgWorkGrid</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBMERGEANT Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>MgWorkGrid</refname><refpurpose>Grid (tabular view) to display and modify data provided by a SELECT query</refpurpose>
10
 
</refnamediv>
11
 
 
12
 
<refsynopsisdiv><title>Synopsis</title>
13
 
 
14
 
<synopsis>
15
 
 
16
 
 
17
 
 
18
 
struct      <link linkend="MgWorkGrid-struct">MgWorkGrid</link>;
19
 
<link linkend="guint">guint</link>       <link linkend="mg-work-grid-get-type">mg_work_grid_get_type</link>           (void);
20
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="mg-work-grid-new">mg_work_grid_new</link>                (<link linkend="MgQuery">MgQuery</link> *query,
21
 
                                             <link linkend="MgTarget">MgTarget</link> *modified);
22
 
<link linkend="void">void</link>        <link linkend="mg-work-grid-set-sample-size">mg_work_grid_set_sample_size</link>    (<link linkend="MgWorkGrid">MgWorkGrid</link> *grid,
23
 
                                             <link linkend="gint">gint</link> sample_size);
24
 
<link linkend="void">void</link>        <link linkend="mg-work-grid-set-sample-start">mg_work_grid_set_sample_start</link>   (<link linkend="MgWorkGrid">MgWorkGrid</link> *grid,
25
 
                                             <link linkend="gint">gint</link> sample_start);
26
 
</synopsis>
27
 
</refsynopsisdiv>
28
 
 
29
 
<refsect1>
30
 
<title>Object Hierarchy</title>
31
 
<synopsis>
32
 
 
33
 
  <link linkend="GObject">GObject</link>
34
 
   +----<link linkend="GtkObject">GtkObject</link>
35
 
         +----<link linkend="GtkWidget">GtkWidget</link>
36
 
               +----<link linkend="GtkContainer">GtkContainer</link>
37
 
                     +----<link linkend="GtkBox">GtkBox</link>
38
 
                           +----<link linkend="GtkVBox">GtkVBox</link>
39
 
                                 +----MgWorkGrid
40
 
</synopsis>
41
 
 
42
 
</refsect1>
43
 
 
44
 
 
45
 
 
46
 
<refsect1>
47
 
<title>Implemented Interfaces</title>
48
 
<para>
49
 
MgWorkGrid implements
50
 
 <link linkend="MgWorkWidget">MgWorkWidget</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
51
 
 
52
 
</refsect1>
53
 
 
54
 
 
55
 
<refsect1>
56
 
<title>Properties</title>
57
 
<synopsis>
58
 
 
59
 
  &quot;<link linkend="MgWorkGrid--actions-visible">actions-visible</link>&quot;      <link linkend="gboolean">gboolean</link>             : Write
60
 
  &quot;<link linkend="MgWorkGrid--info-cell-visible">info-cell-visible</link>&quot;    <link linkend="gboolean">gboolean</link>             : Write
61
 
  &quot;<link linkend="MgWorkGrid--title-string">title-string</link>&quot;         <link linkend="gchararray">gchararray</link>           : Write
62
 
  &quot;<link linkend="MgWorkGrid--title-visible">title-visible</link>&quot;        <link linkend="gboolean">gboolean</link>             : Write
63
 
</synopsis>
64
 
</refsect1>
65
 
 
66
 
<refsect1>
67
 
<title>Signal Prototypes</title>
68
 
<synopsis>
69
 
 
70
 
&quot;<link linkend="MgWorkGrid-selection-changed">selection-changed</link>&quot;
71
 
            <link linkend="void">void</link>        user_function      (<link linkend="MgWorkGrid">MgWorkGrid</link> *mgworkgrid,
72
 
                                            <link linkend="gboolean">gboolean</link> arg1,
73
 
                                            <link linkend="gpointer">gpointer</link> user_data);
74
 
</synopsis>
75
 
</refsect1>
76
 
 
77
 
 
78
 
<refsect1>
79
 
<title>Description</title>
80
 
<para>
81
 
This widget uses a SELECT query and displays the results of its execution, in a tabular view (one row per result).
82
 
</para>
83
 
<para>
84
 
Optionnaly, if a table to be modified (identified through a <link linkend="MgTarget"><type>MgTarget</type></link> object) is provided, the widget allows the user to 
85
 
perform some modification actions on the data (UPDATE, DELETE, INSERT operations). In this case, the queries to perform the
86
 
modifications are built by the widget and do not need to be provided by the programmer (they are computed by the <link linkend="MgWorkCore"><type>MgWorkCore</type></link>
87
 
object).
88
 
</para>
89
 
</refsect1>
90
 
 
91
 
<refsect1>
92
 
<title>Details</title>
93
 
<refsect2>
94
 
<title><anchor id="MgWorkGrid-struct"/>struct MgWorkGrid</title>
95
 
<indexterm><primary>MgWorkGrid</primary></indexterm><programlisting>struct MgWorkGrid;</programlisting>
96
 
<para>
97
 
 
98
 
</para></refsect2>
99
 
<refsect2>
100
 
<title><anchor id="mg-work-grid-get-type"/>mg_work_grid_get_type ()</title>
101
 
<indexterm><primary>mg_work_grid_get_type</primary></indexterm><programlisting><link linkend="guint">guint</link>       mg_work_grid_get_type           (void);</programlisting>
102
 
<para>
103
 
 
104
 
</para><variablelist role="params">
105
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
106
 
 
107
 
 
108
 
</simpara></listitem></varlistentry>
109
 
</variablelist></refsect2>
110
 
<refsect2>
111
 
<title><anchor id="mg-work-grid-new"/>mg_work_grid_new ()</title>
112
 
<indexterm><primary>mg_work_grid_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  mg_work_grid_new                (<link linkend="MgQuery">MgQuery</link> *query,
113
 
                                             <link linkend="MgTarget">MgTarget</link> *modified);</programlisting>
114
 
<para>
115
 
Creates a new <link linkend="MgWorkGrid"><type>MgWorkGrid</type></link> widget.
116
 
</para>
117
 
<para>
118
 
<parameter>query</parameter> must be a SELECT query (no union, etc selection query)
119
 
</para>
120
 
<para>
121
 
The <parameter>modified</parameter> target must belong to <parameter>query</parameter> and represent
122
 
modifiable entity (a <link linkend="MgDbTable"><type>MgDbTable</type></link> for example). If <parameter>modified</parameter> is <literal>NULL</literal> then
123
 
no modification will be allowed.</para>
124
 
<para>
125
 
 
126
 
</para><variablelist role="params">
127
 
<varlistentry><term><parameter>query</parameter>&nbsp;:</term>
128
 
<listitem><simpara> a <link linkend="MgQuery"><type>MgQuery</type></link> object
129
 
</simpara></listitem></varlistentry>
130
 
<varlistentry><term><parameter>modified</parameter>&nbsp;:</term>
131
 
<listitem><simpara> a <link linkend="MgTarget"><type>MgTarget</type></link> object, or <literal>NULL</literal>
132
 
</simpara></listitem></varlistentry>
133
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new widget
134
 
</simpara></listitem></varlistentry>
135
 
</variablelist></refsect2>
136
 
<refsect2>
137
 
<title><anchor id="mg-work-grid-set-sample-size"/>mg_work_grid_set_sample_size ()</title>
138
 
<indexterm><primary>mg_work_grid_set_sample_size</primary></indexterm><programlisting><link linkend="void">void</link>        mg_work_grid_set_sample_size    (<link linkend="MgWorkGrid">MgWorkGrid</link> *grid,
139
 
                                             <link linkend="gint">gint</link> sample_size);</programlisting>
140
 
<para>
141
 
</para>
142
 
<para>
143
 
 
144
 
</para><variablelist role="params">
145
 
<varlistentry><term><parameter>grid</parameter>&nbsp;:</term>
146
 
<listitem><simpara>
147
 
</simpara></listitem></varlistentry>
148
 
<varlistentry><term><parameter>sample_size</parameter>&nbsp;:</term>
149
 
<listitem><simpara>
150
 
</simpara></listitem></varlistentry>
151
 
</variablelist></refsect2>
152
 
<refsect2>
153
 
<title><anchor id="mg-work-grid-set-sample-start"/>mg_work_grid_set_sample_start ()</title>
154
 
<indexterm><primary>mg_work_grid_set_sample_start</primary></indexterm><programlisting><link linkend="void">void</link>        mg_work_grid_set_sample_start   (<link linkend="MgWorkGrid">MgWorkGrid</link> *grid,
155
 
                                             <link linkend="gint">gint</link> sample_start);</programlisting>
156
 
<para>
157
 
</para>
158
 
<para>
159
 
 
160
 
</para><variablelist role="params">
161
 
<varlistentry><term><parameter>grid</parameter>&nbsp;:</term>
162
 
<listitem><simpara>
163
 
</simpara></listitem></varlistentry>
164
 
<varlistentry><term><parameter>sample_start</parameter>&nbsp;:</term>
165
 
<listitem><simpara>
166
 
</simpara></listitem></varlistentry>
167
 
</variablelist></refsect2>
168
 
 
169
 
</refsect1>
170
 
<refsect1>
171
 
<title>Properties</title>
172
 
<variablelist>
173
 
<varlistentry><term><anchor id="MgWorkGrid--actions-visible"/>&quot;<literal>actions-visible</literal>&quot; (<link linkend="gboolean">gboolean</link> : Write)</term>
174
 
<listitem>
175
 
<para></para>
176
 
</listitem></varlistentry>
177
 
<varlistentry><term><anchor id="MgWorkGrid--info-cell-visible"/>&quot;<literal>info-cell-visible</literal>&quot; (<link linkend="gboolean">gboolean</link> : Write)</term>
178
 
<listitem>
179
 
<para></para>
180
 
</listitem></varlistentry>
181
 
<varlistentry><term><anchor id="MgWorkGrid--title-string"/>&quot;<literal>title-string</literal>&quot; (<link linkend="gchararray">gchararray</link> : Write)</term>
182
 
<listitem>
183
 
<para></para>
184
 
</listitem></varlistentry>
185
 
<varlistentry><term><anchor id="MgWorkGrid--title-visible"/>&quot;<literal>title-visible</literal>&quot; (<link linkend="gboolean">gboolean</link> : Write)</term>
186
 
<listitem>
187
 
<para></para>
188
 
</listitem></varlistentry>
189
 
 
190
 
</variablelist>
191
 
</refsect1>
192
 
 
193
 
<refsect1>
194
 
<title>Signals</title>
195
 
<refsect2><title><anchor id="MgWorkGrid-selection-changed"/>The &quot;selection-changed&quot; signal</title>
196
 
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="MgWorkGrid">MgWorkGrid</link> *mgworkgrid,
197
 
                                            <link linkend="gboolean">gboolean</link> arg1,
198
 
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
199
 
<para>
200
 
 
201
 
</para><variablelist role="params">
202
 
<varlistentry><term><parameter>mgworkgrid</parameter>&nbsp;:</term>
203
 
<listitem><simpara>the object which received the signal.
204
 
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
206
 
<listitem><simpara>
207
 
 
208
 
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
210
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
211
 
</variablelist></refsect2>
212
 
</refsect1>
213
 
 
214
 
 
215
 
 
216
 
</refentry>