|
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>GtkToggleToolButton</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="GtkMenuToolButton.html" title="GtkMenuToolButton">
<link rel="next" href="GtkRadioToolButton.html" title="GtkRadioToolButton">
<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="GtkMenuToolButton.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="GtkRadioToolButton.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="#id3347091" class="shortcut">Top</a>
 | 
<a href="#id3347399" class="shortcut">Description</a>
 | 
<a href="#id3347208" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3347294" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3347316" class="shortcut">Properties</a>
 | 
<a href="#id3347350" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkToggleToolButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3347091"></a><span class="refentrytitle">GtkToggleToolButton</span>
</h2>
<p>GtkToggleToolButton — A GtkToolItem containing a toggle button</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="GtkToggleToolButton.html#GtkToggleToolButton-struct">GtkToggleToolButton</a>;
<a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>* <a href="GtkToggleToolButton.html#gtk-toggle-tool-button-new">gtk_toggle_tool_button_new</a> (void);
<a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>* <a href="GtkToggleToolButton.html#gtk-toggle-tool-button-new-from-stock">gtk_toggle_tool_button_new_from_stock</a>
(const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id);
void <a href="GtkToggleToolButton.html#gtk-toggle-tool-button-set-active">gtk_toggle_tool_button_set_active</a>
(<a href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *button,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_active);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkToggleToolButton.html#gtk-toggle-tool-button-get-active">gtk_toggle_tool_button_get_active</a>
(<a href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *button);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3347208"></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>
+----<a href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a>
+----GtkToggleToolButton
+----<a href="GtkRadioToolButton.html" title="GtkRadioToolButton">GtkRadioToolButton</a>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3347294"></a><h2>Implemented Interfaces</h2>
<p>
GtkToggleToolButton implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3347316"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkToggleToolButton.html#GtkToggleToolButton--active">active</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3347350"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkToggleToolButton.html#GtkToggleToolButton-toggled">toggled</a>" void user_function (<a href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *toggle_tool_button,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3347399"></a><h2>Description</h2>
<p>
A <a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> is a <a href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> that contains a toggle
button.
</p>
<p>
Use <a href="GtkToggleToolButton.html#gtk-toggle-tool-button-new"><code class="function">gtk_toggle_tool_button_new()</code></a> to create a new
<a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>. Use <a href="GtkToggleToolButton.html#gtk-toggle-tool-button-new-from-stock"><code class="function">gtk_toggle_tool_button_new_from_stock()</code></a> to
create a new <a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> containing a stock item.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3347474"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3347484"></a><h3>
<a name="GtkToggleToolButton-struct"></a>GtkToggleToolButton</h3>
<a class="indexterm" name="id3347498"></a><pre class="programlisting">typedef struct _GtkToggleToolButton GtkToggleToolButton;</pre>
<p>
The <a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> struct contains only private data and
should only be accessed through the functions described below.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3347524"></a><h3>
<a name="gtk-toggle-tool-button-new"></a>gtk_toggle_tool_button_new ()</h3>
<a class="indexterm" name="id3347540"></a><pre class="programlisting"><a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>* gtk_toggle_tool_button_new (void);</pre>
<p>
Returns a new <a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a newly created <a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>
</td>
</tr></tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3347599"></a><h3>
<a name="gtk-toggle-tool-button-new-from-stock"></a>gtk_toggle_tool_button_new_from_stock ()</h3>
<a class="indexterm" name="id3347615"></a><pre class="programlisting"><a href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>* gtk_toggle_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="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</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="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3347727"></a><h3>
<a name="gtk-toggle-tool-button-set-active"></a>gtk_toggle_tool_button_set_active ()</h3>
<a class="indexterm" name="id3347743"></a><pre class="programlisting">void gtk_toggle_tool_button_set_active
(<a href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *button,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> is_active);</pre>
<p>
Sets the status of the toggle tool button. Set to <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if you
want the GtkToggleButton to be 'pressed in', and <a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> to raise it.
This action causes the toggled signal to be emitted.</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="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>is_active</code></em> :</span></td>
<td> whether <em class="parameter"><code>button</code></em> should be active
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3347856"></a><h3>
<a name="gtk-toggle-tool-button-get-active"></a>gtk_toggle_tool_button_get_active ()</h3>
<a class="indexterm" name="id3347873"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_toggle_tool_button_get_active
(<a href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *button);</pre>
<p>
Queries a <a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</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 toggle button is pressed in and <a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> if it is raised.</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="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</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 toggle tool button is pressed in, <a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> if not
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3347998"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3348009"></a><h3>
<a name="GtkToggleToolButton--active"></a>The "<code class="literal">active</code>" property</h3>
<a class="indexterm" name="id3348025"></a><pre class="programlisting"> "active" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>
If the toggle tool button should be pressed in or not.</p>
<p>
</p>
<p>Default value: FALSE</p>
<p>Since 2.8
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3348061"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3348072"></a><h3>
<a name="GtkToggleToolButton-toggled"></a>The "toggled" signal</h3>
<a class="indexterm" name="id3348082"></a><pre class="programlisting">void user_function (<a href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> *toggle_tool_button,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first</pre>
<p>
Emitted whenever the toggle tool button changes state.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>toggle_tool_button</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="id3348158"></a><h2>See Also</h2>
<p>
<dt>
<span class="term"><a href="GtkToolbar.html" title="GtkToolbar"><span class="type">GtkToolbar</span></a>, </span><span class="term"><a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>, </span><span class="term"><a href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a></span>
</dt><dd>
<p>The toolbar widget</p>
<p>
The parent class of <a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>. The properties
"label_widget", "label", "icon_widget", and "stock_id" on
<a href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a> determine the label and icon used on
<a href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a>s.
</p>
<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>
</dd>
</p>
</div>
</div>
</body>
</html>