← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/html/MgQfField.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/MgQfField.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>MgQfField</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="ch04s02.html" title="Query fields"><link rel="previous" href="MgQfAll.html" title="MgQfAll"><link rel="next" href="MgQfFunc.html" title="MgQfFunc"><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="MgQfAll.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch04s02.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="MgQfFunc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="MgQfField"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">MgQfField</span></h2><p>MgQfField &#8212; Represents one field of an entity (through a <a href="MgTarget.html" title="MgTarget"><span class="type">MgTarget</span></a> object)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
32
 
 
33
 
 
34
 
 
35
 
struct      <a href="MgQfField.html#MgQfField-struct">MgQfField</a>;
36
 
guint       <a href="MgQfField.html#mg-qf-field-get-type">mg_qf_field_get_type</a>            (void);
37
 
GObject*    <a href="MgQfField.html#mg-qf-field-new-with-objects">mg_qf_field_new_with_objects</a>    (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
38
 
                                             <a href="MgTarget.html" title="MgTarget">MgTarget</a> *target,
39
 
                                             <a href="MgField.html" title="MgField">MgField</a> *field);
40
 
GObject*    <a href="MgQfField.html#mg-qf-field-new-with-xml-ids">mg_qf_field_new_with_xml_ids</a>    (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
41
 
                                             const gchar *target_xml_id,
42
 
                                             const gchar *field_xml_id);
43
 
<a href="MgField.html" title="MgField">MgField</a>*    <a href="MgQfField.html#mg-qf-field-get-ref-field">mg_qf_field_get_ref_field</a>       (<a href="MgQfField.html" title="MgQfField">MgQfField</a> *field);
44
 
<a href="MgTarget.html" title="MgTarget">MgTarget</a>*   <a href="MgQfField.html#mg-qf-field-get-target">mg_qf_field_get_target</a>          (<a href="MgQfField.html" title="MgQfField">MgQfField</a> *field);
45
 
</pre></div><div class="refsect1" lang="en"><a name="id2903231"></a><h2>Object Hierarchy</h2><pre class="synopsis">
46
 
 
47
 
  GObject
48
 
   +----<a href="MgBase.html" title="MgBase">MgBase</a>
49
 
         +----<a href="MgQfield.html" title="MgQfield">MgQfield</a>
50
 
               +----MgQfField
51
 
</pre></div><div class="refsect1" lang="en"><a name="id2903264"></a><h2>Implemented Interfaces</h2><p>
52
 
MgQfField implements
53
 
 <a href="MgXmlStorage.html" title="MgXmlStorage">MgXmlStorage</a>,  <a href="MgRenderer.html" title="MgRenderer">MgRenderer</a>,  <a href="MgReferer.html" title="MgReferer">MgReferer</a> and  <a href="MgField.html" title="MgField">MgField</a>.</p></div><div class="refsect1" lang="en"><a name="id2903302"></a><h2>Properties</h2><pre class="synopsis">
54
 
 
55
 
  "<a href="MgQfField.html#MgQfField--handler-plugin">handler-plugin</a>"       gchararray           : Read / Write
56
 
  "<a href="MgQfField.html#MgQfField--query">query</a>"                gpointer             : Read / Write
57
 
  "<a href="MgQfField.html#MgQfField--value-provider">value-provider</a>"       gpointer             : Read / Write
58
 
  "<a href="MgQfField.html#MgQfField--value-provider-xml-id">value-provider-xml-id</a>" gchararray           : Read / Write
59
 
</pre></div><div class="refsect1" lang="en"><a name="id2903384"></a><h2>Signal Prototypes</h2><pre class="synopsis">
60
 
 
61
 
"<a href="MgQfField.html#MgQfField-templ-signal">templ-signal</a>"
62
 
            void        user_function      (<a href="MgQfField.html" title="MgQfField">MgQfField</a> *mgqffield,
63
 
                                            gpointer user_data);
64
 
</pre></div><div class="refsect1" lang="en"><a name="id2903428"></a><h2>Description</h2><p>
65
 
 
66
 
</p></div><div class="refsect1" lang="en"><a name="id2903438"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2903444"></a><h3><a name="MgQfField-struct"></a>struct MgQfField</h3><a class="indexterm" name="id2903454"></a><pre class="programlisting">struct MgQfField;</pre><p>
67
 
 
68
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2903469"></a><h3><a name="mg-qf-field-get-type"></a>mg_qf_field_get_type ()</h3><a class="indexterm" name="id2903481"></a><pre class="programlisting">guint       mg_qf_field_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="id2903516"></a><h3><a name="mg-qf-field-new-with-objects"></a>mg_qf_field_new_with_objects ()</h3><a class="indexterm" name="id2903528"></a><pre class="programlisting">GObject*    mg_qf_field_new_with_objects    (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
74
 
                                             <a href="MgTarget.html" title="MgTarget">MgTarget</a> *target,
75
 
                                             <a href="MgField.html" title="MgField">MgField</a> *field);</pre><p>
76
 
Creates a new MgQfField object which represents the <i class="parameter"><tt>field</tt></i> of the entity represented
77
 
by <i class="parameter"><tt>target</tt></i>. For example if <i class="parameter"><tt>target</tt></i> represents my_table, and <i class="parameter"><tt>field</tt></i> represents the "name" field,
78
 
then the created object would represent 'my_table.name' in SQL notation
79
 
</p><p>
80
 
REM: <i class="parameter"><tt>field</tt></i> MUST belong to the <a href="MgEntity.html" title="MgEntity"><span class="type">MgEntity</span></a> represented by <i class="parameter"><tt>target</tt></i> (we need the <i class="parameter"><tt>target</tt></i> since
81
 
an entity can appear several times within a query, for self joins for example).</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> in which the new object will be
84
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>target</tt></i>�:</span></td><td> a <a href="MgTarget.html" title="MgTarget"><span class="type">MgTarget</span></a> object
85
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> an object which implements the <a href="MgField.html" title="MgField"><span class="type">MgField</span></a> interface
86
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the new object
87
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2903714"></a><h3><a name="mg-qf-field-new-with-xml-ids"></a>mg_qf_field_new_with_xml_ids ()</h3><a class="indexterm" name="id2903726"></a><pre class="programlisting">GObject*    mg_qf_field_new_with_xml_ids    (<a href="MgQuery.html" title="MgQuery">MgQuery</a> *query,
88
 
                                             const gchar *target_xml_id,
89
 
                                             const gchar *field_xml_id);</pre><p>
90
 
 
91
 
</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>
92
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>target_xml_id</tt></i>�:</span></td><td>
93
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>field_xml_id</tt></i>�:</span></td><td>
94
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
95
 
 
96
 
 
97
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2903825"></a><h3><a name="mg-qf-field-get-ref-field"></a>mg_qf_field_get_ref_field ()</h3><a class="indexterm" name="id2903837"></a><pre class="programlisting"><a href="MgField.html" title="MgField">MgField</a>*    mg_qf_field_get_ref_field       (<a href="MgQfField.html" title="MgQfField">MgQfField</a> *field);</pre><p>
98
 
Get the real <a href="MgField.html" title="MgField"><span class="type">MgField</span></a> object (well, the object which implements that interface)
99
 
referenced by <i class="parameter"><tt>field</tt></i></p><p>
100
 
 
101
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfField.html" title="MgQfField"><span class="type">MgQfField</span></a> object
102
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the <a href="MgField.html" title="MgField"><span class="type">MgField</span></a> object, or NULL if <i class="parameter"><tt>field</tt></i> is not active
103
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2903932"></a><h3><a name="mg-qf-field-get-target"></a>mg_qf_field_get_target ()</h3><a class="indexterm" name="id2903943"></a><pre class="programlisting"><a href="MgTarget.html" title="MgTarget">MgTarget</a>*   mg_qf_field_get_target          (<a href="MgQfField.html" title="MgQfField">MgQfField</a> *field);</pre><p>
104
 
Get the <a href="MgTarget.html" title="MgTarget"><span class="type">MgTarget</span></a> object <i class="parameter"><tt>field</tt></i> 'belongs' to</p><p>
105
 
 
106
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i>�:</span></td><td> a <a href="MgQfField.html" title="MgQfField"><span class="type">MgQfField</span></a> object
107
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the <a href="MgTarget.html" title="MgTarget"><span class="type">MgTarget</span></a> object
108
 
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2904034"></a><h2>Properties</h2><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><a name="MgQfField--handler-plugin"></a>"<tt class="literal">handler-plugin</tt>" (gchararray : Read / Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgQfField--query"></a>"<tt class="literal">query</tt>" (gpointer : Read / Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgQfField--value-provider"></a>"<tt class="literal">value-provider</tt>" (gpointer : Read / Write)</span></td><td><p></p></td></tr><tr><td><span class="term"><a name="MgQfField--value-provider-xml-id"></a>"<tt class="literal">value-provider-xml-id</tt>" (gchararray : Read / Write)</span></td><td><p></p></td></tr></tbody></table></div></div><div class="refsect1" lang="en"><a name="id2904159"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2904165"></a><h3><a name="MgQfField-templ-signal"></a>The "templ-signal" signal</h3><pre class="programlisting">void        user_function                  (<a href="MgQfField.html" title="MgQfField">MgQfField</a> *mgqffield,
109
 
                                            gpointer user_data);</pre><p>
110
 
 
111
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>mgqffield</tt></i>�:</span></td><td>the object which received the signal.
112
 
 
113
 
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>�:</span></td><td>user data set when the signal handler was connected.</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="MgQfAll.html"><b>&lt;&lt;�MgQfAll</b></a></td><td align="right"><a accesskey="n" href="MgQfFunc.html"><b>MgQfFunc�&gt;&gt;</b></a></td></tr></table></body></html>