File: GnomePropertyBox.html

package info (click to toggle)
libgnomeui 2.24.5-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 12,428 kB
  • sloc: ansic: 37,044; sh: 11,082; makefile: 409; xml: 18
file content (287 lines) | stat: -rw-r--r-- 18,875 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomePropertyBox</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="deprecated.html" title="Deprecated Modules">
<link rel="prev" href="libgnomeui-gnome-popup-menu.html" title="gnome-popup-menu">
<link rel="next" href="GnomeScores.html" title="GnomeScores">
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgnomeui-gnome-popup-menu.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="deprecated.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="GnomeScores.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GnomePropertyBox.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GnomePropertyBox.description" class="shortcut">Description</a>
                   | 
                  <a href="#GnomePropertyBox.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GnomePropertyBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GnomePropertyBox.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GnomePropertyBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GnomePropertyBox.top_of_page"></a>GnomePropertyBox</span></h2>
<p>GnomePropertyBox — Create a tabbed dialog for setting properties and preferences.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GnomePropertyBox.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgnomeui/libgnomeui.h&gt;

struct              <a class="link" href="GnomePropertyBox.html#GnomePropertyBox-struct" title="struct GnomePropertyBox">GnomePropertyBox</a>;
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GnomePropertyBox.html#gnome-property-box-new" title="gnome_property_box_new ()">gnome_property_box_new</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GnomePropertyBox.html#gnome-property-box-changed" title="gnome_property_box_changed ()">gnome_property_box_changed</a>          (<em class="parameter"><code><a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *property_box</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GnomePropertyBox.html#gnome-property-box-set-modified" title="gnome_property_box_set_modified ()">gnome_property_box_set_modified</a>     (<em class="parameter"><code><a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *property_box</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> state</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="GnomePropertyBox.html#gnome-property-box-append-page" title="gnome_property_box_append_page ()">gnome_property_box_append_page</a>      (<em class="parameter"><code><a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *property_box</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *child</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *tab_label</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GnomePropertyBox.html#gnome-property-box-set-state" title="gnome_property_box_set_state ()">gnome_property_box_set_state</a>        (<em class="parameter"><code><a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *property_box</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> state</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GnomePropertyBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
               +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
                     +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
                           +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkBin.html">GtkBin</a>
                                 +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html">GtkWindow</a>
                                       +----<a class="link" href="GnomeDialog.html" title="GnomeDialog">GnomeDialog</a>
                                             +----GnomePropertyBox
</pre>
</div>
<div class="refsect1">
<a name="GnomePropertyBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GnomePropertyBox implements
 AtkImplementorIface and  <a href="http://library.gnome.org/devel/gtk/unstable/GtkBuildable.html">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GnomePropertyBox.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GnomePropertyBox.html#GnomePropertyBox-apply" title='The "apply" signal'>apply</a>"                                          : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="GnomePropertyBox.html#GnomePropertyBox-help" title='The "help" signal'>help</a>"                                           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GnomePropertyBox.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="GnomePropertyBox.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomePropertyBox-struct"></a><h3>struct GnomePropertyBox</h3>
<pre class="programlisting">struct GnomePropertyBox;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GnomePropertyBox</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
An opaque widget representing a property box. Items should be added to this
widget using gnome_property_box_append_page.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-property-box-new"></a><h3>gnome_property_box_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *         gnome_property_box_new              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_property_box_new</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-property-box-changed"></a><h3>gnome_property_box_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_property_box_changed          (<em class="parameter"><code><a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *property_box</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_property_box_changed</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
When a setting has changed, the code needs to invoke this routine
to make the Ok/Apply buttons sensitive.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>property_box</code></em> :</span></p></td>
<td>The GnomePropertyBox that contains the changed data</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-property-box-set-modified"></a><h3>gnome_property_box_set_modified ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_property_box_set_modified     (<em class="parameter"><code><a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *property_box</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> state</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_property_box_set_modified</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This sets the modified flag of the GnomePropertyBox to the value in <em class="parameter"><code>state</code></em>.
Affects whether the OK/Apply buttons are sensitive.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property_box</code></em> :</span></p></td>
<td>The GnomePropertyBox that contains the changed data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>The state. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> means modified, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> means unmodified.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-property-box-append-page"></a><h3>gnome_property_box_append_page ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gnome_property_box_append_page      (<em class="parameter"><code><a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *property_box</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *child</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *tab_label</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_property_box_append_page</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Appends a new page to the GnomePropertyBox.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property_box</code></em> :</span></p></td>
<td>The property box where we are inserting a new page</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>child</code></em> :</span></p></td>
<td>The widget that is being inserted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tab_label</code></em> :</span></p></td>
<td>The widget used as the label for this confiugration page</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the assigned index of the page inside the GnomePropertyBox or
-1 if one of the arguments is invalid.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-property-box-set-state"></a><h3>gnome_property_box_set_state ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_property_box_set_state        (<em class="parameter"><code><a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *property_box</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> state</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_property_box_set_state</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
An alias for  <a class="link" href="GnomePropertyBox.html#gnome-property-box-set-modified" title="gnome_property_box_set_modified ()"><code class="function">gnome_property_box_set_modified()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>property_box</code></em> :</span></p></td>
<td>The GnomePropertyBox that contains the changed data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
<td>The state. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> means modified, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> means unmodified.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GnomePropertyBox.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GnomePropertyBox-apply"></a><h3>The <code class="literal">"apply"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *propertybox,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>              arg1,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>propertybox</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>the notebook page number which emitted the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomePropertyBox-help"></a><h3>The <code class="literal">"help"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GnomePropertyBox.html" title="GnomePropertyBox"><span class="type">GnomePropertyBox</span></a> *propertybox,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>              arg1,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>          user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>propertybox</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td>the notebook page number which emitted the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.16</div>
</body>
</html>