← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/html/MgWorkForm.html

  • 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/html/MgWorkForm.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>MgWorkForm</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="Libmergeant Reference Manual"><link rel="up" href="ch06.html" title="Widgets"><link rel="previous" href="MgSelector.html" title="MgSelector"><link rel="next" href="MgWorkGrid.html" title="MgWorkGrid"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css">
2
 
        .synopsis, .classsynopsis {
3
 
            background: #eeeeee;
4
 
            border: solid 1px #aaaaaa;
5
 
            padding: 0.5em;
6
 
        }
7
 
        .programlisting {
8
 
            background: #eeeeff;
9
 
            border: solid 1px #aaaaff;
10
 
            padding: 0.5em;
11
 
        }
12
 
        .variablelist {
13
 
            padding: 4px;
14
 
            margin-left: 3em;
15
 
        }
16
 
        .navigation {
17
 
            background: #ffeeee;
18
 
            border: solid 1px #ffaaaa;
19
 
            margin-top: 0.5em;
20
 
            margin-bottom: 0.5em;
21
 
        }
22
 
        .navigation a {
23
 
            color: #770000;
24
 
        }
25
 
        .navigation a:visited {
26
 
            color: #550000;
27
 
        }
28
 
        .navigation .title {
29
 
            font-size: 200%;
30
 
        }
31
 
      </style></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="MgSelector.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Libmergeant Reference Manual</th><td><a accesskey="n" href="MgWorkGrid.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="MgWorkForm"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">MgWorkForm</span></h2><p>MgWorkForm &#8212; Form to display and modify data provided by a SELECT query</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
32
 
 
33
 
 
34
 
 
35
 
struct      <a href="MgWorkForm.html#MgWorkForm-struct">MgWorkForm</a>;
36
 
guint       <a href="MgWorkForm.html#mg-work-form-get-type">mg_work_form_get_type</a>           (void);
37
 
GtkWidget*  <a href="MgWorkForm.html#mg-work-form-new">mg_work_form_new</a>                (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
38
 
                                             <a href="MgTarget.html" title="MgTarget">MgTarget</a> *modified);
39
 
GtkWidget*  <a href="MgWorkForm.html#mg-work-form-new-in-layout">mg_work_form_new_in_layout</a>      (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
40
 
                                             <a href="MgTarget.html" title="MgTarget">MgTarget</a> *modified,
41
 
                                             GtkWidget *layout,
42
 
                                             GHashTable *box_widgets);
43
 
</pre></div><div class="refsect1" lang="en"><a name="id2975696"></a><h2>Object Hierarchy</h2><pre class="synopsis">
44
 
 
45
 
  GObject
46
 
   +----GtkObject
47
 
         +----GtkWidget
48
 
               +----GtkContainer
49
 
                     +----GtkBox
50
 
                           +----GtkVBox
51
 
                                 +----MgWorkForm
52
 
</pre></div><div class="refsect1" lang="en"><a name="id2975752"></a><h2>Implemented Interfaces</h2><p>
53
 
MgWorkForm implements
54
 
 <a href="MgWorkWidget.html" title="MgWorkWidget">MgWorkWidget</a> and  AtkImplementorIface.</p></div><div class="refsect1" lang="en"><a name="id2975777"></a><h2>Properties</h2><pre class="synopsis">
55
 
 
56
 
  "<a href="MgWorkForm.html#MgWorkForm--actions-visible">actions-visible</a>"      gboolean             : Write
57
 
  "<a href="MgWorkForm.html#MgWorkForm--title-string">title-string</a>"         gchararray           : Write
58
 
  "<a href="MgWorkForm.html#MgWorkForm--title-visible">title-visible</a>"        gboolean             : Write
59
 
</pre></div><div class="refsect1" lang="en"><a name="id2975840"></a><h2>Description</h2><p>
60
 
This widget uses a SELECT query and displays the results of its execution, with buttons to move within the result rows.
61
 
</p><p>
62
 
Optionnaly, if a table to be modified (identified through a <a href="MgTarget.html" title="MgTarget"><span class="type">MgTarget</span></a> object) is provided, the widget allows the user to 
63
 
perform some modification actions on the data (UPDATE, DELETE, INSERT operations). In this case, the queries to perform the
64
 
modifications are built by the widget and do not need to be provided by the programmer (they are computed by the <a href="MgWorkCore.html" title="MgWorkCore"><span class="type">MgWorkCore</span></a>
65
 
object).
66
 
</p></div><div class="refsect1" lang="en"><a name="id2975878"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2975884"></a><h3><a name="MgWorkForm-struct"></a>struct MgWorkForm</h3><a class="indexterm" name="id2975895"></a><pre class="programlisting">struct MgWorkForm;</pre><p>
67
 
 
68
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2975910"></a><h3><a name="mg-work-form-get-type"></a>mg_work_form_get_type ()</h3><a class="indexterm" name="id2975921"></a><pre class="programlisting">guint       mg_work_form_get_type           (void);</pre><p>
69
 
 
70
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
71
 
 
72
 
 
73
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2975957"></a><h3><a name="mg-work-form-new"></a>mg_work_form_new ()</h3><a class="indexterm" name="id2975968"></a><pre class="programlisting">GtkWidget*  mg_work_form_new                (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
74
 
                                             <a href="MgTarget.html" title="MgTarget">MgTarget</a> *modified);</pre><p>
75
 
Creates a new <a href="MgWorkForm.html" title="MgWorkForm"><span class="type">MgWorkForm</span></a> widget.
76
 
</p><p>
77
 
<i class="parameter"><tt>query</tt></i> must be a SELECT query (no union, etc selection query)
78
 
</p><p>
79
 
The <i class="parameter"><tt>modified</tt></i> target must belong to <i class="parameter"><tt>query</tt></i> and represent
80
 
modifiable entity (a <a href="MgDbTable.html" title="MgDbTable"><span class="type">MgDbTable</span></a> for example). If <i class="parameter"><tt>modified</tt></i> is <tt class="literal">NULL</tt> then
81
 
no modification will be allowed.</p><p>
82
 
 
83
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>query</tt></i>�:</span></td><td> a <a href="MgQuery.html" title="MgQuery"><span class="type">MgQuery</span></a> object
84
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>modified</tt></i>�:</span></td><td> a <a href="MgTarget.html" title="MgTarget"><span class="type">MgTarget</span></a> object, or <tt class="literal">NULL</tt>
85
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new widget
86
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2976126"></a><h3><a name="mg-work-form-new-in-layout"></a>mg_work_form_new_in_layout ()</h3><a class="indexterm" name="id2976138"></a><pre class="programlisting">GtkWidget*  mg_work_form_new_in_layout      (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
87
 
                                             <a href="MgTarget.html" title="MgTarget">MgTarget</a> *modified,
88
 
                                             GtkWidget *layout,
89
 
                                             GHashTable *box_widgets);</pre><p>
90
 
Creates a new <a href="MgWorkForm.html" title="MgWorkForm"><span class="type">MgWorkForm</span></a> widget.
91
 
</p><p>
92
 
<i class="parameter"><tt>query</tt></i> must be a SELECT query (no union, etc selection query)
93
 
</p><p>
94
 
The <i class="parameter"><tt>modified</tt></i> target must belong to <i class="parameter"><tt>query</tt></i> and represent
95
 
modifiable entity (a <a href="MgDbTable.html" title="MgDbTable"><span class="type">MgDbTable</span></a> for example). If <i class="parameter"><tt>modified</tt></i> is <tt class="literal">NULL</tt> then
96
 
no modification will be allowed.
97
 
</p><p>
98
 
This function is similar to <a href="MgWorkForm.html#mg-work-form-new"><tt class="function">mg_work_form_new()</tt></a> but provides a <span class="type">GtkWidget</span> to pack
99
 
entries in. The <i class="parameter"><tt>box_widgets</tt></i> hash table has keys corresponding to the
100
 
query fields of <i class="parameter"><tt>query</tt></i>, and corresponding values pointing to the <span class="type">GtkBox</span> widgets
101
 
where the <span class="type">MGDataEntry</span> widgets will be packed.
102
 
</p><p>
103
 
If any of <i class="parameter"><tt>layout</tt></i> or <i class="parameter"><tt>box_widgets</tt></i> is <tt class="literal">NULL</tt>, then this function is equivalent to <a href="MgWorkForm.html#mg-work-form-new"><tt class="function">mg_work_form_new()</tt></a>.</p><p>
104
 
 
105
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>query</tt></i>�:</span></td><td> a <a href="MgQuery.html" title="MgQuery"><span class="type">MgQuery</span></a> object
106
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>modified</tt></i>�:</span></td><td> a <a href="MgTarget.html" title="MgTarget"><span class="type">MgTarget</span></a> object, or <tt class="literal">NULL</tt>
107
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>layout</tt></i>�:</span></td><td> a <span class="type">GtkWidget</span> object
108
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>box_widgets</tt></i>�:</span></td><td> a <span class="type">GHashTable</span> of <span class="type">GtkBox</span> widgets
109
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new widget
110
 
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2976450"></a><h2>Properties</h2><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><a name="MgWorkForm--actions-visible"></a>"<tt class="literal">actions-visible</tt>" (gboolean : Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgWorkForm--title-string"></a>"<tt class="literal">title-string</tt>" (gchararray : Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgWorkForm--title-visible"></a>"<tt class="literal">title-visible</tt>" (gboolean : Write)</span></td><td><p></p></td></tr></tbody></table></div></div><div class="refsect1" lang="en"><a name="id2976546"></a><h2>See Also</h2><p>
111
 
The <a href="MgForm.html" title="MgForm"><span class="type">MgForm</span></a> widget which is being used in this widget.
112
 
</p></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="MgSelector.html"><b>&lt;&lt;�MgSelector</b></a></td><td align="right"><a accesskey="n" href="MgWorkGrid.html"><b>MgWorkGrid�&gt;&gt;</b></a></td></tr></table></body></html>