1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Atk::Relation Class Reference</h1>An AtkRelation C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="relation_8hh-source.html">gfc/atk/relation.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Atk::Relation:
<p><center><img src="classGFC_1_1Atk_1_1Relation.png" usemap="#GFC::Atk::Relation_map" border="0" alt=""></center>
<map name="GFC::Atk::Relation_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Atk_1_1Relation-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Atk_1_1Relation.html#z51_0">Relation</a> (const std::vector< <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> * > &targets, <a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a> relationship)
<dl class="el"><dd class="mdescRight">Construct a new relation for the specified <em>relationship</em> and the specified list of targets. <a href="#z51_0"></a><br></dl><li><a class="anchor" name="z51_1" doxytag="GFC::Atk::Relation::~Relation" ></a>
virtual <a class="el" href="classGFC_1_1Atk_1_1Relation.html#z51_1">~Relation</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z52_0" doxytag="GFC::Atk::Relation::atk_relation" ></a>
AtkRelation * <a class="el" href="classGFC_1_1Atk_1_1Relation.html#z52_0">atk_relation</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the AtkRelation structure. <br></dl><li><a class="anchor" name="z52_1" doxytag="GFC::Atk::Relation::operator AtkRelation *" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Relation.html#z52_1">operator AtkRelation *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Atk_1_1Relation.html">Relation</a> to an AtkRelation pointer. <br></dl><li><a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a> <a class="el" href="classGFC_1_1Atk_1_1Relation.html#z52_2">get_relation_type</a> () const
<dl class="el"><dd class="mdescRight">Gets the type of the relation. <a href="#z52_2"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Atk_1_1Relation.html#z52_3">get_target</a> (std::vector< <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> * > &targets) const
<dl class="el"><dd class="mdescRight">Gets the target list of the relation. <a href="#z52_3"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Atk_1_1Relation.html#z50_0">Relation</a> (AtkRelation *relation, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=true)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Atk_1_1Relation.html">Relation</a> from an existing AtkRelation. <a href="#z50_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An AtkRelation C++ wrapper class.
<p>
A <a class="el" href="classGFC_1_1Atk_1_1Relation.html">Relation</a> describes a relation between an object and one or more other objects. The actual relations that an object has with other objects are defined as a <a class="el" href="classGFC_1_1Atk_1_1RelationSet.html">RelationSet</a>, which is a set of Relations.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z50_0" doxytag="GFC::Atk::Relation::Relation" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Atk::Relation::Relation </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">AtkRelation * </td>
<td class="mdname" nowrap> <em>relation</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>true</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Atk_1_1Relation.html">Relation</a> from an existing AtkRelation.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>relation</em> </td><td>A pointer to a AtkRelation. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>relation</em> can be a newly created AtkRelation or an existing AtkRelation. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<a class="anchor" name="z51_0" doxytag="GFC::Atk::Relation::Relation" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Atk::Relation::Relation </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::vector< <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> * > & </td>
<td class="mdname" nowrap> <em>targets</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a> </td>
<td class="mdname" nowrap> <em>relationship</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new relation for the specified <em>relationship</em> and the specified list of targets.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>targets</em> </td><td>A reference to a vector of <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a>* that lists the target objects. </td></tr>
<tr><td></td><td valign=top><em>relationship</em> </td><td>A RelationType with which to create the new <a class="el" href="classGFC_1_1Atk_1_1Relation.html">Relation</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z52_2" doxytag="GFC::Atk::Relation::get_relation_type" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceGFC_1_1Atk.html#a202">RelationType</a> GFC::Atk::Relation::get_relation_type </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the type of the relation.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The type of the relation. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z52_3" doxytag="GFC::Atk::Relation::get_target" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Atk::Relation::get_target </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::vector< <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a> * > & </td>
<td class="mdname1" valign="top" nowrap> <em>targets</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the target list of the relation.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>targets</em> </td><td>A reference to a vector of <a class="el" href="classGFC_1_1Atk_1_1Object.html">Atk::Object</a>* to hold the target list. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the vector is not empty. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="relation_8hh-source.html">relation.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:34 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
