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
|
<refentry id="GnomePropertyBox">
<refmeta>
<refentrytitle role="top_of_page">GnomePropertyBox</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomePropertyBox</refname>
<refpurpose>Create a tabbed dialog for setting properties and preferences.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
<link linkend="GnomePropertyBox-struct">GnomePropertyBox</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-property-box-new">gnome_property_box_new</link> (void);
<link linkend="void">void</link> <link linkend="gnome-property-box-changed">gnome_property_box_changed</link> (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *property_box);
<link linkend="void">void</link> <link linkend="gnome-property-box-set-modified">gnome_property_box_set_modified</link> (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *property_box,
<link linkend="gboolean">gboolean</link> state);
<link linkend="gint">gint</link> <link linkend="gnome-property-box-append-page">gnome_property_box_append_page</link> (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *property_box,
<link linkend="GtkWidget">GtkWidget</link> *child,
<link linkend="GtkWidget">GtkWidget</link> *tab_label);
<link linkend="void">void</link> <link linkend="gnome-property-box-set-state">gnome_property_box_set_state</link> (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *property_box,
<link linkend="gboolean">gboolean</link> state);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkWindow">GtkWindow</link>
+----<link linkend="GnomeDialog">GnomeDialog</link>
+----GnomePropertyBox
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomePropertyBox implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GnomePropertyBox-apply">apply</link>" : Run Last
"<link linkend="GnomePropertyBox-help">help</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GnomePropertyBox-struct" role="struct"/>GnomePropertyBox</title>
<indexterm role="deprecated"><primary>GnomePropertyBox</primary></indexterm><programlisting>typedef struct _GnomePropertyBox GnomePropertyBox;</programlisting>
<warning><para><literal>GnomePropertyBox</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
An opaque widget representing a property box. Items should be added to this
widget using gnome_property_box_append_page.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gnome-property-box-new" role="function" condition="deprecated:"/>gnome_property_box_new ()</title>
<indexterm role="deprecated"><primary>gnome_property_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_property_box_new (void);</programlisting>
<warning><para><literal>gnome_property_box_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new GnomePropertyBox widget. The PropertyBox widget
is useful for making consistent configuration dialog boxes.
</para>
<para>
When a setting has been made to a property in the PropertyBox
your program needs to invoke the gnome_property_box_changed to signal
a change (this will enable the Ok/Apply buttons).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a newly created GnomePropertyBox widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-property-box-changed" role="function" condition="deprecated:"/>gnome_property_box_changed ()</title>
<indexterm role="deprecated"><primary>gnome_property_box_changed</primary></indexterm><programlisting><link linkend="void">void</link> gnome_property_box_changed (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *property_box);</programlisting>
<warning><para><literal>gnome_property_box_changed</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
When a setting has changed, the code needs to invoke this routine
to make the Ok/Apply buttons sensitive.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property_box</parameter> :</term>
<listitem><simpara> The GnomePropertyBox that contains the changed data
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-property-box-set-modified" role="function" condition="deprecated:"/>gnome_property_box_set_modified ()</title>
<indexterm role="deprecated"><primary>gnome_property_box_set_modified</primary></indexterm><programlisting><link linkend="void">void</link> gnome_property_box_set_modified (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *property_box,
<link linkend="gboolean">gboolean</link> state);</programlisting>
<warning><para><literal>gnome_property_box_set_modified</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This sets the modified flag of the GnomePropertyBox to the value in <parameter>state</parameter>.
Affects whether the OK/Apply buttons are sensitive.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property_box</parameter> :</term>
<listitem><simpara> The GnomePropertyBox that contains the changed data
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> The state. <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> means modified, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> means unmodified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-property-box-append-page" role="function" condition="deprecated:"/>gnome_property_box_append_page ()</title>
<indexterm role="deprecated"><primary>gnome_property_box_append_page</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_property_box_append_page (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *property_box,
<link linkend="GtkWidget">GtkWidget</link> *child,
<link linkend="GtkWidget">GtkWidget</link> *tab_label);</programlisting>
<warning><para><literal>gnome_property_box_append_page</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Appends a new page to the GnomePropertyBox.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property_box</parameter> :</term>
<listitem><simpara> The property box where we are inserting a new page
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child</parameter> :</term>
<listitem><simpara> The widget that is being inserted
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tab_label</parameter> :</term>
<listitem><simpara> The widget used as the label for this confiugration page
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the assigned index of the page inside the GnomePropertyBox or
-1 if one of the arguments is invalid.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-property-box-set-state" role="function" condition="deprecated:"/>gnome_property_box_set_state ()</title>
<indexterm role="deprecated"><primary>gnome_property_box_set_state</primary></indexterm><programlisting><link linkend="void">void</link> gnome_property_box_set_state (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *property_box,
<link linkend="gboolean">gboolean</link> state);</programlisting>
<warning><para><literal>gnome_property_box_set_state</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
An alias for <link linkend="gnome-property-box-set-modified"><function>gnome_property_box_set_modified()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>property_box</parameter> :</term>
<listitem><simpara> The GnomePropertyBox that contains the changed data
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> The state. <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> means modified, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> means unmodified.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="GnomePropertyBox-apply"/>The <literal>"apply"</literal> signal</title>
<indexterm><primary>GnomePropertyBox::apply</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *propertybox,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>propertybox</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>the notebook page number which emitted the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomePropertyBox-help"/>The <literal>"help"</literal> signal</title>
<indexterm><primary>GnomePropertyBox::help</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomePropertyBox">GnomePropertyBox</link> *propertybox,
<link linkend="gint">gint</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>propertybox</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>the notebook page number which emitted the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
