|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkExpander</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="LayoutContainers.html" title="Layout Containers">
<link rel="prev" href="GtkTable.html" title="GtkTable">
<link rel="next" href="Ornaments.html" title="Ornaments">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</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="GtkTable.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="LayoutContainers.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">GTK+ Reference Manual</th>
<td><a accesskey="n" href="Ornaments.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3498778" class="shortcut">Top</a>
 | 
<a href="#id3499470" class="shortcut">Description</a>
 | 
<a href="#id3499165" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3499226" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3499249" class="shortcut">Properties</a>
 | 
<a href="#id3499370" class="shortcut">Style Properties</a>
 | 
<a href="#id3499421" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkExpander"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3498778"></a><span class="refentrytitle">GtkExpander</span>
</h2>
<p>GtkExpander — A container which can hide its child</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkExpander.html#GtkExpander-struct">GtkExpander</a>;
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkExpander.html#gtk-expander-new">gtk_expander_new</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkExpander.html#gtk-expander-new-with-mnemonic">gtk_expander_new_with_mnemonic</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);
void <a href="GtkExpander.html#gtk-expander-set-expanded">gtk_expander_set_expanded</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> expanded);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkExpander.html#gtk-expander-get-expanded">gtk_expander_get_expanded</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);
void <a href="GtkExpander.html#gtk-expander-set-spacing">gtk_expander_set_spacing</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkExpander.html#gtk-expander-get-spacing">gtk_expander_get_spacing</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);
void <a href="GtkExpander.html#gtk-expander-set-label">gtk_expander_set_label</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkExpander.html#gtk-expander-get-label">gtk_expander_get_label</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);
void <a href="GtkExpander.html#gtk-expander-set-use-underline">gtk_expander_set_use_underline</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> use_underline);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkExpander.html#gtk-expander-get-use-underline">gtk_expander_get_use_underline</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);
void <a href="GtkExpander.html#gtk-expander-set-use-markup">gtk_expander_set_use_markup</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> use_markup);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkExpander.html#gtk-expander-get-use-markup">gtk_expander_get_use_markup</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);
void <a href="GtkExpander.html#gtk-expander-set-label-widget">gtk_expander_set_label_widget</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *label_widget);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkExpander.html#gtk-expander-get-label-widget">gtk_expander_get_label_widget</a> (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3499165"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
+----<a href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
+----<a href="GtkBin.html" title="GtkBin">GtkBin</a>
+----GtkExpander
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3499226"></a><h2>Implemented Interfaces</h2>
<p>
GtkExpander implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3499249"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkExpander.html#GtkExpander--expanded">expanded</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct
"<a href="GtkExpander.html#GtkExpander--label">label</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct
"<a href="GtkExpander.html#GtkExpander--label-widget">label-widget</a>" <a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> : Read / Write
"<a href="GtkExpander.html#GtkExpander--spacing">spacing</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a href="GtkExpander.html#GtkExpander--use-markup">use-markup</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct
"<a href="GtkExpander.html#GtkExpander--use-underline">use-underline</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3499370"></a><h2>Style Properties</h2>
<pre class="synopsis">
"<a href="GtkExpander.html#GtkExpander--expander-size">expander-size</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read
"<a href="GtkExpander.html#GtkExpander--expander-spacing">expander-spacing</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3499421"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkExpander.html#GtkExpander-activate">activate</a>" void user_function (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last / Action
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3499470"></a><h2>Description</h2>
<p>
A <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a> allows the user to hide or show its child by clicking on an expander triangle similar to
the triangles used in a <a href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>.
</p>
<p>
Normally you use an expander as you would use any other descendant
of <a href="GtkBin.html" title="GtkBin"><span class="type">GtkBin</span></a>; you create the child widget and use
<a href="GtkContainer.html#gtk-container-add"><code class="function">gtk_container_add()</code></a> to add it to the expander. When the expander
is toggled, it will take care of showing and hiding the child
automatically.
</p>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="expander-special-usage"></a>Special Usage</h2></div></div></div>
<p>
There are situations in which you may prefer to show and
hide the expanded widget yourself, such as when you want to
actually create the widget at expansion time. In this case,
create a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a> but do not add a child to it. The
expander widget has an <code class="literal">expanded</code> property
which can be used to monitor its expansion state. You should
watch this property with a signal connection as follows:
</p>
<a name="expander-callback-example"></a><pre class="programlisting">
expander = gtk_expander_new_with_mnemonic ("_More Options");
g_signal_connect (expander, "notify::expanded",
G_CALLBACK (expander_callback), NULL);
...
static void
expander_callback (GObject *object,
GParamSpec *param_spec,
gpointer user_data)
{
GtkExpander *expander;
expander = GTK_EXPANDER (object);
if (gtk_expander_get_expanded (expander))
{
/* Show or create widgets */
}
else
{
/* Hide or destroy widgets */
}
}
</pre>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3499582"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3499592"></a><h3>
<a name="GtkExpander-struct"></a>GtkExpander</h3>
<a class="indexterm" name="id3499605"></a><pre class="programlisting">typedef struct _GtkExpander GtkExpander;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3499620"></a><h3>
<a name="gtk-expander-new"></a>gtk_expander_new ()</h3>
<a class="indexterm" name="id3499635"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_expander_new (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);</pre>
<p>
Creates a new expander using <em class="parameter"><code>label</code></em> as the text of the label.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>label</code></em> :</span></td>
<td> the text of the label
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3499714"></a><h3>
<a name="gtk-expander-new-with-mnemonic"></a>gtk_expander_new_with_mnemonic ()</h3>
<a class="indexterm" name="id3499730"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_expander_new_with_mnemonic (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);</pre>
<p>
Creates a new expander using <em class="parameter"><code>label</code></em> as the text of the label.
If characters in <em class="parameter"><code>label</code></em> are preceded by an underscore, they are underlined.
If you need a literal underscore character in a label, use '__' (two
underscores). The first underlined character represents a keyboard
accelerator called a mnemonic.
Pressing Alt and that key activates the button.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>label</code></em> :</span></td>
<td> the text of the label with an underscore in front of the
mnemonic character
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a> widget.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3499821"></a><h3>
<a name="gtk-expander-set-expanded"></a>gtk_expander_set_expanded ()</h3>
<a class="indexterm" name="id3499838"></a><pre class="programlisting">void gtk_expander_set_expanded (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> expanded);</pre>
<p>
Sets the state of the expander. Set to <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, if you want
the child widget to be revealed, and <a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> if you want the
child widget to be hidden.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>expanded</code></em> :</span></td>
<td> whether the child widget is revealed
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3499943"></a><h3>
<a name="gtk-expander-get-expanded"></a>gtk_expander_get_expanded ()</h3>
<a class="indexterm" name="id3499959"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_expander_get_expanded (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);</pre>
<p>
Queries a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a> and returns its current state. Returns <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>
if the child widget is revealed.
</p>
<p>
See <a href="GtkExpander.html#gtk-expander-set-expanded"><code class="function">gtk_expander_set_expanded()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td>a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the current state of the expander.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500065"></a><h3>
<a name="gtk-expander-set-spacing"></a>gtk_expander_set_spacing ()</h3>
<a class="indexterm" name="id3500080"></a><pre class="programlisting">void gtk_expander_set_spacing (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing);</pre>
<p>
Sets the spacing field of <em class="parameter"><code>expander</code></em>, which is the number of pixels to
place between expander and the child.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
<td> distance between the expander and child in pixels.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500172"></a><h3>
<a name="gtk-expander-get-spacing"></a>gtk_expander_get_spacing ()</h3>
<a class="indexterm" name="id3500187"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_expander_get_spacing (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);</pre>
<p>
Gets the value set by <a href="GtkExpander.html#gtk-expander-set-spacing"><code class="function">gtk_expander_set_spacing()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> spacing between the expander and child.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500271"></a><h3>
<a name="gtk-expander-set-label"></a>gtk_expander_set_label ()</h3>
<a class="indexterm" name="id3500287"></a><pre class="programlisting">void gtk_expander_set_label (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);</pre>
<p>
Sets the text of the label of the expander to <em class="parameter"><code>label</code></em>.
</p>
<p>
This will also clear any previously set labels.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>label</code></em> :</span></td>
<td> a string
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500380"></a><h3>
<a name="gtk-expander-get-label"></a>gtk_expander_get_label ()</h3>
<a class="indexterm" name="id3500395"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_expander_get_label (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);</pre>
<p>
Fetches the text from the label of the expander, as set by
<a href="GtkExpander.html#gtk-expander-set-label"><code class="function">gtk_expander_set_label()</code></a>. If the label text has not
been set the return value will be <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>. This will be the
case if you create an empty button with <a href="GtkButton.html#gtk-button-new"><code class="function">gtk_button_new()</code></a> to
use as a container.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The text of the label widget. This string is owned
by the widget and must not be modified or freed.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500505"></a><h3>
<a name="gtk-expander-set-use-underline"></a>gtk_expander_set_use_underline ()</h3>
<a class="indexterm" name="id3500521"></a><pre class="programlisting">void gtk_expander_set_use_underline (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> use_underline);</pre>
<p>
If true, an underline in the text of the expander label indicates
the next character should be used for the mnemonic accelerator key.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>use_underline</code></em> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if underlines in the text indicate mnemonics
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500618"></a><h3>
<a name="gtk-expander-get-use-underline"></a>gtk_expander_get_use_underline ()</h3>
<a class="indexterm" name="id3500634"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_expander_get_use_underline (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);</pre>
<p>
Returns whether an embedded underline in the expander label indicates a
mnemonic. See <a href="GtkExpander.html#gtk-expander-set-use-underline"><code class="function">gtk_expander_set_use_underline()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if an embedded underline in the expander label
indicates the mnemonic accelerator keys.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500730"></a><h3>
<a name="gtk-expander-set-use-markup"></a>gtk_expander_set_use_markup ()</h3>
<a class="indexterm" name="id3500746"></a><pre class="programlisting">void gtk_expander_set_use_markup (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> use_markup);</pre>
<p>
Sets whether the text of the label contains markup in <a
href="../pango/PangoMarkupFormat.html"
>Pango's text markup
language</a>. See <a href="GtkLabel.html#gtk-label-set-markup"><code class="function">gtk_label_set_markup()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>use_markup</code></em> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the label's text should be parsed for markup
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500859"></a><h3>
<a name="gtk-expander-get-use-markup"></a>gtk_expander_get_use_markup ()</h3>
<a class="indexterm" name="id3500875"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_expander_get_use_markup (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);</pre>
<p>
Returns whether the label's text is interpreted as marked up with
the <a
href="../pango/PangoMarkupFormat.html"
>Pango text markup
language</a>. See <a href="GtkExpander.html#gtk-expander-set-use-markup"><code class="function">gtk_expander_set_use_markup()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the label's text will be parsed for markup
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3500977"></a><h3>
<a name="gtk-expander-set-label-widget"></a>gtk_expander_set_label_widget ()</h3>
<a class="indexterm" name="id3500993"></a><pre class="programlisting">void gtk_expander_set_label_widget (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *label_widget);</pre>
<p>
Set the label widget for the expander. This is the widget
that will appear embedded alongside the expander arrow.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>label_widget</code></em> :</span></td>
<td> the new label widget
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3501078"></a><h3>
<a name="gtk-expander-get-label-widget"></a>gtk_expander_get_label_widget ()</h3>
<a class="indexterm" name="id3501094"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_expander_get_label_widget (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander);</pre>
<p>
Retrieves the label widget for the frame. See
<a href="GtkExpander.html#gtk-expander-set-label-widget"><code class="function">gtk_expander_set_label_widget()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td> a <a href="GtkExpander.html" title="GtkExpander"><span class="type">GtkExpander</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the label widget, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if there is none.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3501190"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3501201"></a><h3>
<a name="GtkExpander--expanded"></a>The "<code class="literal">expanded</code>" property</h3>
<a class="indexterm" name="id3501217"></a><pre class="programlisting"> "expanded" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct</pre>
<p>Whether the expander has been opened to reveal the child widget.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3501244"></a><h3>
<a name="GtkExpander--label"></a>The "<code class="literal">label</code>" property</h3>
<a class="indexterm" name="id3501260"></a><pre class="programlisting"> "label" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct</pre>
<p>Text of the expander's label.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3501287"></a><h3>
<a name="GtkExpander--label-widget"></a>The "<code class="literal">label-widget</code>" property</h3>
<a class="indexterm" name="id3501304"></a><pre class="programlisting"> "label-widget" <a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> : Read / Write</pre>
<p>A widget to display in place of the usual expander label.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3501327"></a><h3>
<a name="GtkExpander--spacing"></a>The "<code class="literal">spacing</code>" property</h3>
<a class="indexterm" name="id3501343"></a><pre class="programlisting"> "spacing" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>Space to put between the label and the child.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3501374"></a><h3>
<a name="GtkExpander--use-markup"></a>The "<code class="literal">use-markup</code>" property</h3>
<a class="indexterm" name="id3501390"></a><pre class="programlisting"> "use-markup" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct</pre>
<p>The text of the label includes XML markup. See pango_parse_markup().</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3501418"></a><h3>
<a name="GtkExpander--use-underline"></a>The "<code class="literal">use-underline</code>" property</h3>
<a class="indexterm" name="id3501434"></a><pre class="programlisting"> "use-underline" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write / Construct</pre>
<p>If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3501463"></a><h2>Style Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3501474"></a><h3>
<a name="GtkExpander--expander-size"></a>The "<code class="literal">expander-size</code>" style property</h3>
<a class="indexterm" name="id3501491"></a><pre class="programlisting"> "expander-size" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read</pre>
<p>Size of the expander arrow.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 10</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3501522"></a><h3>
<a name="GtkExpander--expander-spacing"></a>The "<code class="literal">expander-spacing</code>" style property</h3>
<a class="indexterm" name="id3501539"></a><pre class="programlisting"> "expander-spacing" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read</pre>
<p>Spacing around expander arrow.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 2</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3501570"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3501581"></a><h3>
<a name="GtkExpander-activate"></a>The "activate" signal</h3>
<a class="indexterm" name="id3501592"></a><pre class="programlisting">void user_function (<a href="GtkExpander.html" title="GtkExpander">GtkExpander</a> *expander,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last / Action</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>expander</code></em> :</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>