|
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>GtkToolButton</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="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="prev" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem">
<link rel="next" href="GtkMenuToolButton.html" title="GtkMenuToolButton">
<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="GtkSeparatorToolItem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="MenusAndCombos.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="GtkMenuToolButton.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="#id3337691" class="shortcut">Top</a>
 | 
<a href="#id3338408" class="shortcut">Description</a>
 | 
<a href="#id3338096" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3338181" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3338204" class="shortcut">Properties</a>
 | 
<a href="#id3338324" class="shortcut">Style Properties</a>
 | 
<a href="#id3338358" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkToolButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3337691"></a><span class="refentrytitle">GtkToolButton</span>
</h2>
<p>GtkToolButton — A GtkToolItem subclass that displays buttons</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="GtkToolButton.html#GtkToolButton-struct">GtkToolButton</a>;
<a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>* <a href="GtkToolButton.html#gtk-tool-button-new">gtk_tool_button_new</a> (<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *icon_widget,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);
<a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>* <a href="GtkToolButton.html#gtk-tool-button-new-from-stock">gtk_tool_button_new_from_stock</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);
void <a href="GtkToolButton.html#gtk-tool-button-set-label">gtk_tool_button_set_label</a> (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
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="GtkToolButton.html#gtk-tool-button-get-label">gtk_tool_button_get_label</a> (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);
void <a href="GtkToolButton.html#gtk-tool-button-set-use-underline">gtk_tool_button_set_use_underline</a>
(<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> use_underline);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkToolButton.html#gtk-tool-button-get-use-underline">gtk_tool_button_get_use_underline</a>
(<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);
void <a href="GtkToolButton.html#gtk-tool-button-set-stock-id">gtk_tool_button_set_stock_id</a> (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkToolButton.html#gtk-tool-button-get-stock-id">gtk_tool_button_get_stock_id</a> (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);
void <a href="GtkToolButton.html#gtk-tool-button-set-icon-name">gtk_tool_button_set_icon_name</a> (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkToolButton.html#gtk-tool-button-get-icon-name">gtk_tool_button_get_icon_name</a> (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);
void <a href="GtkToolButton.html#gtk-tool-button-set-icon-widget">gtk_tool_button_set_icon_widget</a> (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *icon_widget);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkToolButton.html#gtk-tool-button-get-icon-widget">gtk_tool_button_get_icon_widget</a> (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);
void <a href="GtkToolButton.html#gtk-tool-button-set-label-widget">gtk_tool_button_set_label_widget</a>
(<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *label_widget);
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkToolButton.html#gtk-tool-button-get-label-widget">gtk_tool_button_get_label_widget</a>
(<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3338096"></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>
+----<a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>
+----GtkToolButton
+----<a href="GtkMenuToolButton.html" title="GtkMenuToolButton">GtkMenuToolButton</a>
+----<a href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3338181"></a><h2>Implemented Interfaces</h2>
<p>
GtkToolButton implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3338204"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkToolButton.html#GtkToolButton--icon-name">icon-name</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a href="GtkToolButton.html#GtkToolButton--icon-widget">icon-widget</a>" <a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> : Read / Write
"<a href="GtkToolButton.html#GtkToolButton--label">label</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a href="GtkToolButton.html#GtkToolButton--label-widget">label-widget</a>" <a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> : Read / Write
"<a href="GtkToolButton.html#GtkToolButton--stock-id">stock-id</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a href="GtkToolButton.html#GtkToolButton--use-underline">use-underline</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3338324"></a><h2>Style Properties</h2>
<pre class="synopsis">
"<a href="GtkToolButton.html#GtkToolButton--icon-spacing">icon-spacing</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3338358"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkToolButton.html#GtkToolButton-clicked">clicked</a>" void user_function (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *toolbutton,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first / Action
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3338408"></a><h2>Description</h2>
<p>
<a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>s are <span class="type">GtkToolItems</span> containing buttons.
</p>
<p>
Use <a href="GtkToolButton.html#gtk-tool-button-new"><code class="function">gtk_tool_button_new()</code></a> to create a new <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>. Use
<code class="function">gtk_tool_button_new_with_stock()</code> to create a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
containing a stock item.
</p>
<p>
The label of a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> is determined by the properties
"label_widget", "label", and "stock_id". If "label_widget" is
non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, then that widget is used as the label. Otherwise, if
"label" is non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, that string is used as the label. Otherwise, if
"stock_id" is non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, the label is determined by the stock
item. Otherwise, the button does not have a label.
</p>
<p>
The icon of a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> is determined by the properties
"icon_widget" and "stock_id". If "icon_widget" is non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, then
that widget is used as the icon. Otherwise, if "stock_id" is
non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, the icon is determined by the stock item. Otherwise,
the button does not have a label.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3338568"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3338578"></a><h3>
<a name="GtkToolButton-struct"></a>GtkToolButton</h3>
<a class="indexterm" name="id3338591"></a><pre class="programlisting">typedef struct _GtkToolButton GtkToolButton;</pre>
<p>
The <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> struct contains only private. It should only be
accessed with the function described below.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3338617"></a><h3>
<a name="gtk-tool-button-new"></a>gtk_tool_button_new ()</h3>
<a class="indexterm" name="id3338632"></a><pre class="programlisting"><a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>* gtk_tool_button_new (<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *icon_widget,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);</pre>
<p>
Creates a new <a href="GtkToolButton.html" title="GtkToolButton"><code class="literal">GtkToolButton</code></a> using <em class="parameter"><code>icon_widget</code></em> as icon and <em class="parameter"><code>label</code></em> as
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>icon_widget</code></em> :</span></td>
<td> a widget that will be used as icon widget, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>label</code></em> :</span></td>
<td> a string that will be used as label, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A new <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3338770"></a><h3>
<a name="gtk-tool-button-new-from-stock"></a>gtk_tool_button_new_from_stock ()</h3>
<a class="indexterm" name="id3338786"></a><pre class="programlisting"><a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>* gtk_tool_button_new_from_stock (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);</pre>
<p>
Creates a new <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> containing the image and text from a
stock item. Some stock ids have preprocessor macros like <a href="gtk-Stock-Items.html#GTK-STOCK-OK:CAPS"><span class="type">GTK_STOCK_OK</span></a>
and <a href="gtk-Stock-Items.html#GTK-STOCK-APPLY:CAPS"><span class="type">GTK_STOCK_APPLY</span></a>.
</p>
<p>
It is an error if <em class="parameter"><code>stock_id</code></em> is not a name of a stock item.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>stock_id</code></em> :</span></td>
<td> the name of the stock item
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A new <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3338896"></a><h3>
<a name="gtk-tool-button-set-label"></a>gtk_tool_button_set_label ()</h3>
<a class="indexterm" name="id3338911"></a><pre class="programlisting">void gtk_tool_button_set_label (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);</pre>
<p>
Sets <em class="parameter"><code>label</code></em> as the label used for the tool button. The "label" property
only has an effect if not overridden by a non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> "label_widget" property.
If both the "label_widget" and "label" properties are <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, the label
is determined by the "stock_id" property. If the "stock_id" property is also
<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, <em class="parameter"><code>button</code></em> will not have a 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>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>label</code></em> :</span></td>
<td> a string that will be used as label, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3339052"></a><h3>
<a name="gtk-tool-button-get-label"></a>gtk_tool_button_get_label ()</h3>
<a class="indexterm" name="id3339069"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_tool_button_get_label (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);</pre>
<p>
Returns the label used by the tool button, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if the tool button
doesn't have a label. or uses a the label from a stock item. The returned
string is owned by GTK+, and must not be modified or freed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The label, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3339166"></a><h3>
<a name="gtk-tool-button-set-use-underline"></a>gtk_tool_button_set_use_underline ()</h3>
<a class="indexterm" name="id3339182"></a><pre class="programlisting">void gtk_tool_button_set_use_underline
(<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> use_underline);</pre>
<p>
If set, an underline in the label property indicates that the next character
should be used for the mnemonic accelerator key in the overflow menu. For
example, if the label property is "_Open" and <em class="parameter"><code>use_underline</code></em> is <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>,
the label on the tool button will be "Open" and the item on the overflow
menu will have an underlined 'O'.
</p>
<p>
Labels shown on tool buttons never have mnemonics on them; this property
only affects the menu item on the overflow menu.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>use_underline</code></em> :</span></td>
<td> whether the button label has the form "_Open"
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3339294"></a><h3>
<a name="gtk-tool-button-get-use-underline"></a>gtk_tool_button_get_use_underline ()</h3>
<a class="indexterm" name="id3339311"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_tool_button_get_use_underline
(<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);</pre>
<p>
Returns whether underscores in the label property are used as mnemonics
on menu items on the overflow menu. See <a href="GtkToolButton.html#gtk-tool-button-set-use-underline"><code class="function">gtk_tool_button_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>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</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 underscores in the label property are used as
mnemonics on menu items on the overflow menu.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3339408"></a><h3>
<a name="gtk-tool-button-set-stock-id"></a>gtk_tool_button_set_stock_id ()</h3>
<a class="indexterm" name="id3339424"></a><pre class="programlisting">void gtk_tool_button_set_stock_id (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);</pre>
<p>
Sets the name of the stock item. See <a href="GtkToolButton.html#gtk-tool-button-new-from-stock"><code class="function">gtk_tool_button_new_from_stock()</code></a>.
The stock_id property only has an effect if not
overridden by non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> "label" and "icon_widget" properties.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>stock_id</code></em> :</span></td>
<td> a name of a stock item, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3339543"></a><h3>
<a name="gtk-tool-button-get-stock-id"></a>gtk_tool_button_get_stock_id ()</h3>
<a class="indexterm" name="id3339559"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_tool_button_get_stock_id (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);</pre>
<p>
Returns the name of the stock item. See <a href="GtkToolButton.html#gtk-tool-button-set-stock-id"><code class="function">gtk_tool_button_set_stock_id()</code></a>.
The returned string is owned by GTK+ and must not be freed or modifed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the name of the stock item for <em class="parameter"><code>button</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3339652"></a><h3>
<a name="gtk-tool-button-set-icon-name"></a>gtk_tool_button_set_icon_name ()</h3>
<a class="indexterm" name="id3339668"></a><pre class="programlisting">void gtk_tool_button_set_icon_name (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name);</pre>
<p>
Sets the icon for the tool button from a named themed icon.
See the docs for <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a> for more details.
The "icon_name" property only has an effect if not
overridden by non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> "label", "icon_widget" and "stock_id"
properties.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_name</code></em> :</span></td>
<td> the name of the themed icon
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.8
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3339774"></a><h3>
<a name="gtk-tool-button-get-icon-name"></a>gtk_tool_button_get_icon_name ()</h3>
<a class="indexterm" name="id3339790"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_tool_button_get_icon_name (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);</pre>
<p>
Returns the name of the themed icon for the tool button,
see <a href="GtkToolButton.html#gtk-tool-button-set-icon-name"><code class="function">gtk_tool_button_set_icon_name()</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>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the icon name or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if the tool button has
no themed icon
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.8
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3339887"></a><h3>
<a name="gtk-tool-button-set-icon-widget"></a>gtk_tool_button_set_icon_widget ()</h3>
<a class="indexterm" name="id3339903"></a><pre class="programlisting">void gtk_tool_button_set_icon_widget (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *icon_widget);</pre>
<p>
Sets <em class="parameter"><code>icon</code></em> as the widget used as icon on <em class="parameter"><code>button</code></em>. If <em class="parameter"><code>icon_widget</code></em> is
<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> the icon is determined by the "stock_id" property. If the
"stock_id" property is also <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, <em class="parameter"><code>button</code></em> will not have an icon.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_widget</code></em> :</span></td>
<td> the widget used as icon, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3340044"></a><h3>
<a name="gtk-tool-button-get-icon-widget"></a>gtk_tool_button_get_icon_widget ()</h3>
<a class="indexterm" name="id3340060"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_tool_button_get_icon_widget (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);</pre>
<p>
Return the widget used as icon widget on <em class="parameter"><code>button</code></em>. See
<a href="GtkToolButton.html#gtk-tool-button-set-icon-widget"><code class="function">gtk_tool_button_set_icon_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>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The widget used as icon on <em class="parameter"><code>button</code></em>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3340167"></a><h3>
<a name="gtk-tool-button-set-label-widget"></a>gtk_tool_button_set_label_widget ()</h3>
<a class="indexterm" name="id3340183"></a><pre class="programlisting">void gtk_tool_button_set_label_widget
(<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button,
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *label_widget);</pre>
<p>
Sets <em class="parameter"><code>label_widget</code></em> as the widget that will be used as the label
for <em class="parameter"><code>button</code></em>. If <em class="parameter"><code>label_widget</code></em> is <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> the "label" property is used
as label. If "label" is also <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, the label in the stock item
determined by the "stock_id" property is used as label. If
"stock_id" is also <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, <em class="parameter"><code>button</code></em> does not have a 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>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>label_widget</code></em> :</span></td>
<td> the widget used as label, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3340337"></a><h3>
<a name="gtk-tool-button-get-label-widget"></a>gtk_tool_button_get_label_widget ()</h3>
<a class="indexterm" name="id3340353"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_tool_button_get_label_widget
(<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *button);</pre>
<p>
Returns the widget used as label on <em class="parameter"><code>button</code></em>. See
<a href="GtkToolButton.html#gtk-tool-button-set-label-widget"><code class="function">gtk_tool_button_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>button</code></em> :</span></td>
<td> a <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The widget used as label on <em class="parameter"><code>button</code></em>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3340462"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3340472"></a><h3>
<a name="GtkToolButton--icon-name"></a>The "<code class="literal">icon-name</code>" property</h3>
<a class="indexterm" name="id3340489"></a><pre class="programlisting"> "icon-name" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>
The name of the themed icon displayed on the item.
This property only has an effect if not overridden by "label",
"icon_widget" or "stock_id" properties.</p>
<p>
</p>
<p>Default value: NULL</p>
<p>Since 2.8
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3340526"></a><h3>
<a name="GtkToolButton--icon-widget"></a>The "<code class="literal">icon-widget</code>" property</h3>
<a class="indexterm" name="id3340543"></a><pre class="programlisting"> "icon-widget" <a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> : Read / Write</pre>
<p>Icon widget to display in the item.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3340566"></a><h3>
<a name="GtkToolButton--label"></a>The "<code class="literal">label</code>" property</h3>
<a class="indexterm" name="id3340582"></a><pre class="programlisting"> "label" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>Text to show in the item.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3340608"></a><h3>
<a name="GtkToolButton--label-widget"></a>The "<code class="literal">label-widget</code>" property</h3>
<a class="indexterm" name="id3340625"></a><pre class="programlisting"> "label-widget" <a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> : Read / Write</pre>
<p>Widget to use as the item label.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3340648"></a><h3>
<a name="GtkToolButton--stock-id"></a>The "<code class="literal">stock-id</code>" property</h3>
<a class="indexterm" name="id3340664"></a><pre class="programlisting"> "stock-id" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>The stock icon displayed on the item.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3340691"></a><h3>
<a name="GtkToolButton--use-underline"></a>The "<code class="literal">use-underline</code>" property</h3>
<a class="indexterm" name="id3340708"></a><pre class="programlisting"> "use-underline" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>If set, an underline in the label property indicates that the next character should be used for the mnemonic accelerator key in the overflow menu.</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3340737"></a><h2>Style Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3340748"></a><h3>
<a name="GtkToolButton--icon-spacing"></a>The "<code class="literal">icon-spacing</code>" style property</h3>
<a class="indexterm" name="id3340765"></a><pre class="programlisting"> "icon-spacing" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>Spacing in pixels between the icon and label.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3340797"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3340808"></a><h3>
<a name="GtkToolButton-clicked"></a>The "clicked" signal</h3>
<a class="indexterm" name="id3340818"></a><pre class="programlisting">void user_function (<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a> *toolbutton,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first / Action</pre>
<p>
This signal is emitted when the tool button is clicked with the mouse
or activated with the keyboard.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>toolbutton</code></em> :</span></td>
<td> the object that emitted 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 class="refsect1" lang="en">
<a name="id3340894"></a><h2>See Also</h2>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a href="GtkToolbar.html" title="GtkToolbar"><span class="type">GtkToolbar</span></a></span></td>
<td><p>The toolbar widget</p></td>
</tr>
<tr>
<td>
<span class="term"><a href="GtkMenuToolButton.html" title="GtkMenuToolButton"><span class="type">GtkMenuToolButton</span></a></span></td>
<td><p>A subclass of <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> that displays on
the toolbar a button with an additional dropdown
menu</p></td>
</tr>
<tr>
<td>
<span class="term"><a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a></span></td>
<td><p>A subclass of <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> that displays toggle
buttons on the toolbar</p></td>
</tr>
<tr>
<td>
<span class="term"><a href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a></span></td>
<td><p>A subclass of <a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> that displays radio
buttons on the toolbar</p></td>
</tr>
<tr>
<td>
<span class="term"><a href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a></span></td>
<td><p>A subclass of <a href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> that separates groups of
items on a toolbar</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
</div>
</body>
</html>