File: classGFC_1_1Gtk_1_1ButtonBox.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 (298 lines) | stat: -rw-r--r-- 15,961 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
<!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::ButtonBox Class Reference</h1>A GtkButtonBox C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="buttonbox_8hh-source.html">gfc/gtk/buttonbox.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Gtk::ButtonBox:
<p><center><img src="classGFC_1_1Gtk_1_1ButtonBox.png" usemap="#GFC::Gtk::ButtonBox_map" border="0" alt=""></center>
<map name="GFC::Gtk::ButtonBox_map">
<area href="classGFC_1_1Gtk_1_1Box.html" alt="GFC::Gtk::Box" 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">
<area href="classGFC_1_1Gtk_1_1HButtonBox.html" alt="GFC::Gtk::HButtonBox" shape="rect" coords="0,448,137,472">
<area href="classGFC_1_1Gtk_1_1VButtonBox.html" alt="GFC::Gtk::VButtonBox" shape="rect" coords="147,448,284,472">
</map>
<a href="classGFC_1_1Gtk_1_1ButtonBox-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z342_0" doxytag="GFC::Gtk::ButtonBox::gtk_button_box" ></a>
GtkButtonBox * <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html#z342_0">gtk_button_box</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkButtonBox structure. <br></dl><li><a class="anchor" name="z342_1" doxytag="GFC::Gtk::ButtonBox::operator GtkButtonBox *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html#z342_1">operator GtkButtonBox *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html">ButtonBox</a> to a GtkButtonBox pointer. <br></dl><li><a class="el" href="namespaceGFC_1_1Gtk.html#a308">ButtonBoxStyle</a> <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html#z342_2">get_layout</a> () const
<dl class="el"><dd class="mdescRight">Retrieves the method being used to arrange the buttons in a button box.  <a href="#z342_2"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html#z342_3">get_child_secondary</a> (const <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &amp;child) const
<dl class="el"><dd class="mdescRight">Determines whether <em>child</em> should appear in a secondary group of children.  <a href="#z342_3"></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_1ButtonBox.html#z343_0">set_layout</a> (<a class="el" href="namespaceGFC_1_1Gtk.html#a308">ButtonBoxStyle</a> layout_style)
<dl class="el"><dd class="mdescRight">Changes the way buttons are arranged in the button box.  <a href="#z343_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html#z343_1">set_child_secondary</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &amp;child, bool is_secondary)
<dl class="el"><dd class="mdescRight">Sets whether child should appear in a secondary group of children.  <a href="#z343_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_1ButtonBox.html#z341_0">ButtonBox</a> (GtkButtonBox *button_box, 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_1ButtonBox.html">ButtonBox</a> from an existing GtkButtonBox.  <a href="#z341_0"></a><br></dl><li><a class="anchor" name="z341_1" doxytag="GFC::Gtk::ButtonBox::~ButtonBox" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html#z341_1">~ButtonBox</a> ()=0
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkButtonBox C++ wrapper class. 
<p>
The primary purpose of <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html">ButtonBox</a> is to keep track of the various properties of the <a class="el" href="classGFC_1_1Gtk_1_1HButtonBox.html">HButtonBox</a> and <a class="el" href="classGFC_1_1Gtk_1_1VButtonBox.html">VButtonBox</a> widgets. get_child_size() retrieves the minimum width and height for widgets in a given button box. set_child_size() allows those properties to be changed. The internal padding of buttons can be retrieved and changed per button box using get_child_ipadding() and set_child_ipadding() respectively. <a class="el" href="classGFC_1_1Gtk_1_1Box.html#z326_4">get_spacing()</a> and <a class="el" href="classGFC_1_1Gtk_1_1Box.html#z327_5">set_spacing()</a> retrieve and change default number of pixels between buttons, respectively. <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html#z342_2">get_layout()</a> and <a class="el" href="classGFC_1_1Gtk_1_1ButtonBox.html#z343_0">set_layout()</a> retrieve and alter the method used to spread the buttons in a button box across the container, respectively. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z341_0" doxytag="GFC::Gtk::ButtonBox::ButtonBox" ></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::ButtonBox::ButtonBox           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">GtkButtonBox *&nbsp;</td>
          <td class="mdname" nowrap> <em>button_box</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_1ButtonBox.html">ButtonBox</a> from an existing GtkButtonBox. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>button_box</em>&nbsp;</td><td>A pointer to a GtkButtonBox. </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>button_box</em> can be a newly created GtkButtonBox or an existing GtkButtonBox. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>).     </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z342_3" doxytag="GFC::Gtk::ButtonBox::get_child_secondary" ></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::Gtk::ButtonBox::get_child_secondary           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>child</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determines whether <em>child</em> should appear in a secondary group of children. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>child</em>&nbsp;</td><td>A child of the button box. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Whether <em>child</em> should appear in a secondary group of children. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z342_2" doxytag="GFC::Gtk::ButtonBox::get_layout" ></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#a308">ButtonBoxStyle</a> GFC::Gtk::ButtonBox::get_layout           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Retrieves the method being used to arrange the buttons in a button box. 
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The method used to layout buttons in widget. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z343_1" doxytag="GFC::Gtk::ButtonBox::set_child_secondary" ></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::ButtonBox::set_child_secondary           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>child</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>is_secondary</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 whether child should appear in a secondary group of children. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>child</em>&nbsp;</td><td>A child of widget. </td></tr>
    <tr><td></td><td valign=top><em>is_secondary</em>&nbsp;</td><td>If <em>true</em>, the child appears in a secondary group.</td></tr>
  </table>
</dl>
<br>
A typical use of a secondary child is the help button in a dialog. This group appears after the other children if the style is BUTTONBOX_START, BUTTONBOX_SPREAD or BUTTONBOX_EDGE, and before the other children if the style is BUTTONBOX_END. For horizontal button boxes, the definition of before/after depends on direction of the widget (see <a class="el" href="classGFC_1_1Gtk_1_1Widget.html#z1053_77">Gtk::Widget::set_direction()</a>). If the style is BUTTONBOX_START or BUTTONBOX_END, then the secondary children are aligned at the other end of the button box from the main children. For the other styles, they appear immediately next to the main children.     </td>
  </tr>
</table>
<a class="anchor" name="z343_0" doxytag="GFC::Gtk::ButtonBox::set_layout" ></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::ButtonBox::set_layout           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="namespaceGFC_1_1Gtk.html#a308">ButtonBoxStyle</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>layout_style</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Changes the way buttons are arranged in the button box. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>layout_style</em>&nbsp;</td><td>The new layout style. </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="buttonbox_8hh-source.html">buttonbox.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>