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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
<!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::Gtk::SizeGroup Class Reference</h1>A GtkSizeGroup C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="sizegroup_8hh-source.html">gfc/gtk/sizegroup.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::SizeGroup:
<p><center><img src="classGFC_1_1Gtk_1_1SizeGroup.png" usemap="#GFC::Gtk::SizeGroup_map" border="0" alt=""></center>
<map name="GFC::Gtk::SizeGroup_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_1Gtk_1_1SizeGroup-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_1Gtk_1_1SizeGroup.html#z812_0">SizeGroup</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a338">SizeGroupMode</a> mode=SIZE_GROUP_HORIZONTAL)
<dl class="el"><dd class="mdescRight">Construct a new size group. <a href="#z812_0"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z813_0" doxytag="GFC::Gtk::SizeGroup::gtk_size_group" ></a>
GtkSizeGroup * <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z813_0">gtk_size_group</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkSizeGroup structure. <br></dl><li><a class="anchor" name="z813_1" doxytag="GFC::Gtk::SizeGroup::operator GtkSizeGroup *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z813_1">operator GtkSizeGroup *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a> to a GtkSizeGroup pointer. <br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a338">SizeGroupMode</a> <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z813_2">get_mode</a> () const
<dl class="el"><dd class="mdescRight">Gets the current mode of the size group (see <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z814_0">set_mode()</a>). <a href="#z813_2"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z814_0">set_mode</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a338">SizeGroupMode</a> mode)
<dl class="el"><dd class="mdescRight">Sets the SizeGroupMode of the size group. <a href="#z814_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z814_1">add_widget</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &widget)
<dl class="el"><dd class="mdescRight">Adds a widget to the <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a>. <a href="#z814_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z814_2">remove_widget</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &widget)
<dl class="el"><dd class="mdescRight">Removes a widget from the <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a>. <a href="#z814_2"></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_1Gtk_1_1SizeGroup.html#z811_0">SizeGroup</a> (GtkSizeGroup *size_group, 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_1Gtk_1_1SizeGroup.html">SizeGroup</a> from an existing GtkSizeGroup. <a href="#z811_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkSizeGroup C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a> provides a mechanism for grouping a number of widgets together so they all request the same amount of space. This is typically useful when you want a column of widgets to have the same size, but you can't use a <a class="el" href="classGFC_1_1Gtk_1_1Table.html">Table</a> widget.<p>
In detail, the size requested for each widget in a <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a> is the maximum of the sizes that would have been requested for each widget in the size group if they were not in the size group. The mode of the size group (see <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z814_0">set_mode()</a>) determines whether this applies to the horizontal size, the vertical size, or both sizes. Note that size groups only affect the amount of space requested, not the size that the widgets finally receive. If you want the widgets in a <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a> to actually be the same size, you need to pack them in such a way that they get the size they request and not more. For example, if you are packing your widgets into a table, you would not include the FILL flag.<p>
<a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a> objects are referenced by each widget in the size group, so once you have added all widgets to a <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a>, you can drop the initial reference to the size group with <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z72_1">unref()</a>. If the widgets in the size group are subsequently destroyed, then they will be removed from the size group and drop their references on the size group; when all widgets have been removed, the size group will be freed.<p>
Widgets can be part of multiple size groups; GTK+ will compute the horizontal size of a widget from the horizontal requisition of all widgets that can be reached from the widget by a chain of size groups of type SIZE_GROUP_HORIZONTAL or SIZE_GROUP_BOTH, and the vertical size from the vertical requisition of all widgets that can be reached from the widget by a chain of size groups of type SIZE_GROUP_VERTICAL or SIZE_GROUP_BOTH.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z811_0" doxytag="GFC::Gtk::SizeGroup::SizeGroup" ></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::Gtk::SizeGroup::SizeGroup </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkSizeGroup * </td>
<td class="mdname" nowrap> <em>size_group</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_1Gtk_1_1SizeGroup.html">SizeGroup</a> from an existing GtkSizeGroup.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>size_group</em> </td><td>A pointer to a GtkSizeGroup. </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>size_group</em> can be a newly created GtkSizeGroup or an existing GtkSizeGroup (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="z812_0" doxytag="GFC::Gtk::SizeGroup::SizeGroup" ></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::Gtk::SizeGroup::SizeGroup </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a338">SizeGroupMode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>mode</em> = <code>SIZE_GROUP_HORIZONTAL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new size group.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>mode</em> </td><td>The mode for the new size group. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z814_1" doxytag="GFC::Gtk::SizeGroup::add_widget" ></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"> void GFC::Gtk::SizeGroup::add_widget </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Adds a widget to the <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>widget</em> </td><td>The <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> to add.</td></tr>
</table>
</dl>
<br>
In the future, the requisition of the widget will be determined as the maximum of its requisition and the requisition of the other widgets in the size group. Whether this applies horizontally, vertically, or in both directions depends on the mode of the size group (see <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z814_0">set_mode()</a>). </td>
</tr>
</table>
<a class="anchor" name="z813_2" doxytag="GFC::Gtk::SizeGroup::get_mode" ></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_1Gtk.html#a338">SizeGroupMode</a> GFC::Gtk::SizeGroup::get_mode </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 current mode of the size group (see <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html#z814_0">set_mode()</a>).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The current mode of the size group. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z814_2" doxytag="GFC::Gtk::SizeGroup::remove_widget" ></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"> void GFC::Gtk::SizeGroup::remove_widget </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Removes a widget from the <a class="el" href="classGFC_1_1Gtk_1_1SizeGroup.html">SizeGroup</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>widget</em> </td><td>The <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> to remove. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z814_0" doxytag="GFC::Gtk::SizeGroup::set_mode" ></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"> void GFC::Gtk::SizeGroup::set_mode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a338">SizeGroupMode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>mode</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the SizeGroupMode of the size group.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>mode</em> </td><td>The mode to set for the size group.</td></tr>
</table>
</dl>
<br>
The mode of the size group determines whether the widgets in the size group should all have the same horizontal requisition (SIZE_GROUP_MODE_HORIZONTAL), all have the same vertical requisition (SIZE_GROUP_MODE_VERTICAL), or should all have the same requisition in both directions (SIZE_GROUP_MODE_BOTH). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="sizegroup_8hh-source.html">sizegroup.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:42 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>
|
