File: classGFC_1_1Gtk_1_1Alignment.html

package info (click to toggle)
gfcui 2.3.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 43,420 kB
  • ctags: 18,023
  • sloc: cpp: 53,967; sh: 31,555; makefile: 1,322; perl: 108
file content (393 lines) | stat: -rw-r--r-- 19,765 bytes parent folder | download | duplicates (3)
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
<!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>&nbsp; |&nbsp; <a
 href="../html/namespaces.html">Namespace List</a>&nbsp; |&nbsp; <a
 href="classes.html">Alphabetical List</a>&nbsp; |&nbsp; <a
 href="../html/annotated.html">Class List</a>&nbsp; |&nbsp; <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::Alignment Class Reference</h1>A GtkAlignment C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="alignment_8hh-source.html">gfc/gtk/alignment.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Gtk::Alignment:
<p><center><img src="classGFC_1_1Gtk_1_1Alignment.png" usemap="#GFC::Gtk::Alignment_map" border="0" alt=""></center>
<map name="GFC::Gtk::Alignment_map">
<area href="classGFC_1_1Gtk_1_1Bin.html" alt="GFC::Gtk::Bin" shape="rect" coords="73,336,210,360">
<area href="classGFC_1_1Gtk_1_1Container.html" alt="GFC::Gtk::Container" shape="rect" coords="73,280,210,304">
<area href="classGFC_1_1Gtk_1_1Widget.html" alt="GFC::Gtk::Widget" shape="rect" coords="73,224,210,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,137,192">
<area href="classGFC_1_1Atk_1_1Implementor.html" alt="GFC::Atk::Implementor" shape="rect" coords="147,168,284,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="147,112,284,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="147,56,284,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,137,24">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="147,0,284,24">
</map>
<a href="classGFC_1_1Gtk_1_1Alignment-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="z311_0" doxytag="GFC::Gtk::Alignment::Alignment" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z311_0">Alignment</a> ()
<dl class="el"><dd class="mdescRight">Construct an <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</a> with the default values 0.5 for xalign and yalign and 1.0 for xscale and yscale. <br></dl><li><a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z311_1">Alignment</a> (float xalign, float yalign, float xscale=0.0, float yscale=0.0)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</a>.  <a href="#z311_1"></a><br></dl><li><a class="anchor" name="z311_2" doxytag="GFC::Gtk::Alignment::~Alignment" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z311_2">~Alignment</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="z312_0" doxytag="GFC::Gtk::Alignment::gtk_alignment" ></a>
GtkAlignment * <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z312_0">gtk_alignment</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkAlignment structure. <br></dl><li><a class="anchor" name="z312_1" doxytag="GFC::Gtk::Alignment::operator GtkAlignment *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z312_1">operator GtkAlignment *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts an <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</a> to a GtkAlignment pointer. <br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z312_2">get_padding</a> (unsigned int *top, unsigned int *bottom, unsigned int *left, unsigned int *right) const
<dl class="el"><dd class="mdescRight">Gets the padding on the different sides of the widget (see <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z313_1">set_padding()</a>).  <a href="#z312_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_1Alignment.html#z313_0">set</a> (float xalign, float yalign, float xscale, float yscale)
<dl class="el"><dd class="mdescRight">Sets the <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</a> values.  <a href="#z313_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z313_1">set_padding</a> (unsigned int top, unsigned int bottom, unsigned int left, unsigned int right)
<dl class="el"><dd class="mdescRight">Sets the padding on the different sides of the widget.  <a href="#z313_1"></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_1Alignment.html#z310_0">Alignment</a> (GtkAlignment *alignment, 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_1Alignment.html">Alignment</a> from an existing GtkAlignment.  <a href="#z310_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkAlignment C++ wrapper class. 
<p>
The <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</a> widget controls the alignment and size of its child widget. It has four settings: xscale, yscale, xalign, and yalign.<p>
The scale settings are used to specify how much the child widget should expand to fill the space allocated to the <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</a>. The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space).<p>
The align settings are used to place the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). Of course, if the scale settings are both set to 1, the alignment settings have no effect. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z310_0" doxytag="GFC::Gtk::Alignment::Alignment" ></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::Alignment::Alignment           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">GtkAlignment *&nbsp;</td>
          <td class="mdname" nowrap> <em>alignment</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</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>
      &nbsp;
    </td>
    <td>

<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</a> from an existing GtkAlignment. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>alignment</em>&nbsp;</td><td>T pointer to a GtkAlignment. </td></tr>
    <tr><td></td><td valign=top><em>owns_reference</em>&nbsp;</td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
  </table>
</dl>
<br>
The <em>alignment</em> can be a newly created GtkAlignment or an existing GtkAlignment. (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="z311_1" doxytag="GFC::Gtk::Alignment::Alignment" ></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::Alignment::Alignment           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">float&nbsp;</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&nbsp;</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&nbsp;</td>
          <td class="mdname" nowrap> <em>xscale</em> = <code>0.0</code>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>float&nbsp;</td>
          <td class="mdname" nowrap> <em>yscale</em> = <code>0.0</code></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</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>&nbsp;</td><td>The horizontal alignment of the child widget, from 0 (left) to 1 (right). </td></tr>
    <tr><td></td><td valign=top><em>yalign</em>&nbsp;</td><td>The vertical alignment of the child widget, from 0 (top) to 1 (bottom). </td></tr>
    <tr><td></td><td valign=top><em>xscale</em>&nbsp;</td><td>The amount that the child widget expands horizontally to fill up unused space, from 0 to 1. A value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the GtkAlignment. </td></tr>
    <tr><td></td><td valign=top><em>yscale</em>&nbsp;</td><td>The amount that the child widget expands vertically to fill up unused space, from 0 to 1. The values are similar to xscale. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z312_2" doxytag="GFC::Gtk::Alignment::get_padding" ></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::Alignment::get_padding           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned int *&nbsp;</td>
          <td class="mdname" nowrap> <em>top</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>unsigned int *&nbsp;</td>
          <td class="mdname" nowrap> <em>bottom</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>unsigned int *&nbsp;</td>
          <td class="mdname" nowrap> <em>left</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>unsigned int *&nbsp;</td>
          <td class="mdname" nowrap> <em>right</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the padding on the different sides of the widget (see <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html#z313_1">set_padding()</a>). 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>top</em>&nbsp;</td><td>The location to store the padding for the top of the widget, or null. </td></tr>
    <tr><td></td><td valign=top><em>bottom</em>&nbsp;</td><td>The location to store the padding for the bottom of the widget, or null. </td></tr>
    <tr><td></td><td valign=top><em>left</em>&nbsp;</td><td>The location to store the padding for the left of the widget, or null. </td></tr>
    <tr><td></td><td valign=top><em>right</em>&nbsp;</td><td>The ocation to store the padding for the right of the widget, or null. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z313_0" doxytag="GFC::Gtk::Alignment::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::Alignment::set           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">float&nbsp;</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&nbsp;</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&nbsp;</td>
          <td class="mdname" nowrap> <em>xscale</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>float&nbsp;</td>
          <td class="mdname" nowrap> <em>yscale</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the <a class="el" href="classGFC_1_1Gtk_1_1Alignment.html">Alignment</a> 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>&nbsp;</td><td>The horizontal alignment of the child widget, from 0 (left) to 1 (right). </td></tr>
    <tr><td></td><td valign=top><em>yalign</em>&nbsp;</td><td>The vertical alignment of the child widget, from 0 (top) to 1 (bottom). </td></tr>
    <tr><td></td><td valign=top><em>xscale</em>&nbsp;</td><td>The amount that the child widget expands horizontally to fill up unused space, from 0 to 1. A value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the GtkAlignment. </td></tr>
    <tr><td></td><td valign=top><em>yscale</em>&nbsp;</td><td>The amount that the child widget expands vertically to fill up unused space, from 0 to 1. The values are similar to xscale. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z313_1" doxytag="GFC::Gtk::Alignment::set_padding" ></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::Alignment::set_padding           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned int&nbsp;</td>
          <td class="mdname" nowrap> <em>top</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>unsigned int&nbsp;</td>
          <td class="mdname" nowrap> <em>bottom</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>unsigned int&nbsp;</td>
          <td class="mdname" nowrap> <em>left</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>unsigned int&nbsp;</td>
          <td class="mdname" nowrap> <em>right</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the padding on the different sides of the widget. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>top</em>&nbsp;</td><td>The padding at the top of the widget. </td></tr>
    <tr><td></td><td valign=top><em>bottom</em>&nbsp;</td><td>The padding at the bottom of the widget. </td></tr>
    <tr><td></td><td valign=top><em>left</em>&nbsp;</td><td>The padding at the left of the widget. </td></tr>
    <tr><td></td><td valign=top><em>right</em>&nbsp;</td><td>The padding at the right of the widget.</td></tr>
  </table>
</dl>
<br>
The padding adds blank space to the sides of the widget. For instance, this can be used to indent the child widget towards the right by adding padding on the left.     </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="alignment_8hh-source.html">alignment.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>