callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
92d583e7df
gtk3/docs/reference/gtk/html/GtkToggleToolButton.html
Simon McVittie 92d583e7df New upstream version 3.24.24
2020-12-11 10:15:31 +00:00

361 lines
19 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkToggleToolButton: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 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.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#GtkToggleToolButton.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GtkToggleToolButton.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
<a href="#GtkToggleToolButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GtkToggleToolButton.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
<a href="#GtkToggleToolButton.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="MenusAndCombos.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkMenuToolButton.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkRadioToolButton.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkToggleToolButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkToggleToolButton.top_of_page"></a>GtkToggleToolButton</span></h2>
<p>GtkToggleToolButton — A GtkToolItem containing a toggle button</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkToggleToolButton.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-new" title="gtk_toggle_tool_button_new ()">gtk_toggle_tool_button_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-new-from-stock" title="gtk_toggle_tool_button_new_from_stock ()">gtk_toggle_tool_button_new_from_stock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-set-active" title="gtk_toggle_tool_button_set_active ()">gtk_toggle_tool_button_set_active</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-get-active" title="gtk_toggle_tool_button_get_active ()">gtk_toggle_tool_button_get_active</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkToggleToolButton.html#GtkToggleToolButton--active" title="The “active” property">active</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkToggleToolButton.html#GtkToggleToolButton-toggled" title="The “toggled” signal">toggled</a></td>
<td class="signal_flags">Run First</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkToggleToolButton.html#GtkToggleToolButton-struct" title="struct GtkToggleToolButton">GtkToggleToolButton</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkToggleToolButton.html#GtkToggleToolButtonClass" title="struct GtkToggleToolButtonClass">GtkToggleToolButtonClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
<span class="lineart">╰──</span> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
<span class="lineart">╰──</span> <a class="link" href="GtkToolItem.html" title="GtkToolItem">GtkToolItem</a>
<span class="lineart">╰──</span> <a class="link" href="GtkToolButton.html" title="GtkToolButton">GtkToolButton</a>
<span class="lineart">╰──</span> GtkToggleToolButton
<span class="lineart">╰──</span> <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton">GtkRadioToolButton</a>
</pre>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkToggleToolButton implements
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>, <a class="link" href="GtkActivatable.html" title="GtkActivatable">GtkActivatable</a> and <a class="link" href="GtkActionable.html" title="GtkActionable">GtkActionable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.description"></a><h2>Description</h2>
<p>A <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> is a <a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> that contains a toggle
button.</p>
<p>Use <a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-new" title="gtk_toggle_tool_button_new ()"><code class="function">gtk_toggle_tool_button_new()</code></a> to create a new GtkToggleToolButton.</p>
<div class="refsect2">
<a name="id-1.3.13.18.10.4"></a><h3>CSS nodes</h3>
<p>GtkToggleToolButton has a single CSS node with name togglebutton.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-toggle-tool-button-new"></a><h3>gtk_toggle_tool_button_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> *
gtk_toggle_tool_button_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns a new <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a></p>
<div class="refsect3">
<a name="gtk-toggle-tool-button-new.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a></p>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-toggle-tool-button-new-from-stock"></a><h3>gtk_toggle_tool_button_new_from_stock ()</h3>
<pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> *
gtk_toggle_tool_button_new_from_stock (<em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_toggle_tool_button_new_from_stock</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GtkToggleToolButton.html#gtk-toggle-tool-button-new" title="gtk_toggle_tool_button_new ()"><code class="function">gtk_toggle_tool_button_new()</code></a> instead.</p>
</div>
<p>Creates a new <a class="link" 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 class="link" href="gtk3-Stock-Items.html#GTK-STOCK-OK:CAPS" title="GTK_STOCK_OK"><span class="type">GTK_STOCK_OK</span></a>
and <a class="link" href="gtk3-Stock-Items.html#GTK-STOCK-APPLY:CAPS" title="GTK_STOCK_APPLY"><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>
<div class="refsect3">
<a name="gtk-toggle-tool-button-new-from-stock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>stock_id</p></td>
<td class="parameter_description"><p>the name of the stock item </p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-toggle-tool-button-new-from-stock.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a></p>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-toggle-tool-button-set-active"></a><h3>gtk_toggle_tool_button_set_active ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_toggle_tool_button_set_active (<em class="parameter"><code><a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> *button</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> is_active</code></em>);</pre>
<p>Sets the status of the toggle tool button. Set to <code class="literal">TRUE</code> if you
want the GtkToggleButton to be “pressed in”, and <code class="literal">FALSE</code> to raise it.
This action causes the toggled signal to be emitted.</p>
<div class="refsect3">
<a name="gtk-toggle-tool-button-set-active.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>button</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>is_active</p></td>
<td class="parameter_description"><p>whether <em class="parameter"><code>button</code></em>
should be active</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-toggle-tool-button-get-active"></a><h3>gtk_toggle_tool_button_get_active ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_toggle_tool_button_get_active (<em class="parameter"><code><a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> *button</code></em>);</pre>
<p>Queries a <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> and returns its current state.
Returns <code class="literal">TRUE</code> if the toggle button is pressed in and <code class="literal">FALSE</code> if it is raised.</p>
<div class="refsect3">
<a name="gtk-toggle-tool-button-get-active.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>button</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-toggle-tool-button-get-active.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the toggle tool button is pressed in, <code class="literal">FALSE</code> if not</p>
</div>
<p class="since">Since: 2.4</p>
</div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkToggleToolButton-struct"></a><h3>struct GtkToggleToolButton</h3>
<pre class="programlisting">struct GtkToggleToolButton;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkToggleToolButtonClass"></a><h3>struct GtkToggleToolButtonClass</h3>
<pre class="programlisting">struct GtkToggleToolButtonClass {
GtkToolButtonClass parent_class;
/* signal */
void (* toggled) (GtkToggleToolButton *button);
};
</pre>
<div class="refsect3">
<a name="GtkToggleToolButtonClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkToggleToolButtonClass.toggled"></a>toggled</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted whenever the toggle tool button changes state.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkToggleToolButton--active"></a><h3>The <code class="literal">“active”</code> property</h3>
<pre class="programlisting"> “active” <span class="type">gboolean</span></pre>
<p>If the toggle tool button should be pressed in.</p>
<p>Owner: GtkToggleToolButton</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: 2.8</p>
</div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkToggleToolButton-toggled"></a><h3>The <code class="literal">“toggled”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton"><span class="type">GtkToggleToolButton</span></a> *toggle_tool_button,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted whenever the toggle tool button changes state.</p>
<div class="refsect3">
<a name="GtkToggleToolButton-toggled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>toggle_tool_button</p></td>
<td class="parameter_description"><p>the object that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
</div>
</div>
<div class="refsect1">
<a name="GtkToggleToolButton.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkToolbar.html" title="GtkToolbar"><span class="type">GtkToolbar</span></a>, <a class="link" href="GtkToolButton.html" title="GtkToolButton"><span class="type">GtkToolButton</span></a>, <a class="link" href="GtkSeparatorToolItem.html" title="GtkSeparatorToolItem"><span class="type">GtkSeparatorToolItem</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink