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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
<!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::AspectFrame Class Reference</h1>A GtkAspectFrame C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="aspectframe_8hh-source.html">gfc/gtk/aspectframe.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::AspectFrame:
<p><center><img src="classGFC_1_1Gtk_1_1AspectFrame.png" usemap="#GFC::Gtk::AspectFrame_map" border="0" alt=""></center>
<map name="GFC::Gtk::AspectFrame_map">
<area href="classGFC_1_1Gtk_1_1Frame.html" alt="GFC::Gtk::Frame" shape="rect" coords="76,392,219,416">
<area href="classGFC_1_1Gtk_1_1Bin.html" alt="GFC::Gtk::Bin" shape="rect" coords="76,336,219,360">
<area href="classGFC_1_1Gtk_1_1Container.html" alt="GFC::Gtk::Container" shape="rect" coords="76,280,219,304">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="76,224,219,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,143,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="153,168,296,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,143,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="153,112,296,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,143,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="153,56,296,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,143,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="153,0,296,24">
</map>
<a href="classGFC_1_1Gtk_1_1AspectFrame-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="anchor" name="z319_0" doxytag="GFC::Gtk::AspectFrame::AspectFrame" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html#z319_0">AspectFrame</a> ()
<dl class="el"><dd class="mdescRight">Construct an <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> with xalign 0.5, yalign 0.5, ratio 1.0 and obey_child true. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html#z319_1">AspectFrame</a> (float xalign, float yalign)
<dl class="el"><dd class="mdescRight">Construct an <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> with the specified xalign and yalign values. <a href="#z319_1"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html#z319_2">AspectFrame</a> (float xalign, float yalign, float ratio)
<dl class="el"><dd class="mdescRight">Construct an <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> with the specified xalign, yalign and ratio values. <a href="#z319_2"></a><br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html#z319_4">AspectFrame</a> (const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &label, float xalign, float yalign, float ratio)
<dl class="el"><dd class="mdescRight">Construct a labelled <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> with the specified xalign, yalign and ratio values. <a href="#z319_4"></a><br></dl><li><a class="anchor" name="z319_5" doxytag="GFC::Gtk::AspectFrame::~AspectFrame" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html#z319_5">~AspectFrame</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="z320_0" doxytag="GFC::Gtk::AspectFrame::gtk_aspect_frame" ></a>
GtkAspectFrame * <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html#z320_0">gtk_aspect_frame</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkAspectFrame structure. <br></dl><li><a class="anchor" name="z320_1" doxytag="GFC::Gtk::AspectFrame::operator GtkAspectFrame *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html#z320_1">operator GtkAspectFrame *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> to a GtkAspectFrame pointer. <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_1AspectFrame.html#z321_0">set</a> (float xalign, float yalign, float ratio, bool obey_child)
<dl class="el"><dd class="mdescRight">Sets the parameters for an existing <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>. <a href="#z321_0"></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_1AspectFrame.html#z318_0">AspectFrame</a> (GtkAspectFrame *aspect_frame, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> from an existing GtkAspectFrame. <a href="#z318_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkAspectFrame C++ wrapper class.
<p>
The <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> is useful when you want pack a widget so that it can resize but always retains the same aspect ratio. For instance, one might be drawing a small preview of a larger image. <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> derives from <a class="el" href="classGFC_1_1Gtk_1_1Frame.html">Frame</a>, so it can draw a label and a frame around the child. The frame will be "shrink-wrapped" to the size of the child.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z318_0" doxytag="GFC::Gtk::AspectFrame::AspectFrame" ></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::AspectFrame::AspectFrame </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkAspectFrame * </td>
<td class="mdname" nowrap> <em>aspect_frame</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>false</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_1AspectFrame.html">AspectFrame</a> from an existing GtkAspectFrame.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>aspect_frame</em> </td><td>A pointer to a GtkAspectFrame. </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>aspect_frame</em> can be a newly created GtkAspectFrame or an existing GtkAspectFrame. (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="z319_1" doxytag="GFC::Gtk::AspectFrame::AspectFrame" ></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::AspectFrame::AspectFrame </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">float </td>
<td class="mdname" nowrap> <em>xalign</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>yalign</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 an <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> with the specified xalign and yalign values.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>xalign</em> </td><td>The horizontal alignment of the child within the allocation of the <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>; this ranges from 0.0 (left aligned) to 1.0 (right aligned). </td></tr>
<tr><td></td><td valign=top><em>yalign</em> </td><td>The vertical alignment of the child within the allocation of the <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>. This ranges from 0.0 (left aligned) to 1.0 (right aligned).</td></tr>
</table>
</dl>
<br>
This constructor takes the aspect ratio from the requistion of the child. This is the same as setting obey_child to true. </td>
</tr>
</table>
<a class="anchor" name="z319_2" doxytag="GFC::Gtk::AspectFrame::AspectFrame" ></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::AspectFrame::AspectFrame </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">float </td>
<td class="mdname" nowrap> <em>xalign</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>yalign</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>ratio</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 an <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> with the specified xalign, yalign and ratio values.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>xalign</em> </td><td>The horizontal alignment of the child within the allocation of the <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>; this ranges from 0.0 (left aligned) to 1.0 (right aligned). </td></tr>
<tr><td></td><td valign=top><em>yalign</em> </td><td>The vertical alignment of the child within the allocation of the <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>. This ranges from 0.0 (left aligned) to 1.0 (right aligned). </td></tr>
<tr><td></td><td valign=top><em>ratio</em> </td><td>The desired aspect ratio.</td></tr>
</table>
</dl>
<br>
This constructor takes the aspect ratio from <em>ratio</em> and sets obey_child to false. </td>
</tr>
</table>
<a class="anchor" name="z319_4" doxytag="GFC::Gtk::AspectFrame::AspectFrame" ></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::AspectFrame::AspectFrame </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>label</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>xalign</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>yalign</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>ratio</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 labelled <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a> with the specified xalign, yalign and ratio values.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>label</em> </td><td>The label text. </td></tr>
<tr><td></td><td valign=top><em>xalign</em> </td><td>The horizontal alignment of the child within the allocation of the <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>; this ranges from 0.0 (left aligned) to 1.0 (right aligned). </td></tr>
<tr><td></td><td valign=top><em>yalign</em> </td><td>The vertical alignment of the child within the allocation of the <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>. This ranges from 0.0 (left aligned) to 1.0 (right aligned). </td></tr>
<tr><td></td><td valign=top><em>ratio</em> </td><td>The desired aspect ratio.</td></tr>
</table>
</dl>
<br>
This constructor takes the aspect ratio from <em>ratio</em> and sets obey_child to false. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z321_0" doxytag="GFC::Gtk::AspectFrame::set" ></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::AspectFrame::set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">float </td>
<td class="mdname" nowrap> <em>xalign</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>yalign</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>ratio</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>obey_child</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>
Sets the parameters for an existing <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>xalign</em> </td><td>The horizontal alignment of the child within the allocation of the <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>; this ranges from 0.0 (left aligned) to 1.0 (right aligned). </td></tr>
<tr><td></td><td valign=top><em>yalign</em> </td><td>The vertical alignment of the child within the allocation of the <a class="el" href="classGFC_1_1Gtk_1_1AspectFrame.html">AspectFrame</a>. This ranges from 0.0 (left aligned) to 1.0 (right aligned). </td></tr>
<tr><td></td><td valign=top><em>ratio</em> </td><td>The desired aspect ratio. </td></tr>
<tr><td></td><td valign=top><em>obey_child</em> </td><td>If <em>true</em>, ratio is ignored, and the aspect ratio is taken from the requistion of the child. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="aspectframe_8hh-source.html">aspectframe.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:37 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>
|
