← Back to branch summary

~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

Viewing changes to docs/reference/gtk/xml/gtkexpander.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-05-04 12:24:25 UTC
  • mfrom: (1.1.21 upstream)
  • Revision ID: james.westby@ubuntu.com-20070504122425-0m8midgzrp40y8w2
Tags: 2.10.12-1ubuntu1
* Sync with Debian
* New upstream version:
  Fixed bugs:
  - 379414 file chooser warnings when changing path in the entry
  - 418585 GtkFileChooserDefault sizing code is not DPI independent
  - 419568 Crash in search if start with special letter
  - 435062 build dies with icon cache validation
  - 379399 Segfault to call gtk_print_operation_run twice.
  - 387889 cups backend has problems when there are too many printers
  - 418531 invalid read to gtkicontheme.c gtk_icon_theme_lookup_icon...
  - 423916 crash in color scheme code
  - 424042 Segmentation fault while quickly pressing Alt+arrows
  - 415260 Protect against negative indices when setting values in G...
  - 419171 XGetVisualInfo() may not set nxvisuals
  - 128852 Gdk cursors don't look good on win32
  - 344657 Ctrl-H doesn't toggle "Show Hidden Files" setting
  - 345345 PrintOperation::paginate is not emitted for class handler
  - 347567 GtkPrintOperation::end-print is not emitted if it's cance...
  - 369112 gtk_ui_manager_add_ui should accept unnamed separator
  - 392015 Selected menu item invisible on Windows Vista
  - 399253 MS-Windows Theme Bottom Tab placement rendering glitches
  - 399425 gtk_input_dialog_fill_axes() adds child to gtkscrolledwin...
  - 403251 [patch] little memory leak in GtkPrintJob
  - 403267 [patch] memory leak in GtkPageSetupUnixDialog
  - 403470 MS-Windows Theme tab placement other than on top leaks a ...
  - 404506 Windows system fonts that have multi-byte font names cann...
  - 405089 Incorrect window placement for GtkEventBox private window
  - 405515 Minor leak in gtkfilesystemmodel.c
  - 405539 gdk_pixbuf_save() for PNG saver can return FALSE without ...
  - 415681 gdk_window_clear_area includes an extra line and column o...
  - 418219 GtkRecentChooser should apply filter before sorting and c...
  - 418403 Scroll to printer after selecting it from settings
  - 421985 _gtk_print_operation_platform_backend_launch_preview
  - 421990 gtk_print_job_get_surface
  - 421993 gtk_print_operation_init
  - 423064 Conditional jump or move depends on uninitialised value(s...
  - 423722 Fix printing header in gtk-demo
  - 424168 gtk_print_operation_run on async preview
  - 425655 Don't install gtk+-unix-print-2.0.pc on non-UNIX platforms
  - 425786 GDK segfaults if XineramaQueryScreens fails
  - 428665 Lpr Backend gets stuck in infinite loop during gtk_enumer...
  - 429902 GtkPrintOperation leaks cairo contextes
  - 431997 First delay of GdkPixbufAnimationIter is wrong
  - 433242 Inconsistent scroll arrow position calculations
  - 433972 Placing gtk.Expander inside a gtk.TextView() changes gtk....
  - 434261 _gtk_toolbar_elide_underscores incorrectly handles some s...
  - 383354 ctrl-L should make 'Location' entry disappear
  - 418673 gtk_recent_manager_add_item
  - 429732 gtk_accel_group_finalize accesses invalid memory
  - 435028 WM_CLIENT_LEADER is wrong on the leader_window
  - 431067 Background of the header window is not updated
  - 338843 add recent files support inside the ui manager
  - 148535 add drop shadow to menus, tooltips, etc. under Windows XP
* debian/control.in:
  - Conflicts on ubuntulooks (<= 0.9.11-1)
* debian/patches/15_default-fallback-icon-theme.patch:
  - patch from Debian, fallback on gnome icon theme

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/xml/gtkexpander.xml
 
1
<refentry id="GtkExpander">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page">GtkExpander</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>GTK Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>GtkExpander</refname>
 
10
<refpurpose>A container which can hide its child</refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
</refnamediv>
 
13
 
 
14
<refsynopsisdiv role="synopsis">
 
15
<title role="synopsis.title">Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
#include &lt;gtk/gtk.h&gt;
 
20
 
 
21
 
 
22
                    <link linkend="GtkExpander-struct">GtkExpander</link>;
 
23
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-expander-new">gtk_expander_new</link>                    (const <link linkend="gchar">gchar</link> *label);
 
24
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-expander-new-with-mnemonic">gtk_expander_new_with_mnemonic</link>      (const <link linkend="gchar">gchar</link> *label);
 
25
<link linkend="void">void</link>                <link linkend="gtk-expander-set-expanded">gtk_expander_set_expanded</link>           (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
26
                                                         <link linkend="gboolean">gboolean</link> expanded);
 
27
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-expander-get-expanded">gtk_expander_get_expanded</link>           (<link linkend="GtkExpander">GtkExpander</link> *expander);
 
28
<link linkend="void">void</link>                <link linkend="gtk-expander-set-spacing">gtk_expander_set_spacing</link>            (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
29
                                                         <link linkend="gint">gint</link> spacing);
 
30
<link linkend="gint">gint</link>                <link linkend="gtk-expander-get-spacing">gtk_expander_get_spacing</link>            (<link linkend="GtkExpander">GtkExpander</link> *expander);
 
31
<link linkend="void">void</link>                <link linkend="gtk-expander-set-label">gtk_expander_set_label</link>              (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
32
                                                         const <link linkend="gchar">gchar</link> *label);
 
33
const <link linkend="gchar">gchar</link>*        <link linkend="gtk-expander-get-label">gtk_expander_get_label</link>              (<link linkend="GtkExpander">GtkExpander</link> *expander);
 
34
<link linkend="void">void</link>                <link linkend="gtk-expander-set-use-underline">gtk_expander_set_use_underline</link>      (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
35
                                                         <link linkend="gboolean">gboolean</link> use_underline);
 
36
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-expander-get-use-underline">gtk_expander_get_use_underline</link>      (<link linkend="GtkExpander">GtkExpander</link> *expander);
 
37
<link linkend="void">void</link>                <link linkend="gtk-expander-set-use-markup">gtk_expander_set_use_markup</link>         (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
38
                                                         <link linkend="gboolean">gboolean</link> use_markup);
 
39
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-expander-get-use-markup">gtk_expander_get_use_markup</link>         (<link linkend="GtkExpander">GtkExpander</link> *expander);
 
40
<link linkend="void">void</link>                <link linkend="gtk-expander-set-label-widget">gtk_expander_set_label_widget</link>       (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
41
                                                         <link linkend="GtkWidget">GtkWidget</link> *label_widget);
 
42
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-expander-get-label-widget">gtk_expander_get_label_widget</link>       (<link linkend="GtkExpander">GtkExpander</link> *expander);
 
43
 
 
44
 
 
45
</synopsis>
 
46
</refsynopsisdiv>
 
47
 
 
48
<refsect1 role="object_hierarchy">
 
49
<title role="object_hierarchy.title">Object Hierarchy</title>
 
50
<synopsis>
 
51
 
 
52
  <link linkend="GObject">GObject</link>
 
53
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
54
         +----<link linkend="GtkObject">GtkObject</link>
 
55
               +----<link linkend="GtkWidget">GtkWidget</link>
 
56
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
57
                           +----<link linkend="GtkBin">GtkBin</link>
 
58
                                 +----GtkExpander
 
59
</synopsis>
 
60
 
 
61
</refsect1>
 
62
 
 
63
 
 
64
 
 
65
<refsect1 role="impl_interfaces">
 
66
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
67
<para>
 
68
GtkExpander implements
 
69
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
70
 
 
71
</refsect1>
 
72
 
 
73
 
 
74
<refsect1 role="properties">
 
75
<title role="properties.title">Properties</title>
 
76
<synopsis>
 
77
 
 
78
  &quot;<link linkend="GtkExpander--expanded">expanded</link>&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write / Construct
 
79
  &quot;<link linkend="GtkExpander--label">label</link>&quot;                    <link linkend="gchararray">gchararray</link>            : Read / Write / Construct
 
80
  &quot;<link linkend="GtkExpander--label-widget">label-widget</link>&quot;             <link linkend="GtkWidget">GtkWidget</link>             : Read / Write
 
81
  &quot;<link linkend="GtkExpander--spacing">spacing</link>&quot;                  <link linkend="gint">gint</link>                  : Read / Write
 
82
  &quot;<link linkend="GtkExpander--use-markup">use-markup</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write / Construct
 
83
  &quot;<link linkend="GtkExpander--use-underline">use-underline</link>&quot;            <link linkend="gboolean">gboolean</link>              : Read / Write / Construct
 
84
</synopsis>
 
85
</refsect1>
 
86
<refsect1 role="style_properties">
 
87
<title role="style_properties.title">Style Properties</title>
 
88
<synopsis>
 
89
 
 
90
  &quot;<link linkend="GtkExpander--expander-size">expander-size</link>&quot;            <link linkend="gint">gint</link>                  : Read
 
91
  &quot;<link linkend="GtkExpander--expander-spacing">expander-spacing</link>&quot;         <link linkend="gint">gint</link>                  : Read
 
92
</synopsis>
 
93
</refsect1>
 
94
 
 
95
<refsect1 role="signal_proto">
 
96
<title role="signal_proto.title">Signals</title>
 
97
<synopsis>
 
98
 
 
99
  &quot;<link linkend="GtkExpander-activate">activate</link>&quot;                                       : Run Last / Action
 
100
</synopsis>
 
101
</refsect1>
 
102
 
 
103
 
 
104
<refsect1 role="desc">
 
105
<title role="desc.title">Description</title>
 
106
<para>
 
107
A <link linkend="GtkExpander"><type>GtkExpander</type></link> allows the user to hide or show its child by clicking on an expander triangle similar to 
 
108
the triangles used in a <link linkend="GtkTreeView"><type>GtkTreeView</type></link>.
 
109
</para>
 
110
 
 
111
  <para>
 
112
    Normally you use an expander as you would use any other descendant
 
113
    of <link linkend="GtkBin"><type>GtkBin</type></link>; you create the child widget and use
 
114
    <link linkend="gtk-container-add"><function>gtk_container_add()</function></link> to add it to the expander.  When the expander
 
115
    is toggled, it will take care of showing and hiding the child
 
116
    automatically.
 
117
  </para>
 
118
 
 
119
  <section id="expander-special-usage">
 
120
    <title>Special Usage</title>
 
121
 
 
122
    <para>
 
123
      There are situations in which you may prefer to show and
 
124
      hide the expanded widget yourself, such as when you want to
 
125
      actually create the widget at expansion time.  In this case,
 
126
      create a <link linkend="GtkExpander"><type>GtkExpander</type></link> but do not add a child to it.  The
 
127
      expander widget has an <literal>expanded</literal> property
 
128
      which can be used to monitor its expansion state.  You should
 
129
      watch this property with a signal connection as follows:
 
130
    </para>
 
131
 
 
132
    <programlisting id="expander-callback-example">
 
133
expander = gtk_expander_new_with_mnemonic ("_More Options");
 
134
g_signal_connect (expander, "notify::expanded",
 
135
                  G_CALLBACK (expander_callback), NULL);
 
136
 
 
137
...
 
138
 
 
139
static void
 
140
expander_callback (GObject    *object,
 
141
                   GParamSpec *param_spec,
 
142
                   gpointer    user_data)
 
143
{
 
144
  GtkExpander *expander;
 
145
 
 
146
  expander = GTK_EXPANDER (object);
 
147
 
 
148
  if (gtk_expander_get_expanded (expander))
 
149
    {
 
150
      /* Show or create widgets */
 
151
    }
 
152
  else
 
153
    {
 
154
      /* Hide or destroy widgets */
 
155
    }
 
156
}
 
157
 
 
158
    </programlisting>
 
159
  </section>
 
160
</refsect1>
 
161
 
 
162
<refsect1 role="details">
 
163
<title role="details.title">Details</title>
 
164
<refsect2>
 
165
<title><anchor id="GtkExpander-struct" role="struct"/>GtkExpander</title>
 
166
<indexterm><primary>GtkExpander</primary></indexterm><programlisting>typedef struct _GtkExpander GtkExpander;</programlisting>
 
167
<para>
 
168
 
 
169
</para></refsect2>
 
170
<refsect2>
 
171
<title><anchor id="gtk-expander-new" role="function" condition="since:2.4"/>gtk_expander_new ()</title>
 
172
<indexterm role="2.4"><primary>gtk_expander_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_expander_new                    (const <link linkend="gchar">gchar</link> *label);</programlisting>
 
173
<para>
 
174
Creates a new expander using <parameter>label</parameter> as the text of the label.</para>
 
175
<para>
 
176
 
 
177
</para><variablelist role="params">
 
178
<varlistentry><term><parameter>label</parameter>&nbsp;:</term>
 
179
<listitem><simpara> the text of the label
 
180
</simpara></listitem></varlistentry>
 
181
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GtkExpander"><type>GtkExpander</type></link> widget.
 
182
 
 
183
</simpara></listitem></varlistentry>
 
184
</variablelist><para role="since">Since  2.4
 
185
</para></refsect2>
 
186
<refsect2>
 
187
<title><anchor id="gtk-expander-new-with-mnemonic" role="function" condition="since:2.4"/>gtk_expander_new_with_mnemonic ()</title>
 
188
<indexterm role="2.4"><primary>gtk_expander_new_with_mnemonic</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_expander_new_with_mnemonic      (const <link linkend="gchar">gchar</link> *label);</programlisting>
 
189
<para>
 
190
Creates a new expander using <parameter>label</parameter> as the text of the label.
 
191
If characters in <parameter>label</parameter> are preceded by an underscore, they are underlined.
 
192
If you need a literal underscore character in a label, use '__' (two 
 
193
underscores). The first underlined character represents a keyboard 
 
194
accelerator called a mnemonic.
 
195
Pressing Alt and that key activates the button.</para>
 
196
<para>
 
197
 
 
198
</para><variablelist role="params">
 
199
<varlistentry><term><parameter>label</parameter>&nbsp;:</term>
 
200
<listitem><simpara> the text of the label with an underscore in front of the
 
201
        mnemonic character
 
202
</simpara></listitem></varlistentry>
 
203
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GtkExpander"><type>GtkExpander</type></link> widget.
 
204
 
 
205
</simpara></listitem></varlistentry>
 
206
</variablelist><para role="since">Since  2.4
 
207
</para></refsect2>
 
208
<refsect2>
 
209
<title><anchor id="gtk-expander-set-expanded" role="function" condition="since:2.4"/>gtk_expander_set_expanded ()</title>
 
210
<indexterm role="2.4"><primary>gtk_expander_set_expanded</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_expander_set_expanded           (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
211
                                                         <link linkend="gboolean">gboolean</link> expanded);</programlisting>
 
212
<para>
 
213
Sets the state of the expander. Set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, if you want
 
214
the child widget to be revealed, and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if you want the
 
215
child widget to be hidden.</para>
 
216
<para>
 
217
 
 
218
</para><variablelist role="params">
 
219
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
220
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><parameter>expanded</parameter>&nbsp;:</term>
 
223
<listitem><simpara> whether the child widget is revealed
 
224
</simpara></listitem></varlistentry>
 
225
</variablelist><para role="since">Since  2.4
 
226
</para></refsect2>
 
227
<refsect2>
 
228
<title><anchor id="gtk-expander-get-expanded" role="function" condition="since:2.4"/>gtk_expander_get_expanded ()</title>
 
229
<indexterm role="2.4"><primary>gtk_expander_get_expanded</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_expander_get_expanded           (<link linkend="GtkExpander">GtkExpander</link> *expander);</programlisting>
 
230
<para>
 
231
Queries a <link linkend="GtkExpander"><type>GtkExpander</type></link> and returns its current state. Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
 
232
if the child widget is revealed.
 
233
</para>
 
234
<para>
 
235
See <link linkend="gtk-expander-set-expanded"><function>gtk_expander_set_expanded()</function></link>.</para>
 
236
<para>
 
237
 
 
238
</para><variablelist role="params">
 
239
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
240
<listitem><simpara>a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
241
</simpara></listitem></varlistentry>
 
242
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current state of the expander.
 
243
 
 
244
</simpara></listitem></varlistentry>
 
245
</variablelist><para role="since">Since  2.4
 
246
</para></refsect2>
 
247
<refsect2>
 
248
<title><anchor id="gtk-expander-set-spacing" role="function" condition="since:2.4"/>gtk_expander_set_spacing ()</title>
 
249
<indexterm role="2.4"><primary>gtk_expander_set_spacing</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_expander_set_spacing            (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
250
                                                         <link linkend="gint">gint</link> spacing);</programlisting>
 
251
<para>
 
252
Sets the spacing field of <parameter>expander</parameter>, which is the number of pixels to
 
253
place between expander and the child.</para>
 
254
<para>
 
255
 
 
256
</para><variablelist role="params">
 
257
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
258
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
259
</simpara></listitem></varlistentry>
 
260
<varlistentry><term><parameter>spacing</parameter>&nbsp;:</term>
 
261
<listitem><simpara> distance between the expander and child in pixels.
 
262
</simpara></listitem></varlistentry>
 
263
</variablelist><para role="since">Since  2.4
 
264
</para></refsect2>
 
265
<refsect2>
 
266
<title><anchor id="gtk-expander-get-spacing" role="function" condition="since:2.4"/>gtk_expander_get_spacing ()</title>
 
267
<indexterm role="2.4"><primary>gtk_expander_get_spacing</primary></indexterm><programlisting><link linkend="gint">gint</link>                gtk_expander_get_spacing            (<link linkend="GtkExpander">GtkExpander</link> *expander);</programlisting>
 
268
<para>
 
269
Gets the value set by <link linkend="gtk-expander-set-spacing"><function>gtk_expander_set_spacing()</function></link>.</para>
 
270
<para>
 
271
 
 
272
</para><variablelist role="params">
 
273
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
274
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
275
</simpara></listitem></varlistentry>
 
276
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> spacing between the expander and child.
 
277
 
 
278
</simpara></listitem></varlistentry>
 
279
</variablelist><para role="since">Since  2.4
 
280
</para></refsect2>
 
281
<refsect2>
 
282
<title><anchor id="gtk-expander-set-label" role="function" condition="since:2.4"/>gtk_expander_set_label ()</title>
 
283
<indexterm role="2.4"><primary>gtk_expander_set_label</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_expander_set_label              (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
284
                                                         const <link linkend="gchar">gchar</link> *label);</programlisting>
 
285
<para>
 
286
Sets the text of the label of the expander to <parameter>label</parameter>.
 
287
</para>
 
288
<para>
 
289
This will also clear any previously set labels.</para>
 
290
<para>
 
291
 
 
292
</para><variablelist role="params">
 
293
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
294
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
295
</simpara></listitem></varlistentry>
 
296
<varlistentry><term><parameter>label</parameter>&nbsp;:</term>
 
297
<listitem><simpara> a string
 
298
</simpara></listitem></varlistentry>
 
299
</variablelist><para role="since">Since  2.4
 
300
</para></refsect2>
 
301
<refsect2>
 
302
<title><anchor id="gtk-expander-get-label" role="function" condition="since:2.4"/>gtk_expander_get_label ()</title>
 
303
<indexterm role="2.4"><primary>gtk_expander_get_label</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gtk_expander_get_label              (<link linkend="GtkExpander">GtkExpander</link> *expander);</programlisting>
 
304
<para>
 
305
Fetches the text from the label of the expander, as set by
 
306
<link linkend="gtk-expander-set-label"><function>gtk_expander_set_label()</function></link>. If the label text has not
 
307
been set the return value will be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. This will be the
 
308
case if you create an empty button with <link linkend="gtk-button-new"><function>gtk_button_new()</function></link> to
 
309
use as a container.</para>
 
310
<para>
 
311
 
 
312
</para><variablelist role="params">
 
313
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
314
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
315
</simpara></listitem></varlistentry>
 
316
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The text of the label widget. This string is owned
 
317
by the widget and must not be modified or freed.
 
318
 
 
319
</simpara></listitem></varlistentry>
 
320
</variablelist><para role="since">Since  2.4
 
321
</para></refsect2>
 
322
<refsect2>
 
323
<title><anchor id="gtk-expander-set-use-underline" role="function" condition="since:2.4"/>gtk_expander_set_use_underline ()</title>
 
324
<indexterm role="2.4"><primary>gtk_expander_set_use_underline</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_expander_set_use_underline      (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
325
                                                         <link linkend="gboolean">gboolean</link> use_underline);</programlisting>
 
326
<para>
 
327
If true, an underline in the text of the expander label indicates
 
328
the next character should be used for the mnemonic accelerator key.</para>
 
329
<para>
 
330
 
 
331
</para><variablelist role="params">
 
332
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
333
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
334
</simpara></listitem></varlistentry>
 
335
<varlistentry><term><parameter>use_underline</parameter>&nbsp;:</term>
 
336
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if underlines in the text indicate mnemonics
 
337
</simpara></listitem></varlistentry>
 
338
</variablelist><para role="since">Since  2.4
 
339
</para></refsect2>
 
340
<refsect2>
 
341
<title><anchor id="gtk-expander-get-use-underline" role="function" condition="since:2.4"/>gtk_expander_get_use_underline ()</title>
 
342
<indexterm role="2.4"><primary>gtk_expander_get_use_underline</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_expander_get_use_underline      (<link linkend="GtkExpander">GtkExpander</link> *expander);</programlisting>
 
343
<para>
 
344
Returns whether an embedded underline in the expander label indicates a
 
345
mnemonic. See <link linkend="gtk-expander-set-use-underline"><function>gtk_expander_set_use_underline()</function></link>.</para>
 
346
<para>
 
347
 
 
348
</para><variablelist role="params">
 
349
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
350
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
351
</simpara></listitem></varlistentry>
 
352
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if an embedded underline in the expander label
 
353
              indicates the mnemonic accelerator keys.
 
354
 
 
355
</simpara></listitem></varlistentry>
 
356
</variablelist><para role="since">Since  2.4
 
357
</para></refsect2>
 
358
<refsect2>
 
359
<title><anchor id="gtk-expander-set-use-markup" role="function" condition="since:2.4"/>gtk_expander_set_use_markup ()</title>
 
360
<indexterm role="2.4"><primary>gtk_expander_set_use_markup</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_expander_set_use_markup         (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
361
                                                         <link linkend="gboolean">gboolean</link> use_markup);</programlisting>
 
362
<para>
 
363
Sets whether the text of the label contains markup in <link
 
364
linkend="PangoMarkupFormat">Pango's text markup
 
365
language</link>. See <link linkend="gtk-label-set-markup"><function>gtk_label_set_markup()</function></link>.</para>
 
366
<para>
 
367
 
 
368
</para><variablelist role="params">
 
369
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
370
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
371
</simpara></listitem></varlistentry>
 
372
<varlistentry><term><parameter>use_markup</parameter>&nbsp;:</term>
 
373
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the label's text should be parsed for markup
 
374
</simpara></listitem></varlistentry>
 
375
</variablelist><para role="since">Since  2.4
 
376
</para></refsect2>
 
377
<refsect2>
 
378
<title><anchor id="gtk-expander-get-use-markup" role="function" condition="since:2.4"/>gtk_expander_get_use_markup ()</title>
 
379
<indexterm role="2.4"><primary>gtk_expander_get_use_markup</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_expander_get_use_markup         (<link linkend="GtkExpander">GtkExpander</link> *expander);</programlisting>
 
380
<para>
 
381
Returns whether the label's text is interpreted as marked up with
 
382
the <link linkend="PangoMarkupFormat">Pango text markup
 
383
language</link>. See <link linkend="gtk-expander-set-use-markup"><function>gtk_expander_set_use_markup()</function></link>.</para>
 
384
<para>
 
385
 
 
386
</para><variablelist role="params">
 
387
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
388
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
389
</simpara></listitem></varlistentry>
 
390
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the label's text will be parsed for markup
 
391
 
 
392
</simpara></listitem></varlistentry>
 
393
</variablelist><para role="since">Since  2.4
 
394
</para></refsect2>
 
395
<refsect2>
 
396
<title><anchor id="gtk-expander-set-label-widget" role="function" condition="since:2.4"/>gtk_expander_set_label_widget ()</title>
 
397
<indexterm role="2.4"><primary>gtk_expander_set_label_widget</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_expander_set_label_widget       (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
398
                                                         <link linkend="GtkWidget">GtkWidget</link> *label_widget);</programlisting>
 
399
<para>
 
400
Set the label widget for the expander. This is the widget
 
401
that will appear embedded alongside the expander arrow.</para>
 
402
<para>
 
403
 
 
404
</para><variablelist role="params">
 
405
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
406
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
407
</simpara></listitem></varlistentry>
 
408
<varlistentry><term><parameter>label_widget</parameter>&nbsp;:</term>
 
409
<listitem><simpara> the new label widget
 
410
</simpara></listitem></varlistentry>
 
411
</variablelist><para role="since">Since  2.4
 
412
</para></refsect2>
 
413
<refsect2>
 
414
<title><anchor id="gtk-expander-get-label-widget" role="function" condition="since:2.4"/>gtk_expander_get_label_widget ()</title>
 
415
<indexterm role="2.4"><primary>gtk_expander_get_label_widget</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_expander_get_label_widget       (<link linkend="GtkExpander">GtkExpander</link> *expander);</programlisting>
 
416
<para>
 
417
Retrieves the label widget for the frame. See
 
418
<link linkend="gtk-expander-set-label-widget"><function>gtk_expander_set_label_widget()</function></link>.</para>
 
419
<para>
 
420
 
 
421
</para><variablelist role="params">
 
422
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
423
<listitem><simpara> a <link linkend="GtkExpander"><type>GtkExpander</type></link>
 
424
</simpara></listitem></varlistentry>
 
425
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the label widget, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if there is none.
 
426
 
 
427
</simpara></listitem></varlistentry>
 
428
</variablelist><para role="since">Since  2.4
 
429
</para></refsect2>
 
430
 
 
431
</refsect1>
 
432
<refsect1 role="property_details">
 
433
<title role="property_details.title">Property Details</title>
 
434
<refsect2><title><anchor id="GtkExpander--expanded"/>The &quot;<literal>expanded</literal>&quot; property</title>
 
435
<indexterm><primary>GtkExpander:expanded</primary></indexterm><programlisting>  &quot;expanded&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write / Construct</programlisting>
 
436
<para>Whether the expander has been opened to reveal the child widget.</para><para>Default value: FALSE</para>
 
437
</refsect2>
 
438
<refsect2><title><anchor id="GtkExpander--label"/>The &quot;<literal>label</literal>&quot; property</title>
 
439
<indexterm><primary>GtkExpander:label</primary></indexterm><programlisting>  &quot;label&quot;                    <link linkend="gchararray">gchararray</link>            : Read / Write / Construct</programlisting>
 
440
<para>Text of the expander's label.</para><para>Default value: NULL</para>
 
441
</refsect2>
 
442
<refsect2><title><anchor id="GtkExpander--label-widget"/>The &quot;<literal>label-widget</literal>&quot; property</title>
 
443
<indexterm><primary>GtkExpander:label-widget</primary></indexterm><programlisting>  &quot;label-widget&quot;             <link linkend="GtkWidget">GtkWidget</link>             : Read / Write</programlisting>
 
444
<para>A widget to display in place of the usual expander label.</para></refsect2>
 
445
<refsect2><title><anchor id="GtkExpander--spacing"/>The &quot;<literal>spacing</literal>&quot; property</title>
 
446
<indexterm><primary>GtkExpander:spacing</primary></indexterm><programlisting>  &quot;spacing&quot;                  <link linkend="gint">gint</link>                  : Read / Write</programlisting>
 
447
<para>Space to put between the label and the child.</para><para>Allowed values: &gt;= 0</para>
 
448
<para>Default value: 0</para>
 
449
</refsect2>
 
450
<refsect2><title><anchor id="GtkExpander--use-markup"/>The &quot;<literal>use-markup</literal>&quot; property</title>
 
451
<indexterm><primary>GtkExpander:use-markup</primary></indexterm><programlisting>  &quot;use-markup&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write / Construct</programlisting>
 
452
<para>The text of the label includes XML markup. See pango_parse_markup().</para><para>Default value: FALSE</para>
 
453
</refsect2>
 
454
<refsect2><title><anchor id="GtkExpander--use-underline"/>The &quot;<literal>use-underline</literal>&quot; property</title>
 
455
<indexterm><primary>GtkExpander:use-underline</primary></indexterm><programlisting>  &quot;use-underline&quot;            <link linkend="gboolean">gboolean</link>              : Read / Write / Construct</programlisting>
 
456
<para>If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.</para><para>Default value: FALSE</para>
 
457
</refsect2>
 
458
 
 
459
</refsect1>
 
460
<refsect1 role="style_properties_details">
 
461
<title role="style_properties_details.title">Style Property Details</title>
 
462
<refsect2><title><anchor id="GtkExpander--expander-size"/>The &quot;<literal>expander-size</literal>&quot; style property</title>
 
463
<indexterm><primary>GtkExpander:expander-size</primary></indexterm><programlisting>  &quot;expander-size&quot;            <link linkend="gint">gint</link>                  : Read</programlisting>
 
464
<para>Size of the expander arrow.</para><para>Allowed values: &gt;= 0</para>
 
465
<para>Default value: 10</para>
 
466
</refsect2>
 
467
<refsect2><title><anchor id="GtkExpander--expander-spacing"/>The &quot;<literal>expander-spacing</literal>&quot; style property</title>
 
468
<indexterm><primary>GtkExpander:expander-spacing</primary></indexterm><programlisting>  &quot;expander-spacing&quot;         <link linkend="gint">gint</link>                  : Read</programlisting>
 
469
<para>Spacing around expander arrow.</para><para>Allowed values: &gt;= 0</para>
 
470
<para>Default value: 2</para>
 
471
</refsect2>
 
472
 
 
473
</refsect1>
 
474
 
 
475
<refsect1 role="signals">
 
476
<title role="signals.title">Signal Details</title>
 
477
<refsect2><title><anchor id="GtkExpander-activate"/>The &quot;activate&quot; signal</title>
 
478
<indexterm><primary>GtkExpander::activate</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkExpander">GtkExpander</link> *expander,
 
479
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last / Action</programlisting>
 
480
<para>
 
481
 
 
482
</para><variablelist role="params">
 
483
<varlistentry><term><parameter>expander</parameter>&nbsp;:</term>
 
484
<listitem><simpara>the object which received the signal.
 
485
 
 
486
</simpara></listitem></varlistentry>
 
487
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
488
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
489
</variablelist></refsect2>
 
490
</refsect1>
 
491
 
 
492
 
 
493
 
 
494
</refentry>