<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>GtkRadioToolButton: 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="GtkToggleToolButton.html" title="GtkToggleToolButton"> <link rel="next" href="GtkPopover.html" title="GtkPopover"> <meta name="generator" content="GTK-Doc V1.33.1 (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="#GtkRadioToolButton.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> <a href="#GtkRadioToolButton.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> <a href="#GtkRadioToolButton.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> <a href="#GtkRadioToolButton.properties" class="shortcut">Properties</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="GtkToggleToolButton.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="GtkPopover.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="GtkRadioToolButton"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="GtkRadioToolButton.top_of_page"></a>GtkRadioToolButton</span></h2> <p>GtkRadioToolButton — A toolbar item that contains a radio button</p> </td> <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> <a name="GtkRadioToolButton.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="GtkRadioToolButton.html#gtk-radio-tool-button-new" title="gtk_radio_tool_button_new ()">gtk_radio_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="GtkRadioToolButton.html#gtk-radio-tool-button-new-from-stock" title="gtk_radio_tool_button_new_from_stock ()">gtk_radio_tool_button_new_from_stock</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="GtkRadioToolButton.html#gtk-radio-tool-button-new-from-widget" title="gtk_radio_tool_button_new_from_widget ()">gtk_radio_tool_button_new_from_widget</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="GtkRadioToolButton.html#gtk-radio-tool-button-new-with-stock-from-widget" title="gtk_radio_tool_button_new_with_stock_from_widget ()">gtk_radio_tool_button_new_with_stock_from_widget</a> <span class="c_punctuation">()</span> </td> </tr> <tr> <td class="function_type"> <span class="returnvalue">GSList</span> * </td> <td class="function_name"> <a class="link" href="GtkRadioToolButton.html#gtk-radio-tool-button-get-group" title="gtk_radio_tool_button_get_group ()">gtk_radio_tool_button_get_group</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="GtkRadioToolButton.html#gtk-radio-tool-button-set-group" title="gtk_radio_tool_button_set_group ()">gtk_radio_tool_button_set_group</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> <div class="refsect1"> <a name="GtkRadioToolButton.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"> <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> *</td> <td class="property_name"><a class="link" href="GtkRadioToolButton.html#GtkRadioToolButton--group" title="The “group” property">group</a></td> <td class="property_flags">Write</td> </tr></tbody> </table></div> </div> <div class="refsect1"> <a name="GtkRadioToolButton.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="GtkRadioToolButton.html#GtkRadioToolButton-struct" title="struct GtkRadioToolButton">GtkRadioToolButton</a></td> </tr></tbody> </table></div> </div> <div class="refsect1"> <a name="GtkRadioToolButton.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> <a class="link" href="GtkToggleToolButton.html" title="GtkToggleToolButton">GtkToggleToolButton</a> <span class="lineart">╰──</span> GtkRadioToolButton </pre> </div> <div class="refsect1"> <a name="GtkRadioToolButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2> <p> GtkRadioToolButton 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="GtkRadioToolButton.includes"></a><h2>Includes</h2> <pre class="synopsis">#include <gtk/gtk.h> </pre> </div> <div class="refsect1"> <a name="GtkRadioToolButton.description"></a><h2>Description</h2> <p>A <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> is a <a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="type">GtkToolItem</span></a> that contains a radio button, that is, a button that is part of a group of toggle buttons where only one button can be active at a time.</p> <p>Use <a class="link" href="GtkRadioToolButton.html#gtk-radio-tool-button-new" title="gtk_radio_tool_button_new ()"><code class="function">gtk_radio_tool_button_new()</code></a> to create a new GtkRadioToolButton. Use <a class="link" href="GtkRadioToolButton.html#gtk-radio-tool-button-new-from-widget" title="gtk_radio_tool_button_new_from_widget ()"><code class="function">gtk_radio_tool_button_new_from_widget()</code></a> to create a new GtkRadioToolButton that is part of the same group as an existing GtkRadioToolButton.</p> <div class="refsect2"> <a name="id-1.3.13.19.9.4"></a><h3>CSS nodes</h3> <p>GtkRadioToolButton has a single CSS node with name toolbutton.</p> </div> </div> <div class="refsect1"> <a name="GtkRadioToolButton.functions_details"></a><h2>Functions</h2> <div class="refsect2"> <a name="gtk-radio-tool-button-new"></a><h3>gtk_radio_tool_button_new ()</h3> <pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> * gtk_radio_tool_button_new (<em class="parameter"><code><span class="type">GSList</span> *group</code></em>);</pre> <p>Creates a new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a>, adding it to <em class="parameter"><code>group</code></em> .</p> <div class="refsect3"> <a name="gtk-radio-tool-button-new.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>group</p></td> <td class="parameter_description"><p>An existing radio button group, or <code class="literal">NULL</code> if you are creating a new group. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkRadioButton]</span></td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-radio-tool-button-new.returns"></a><h4>Returns</h4> <p> The new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a></p> </div> <p class="since">Since: 2.4</p> </div> <hr> <div class="refsect2"> <a name="gtk-radio-tool-button-new-from-stock"></a><h3>gtk_radio_tool_button_new_from_stock ()</h3> <pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> * gtk_radio_tool_button_new_from_stock (<em class="parameter"><code><span class="type">GSList</span> *group</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>);</pre> <div class="warning"> <p><code class="literal">gtk_radio_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="GtkRadioToolButton.html#gtk-radio-tool-button-new" title="gtk_radio_tool_button_new ()"><code class="function">gtk_radio_tool_button_new()</code></a> instead.</p> </div> <p>Creates a new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a>, adding it to <em class="parameter"><code>group</code></em> . The new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> will contain an icon and label from the stock item indicated by <em class="parameter"><code>stock_id</code></em> .</p> <div class="refsect3"> <a name="gtk-radio-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>group</p></td> <td class="parameter_description"><p>an existing radio button group, or <code class="literal">NULL</code> if you are creating a new group. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkRadioButton]</span></td> </tr> <tr> <td class="parameter_name"><p>stock_id</p></td> <td class="parameter_description"><p>the name of a stock item</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-radio-tool-button-new-from-stock.returns"></a><h4>Returns</h4> <p> The new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a></p> </div> <p class="since">Since: 2.4</p> </div> <hr> <div class="refsect2"> <a name="gtk-radio-tool-button-new-from-widget"></a><h3>gtk_radio_tool_button_new_from_widget ()</h3> <pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> * gtk_radio_tool_button_new_from_widget (<em class="parameter"><code><a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> *group</code></em>);</pre> <p>Creates a new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> adding it to the same group as <em class="parameter"><code>gruup</code></em> </p> <p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p> <div class="refsect3"> <a name="gtk-radio-tool-button-new-from-widget.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>group</p></td> <td class="parameter_description"><p>An existing <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a>, or <code class="literal">NULL</code>. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-radio-tool-button-new-from-widget.returns"></a><h4>Returns</h4> <p>The new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a>. </p> <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> <p class="since">Since: 2.4</p> </div> <hr> <div class="refsect2"> <a name="gtk-radio-tool-button-new-with-stock-from-widget"></a><h3>gtk_radio_tool_button_new_with_stock_from_widget ()</h3> <pre class="programlisting"><a class="link" href="GtkToolItem.html" title="GtkToolItem"><span class="returnvalue">GtkToolItem</span></a> * gtk_radio_tool_button_new_with_stock_from_widget (<em class="parameter"><code><a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> *group</code></em>, <em class="parameter"><code>const <span class="type">gchar</span> *stock_id</code></em>);</pre> <div class="warning"> <p><code class="literal">gtk_radio_tool_button_new_with_stock_from_widget</code> has been deprecated since version 3.10 and should not be used in newly-written code.</p> <p>gtk_radio_tool_button_new_from_widget</p> </div> <p>Creates a new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> adding it to the same group as <em class="parameter"><code>group</code></em> . The new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> will contain an icon and label from the stock item indicated by <em class="parameter"><code>stock_id</code></em> .</p> <p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p> <div class="refsect3"> <a name="gtk-radio-tool-button-new-with-stock-from-widget.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>group</p></td> <td class="parameter_description"><p>An existing <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a>. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> </tr> <tr> <td class="parameter_name"><p>stock_id</p></td> <td class="parameter_description"><p>the name of a stock item</p></td> <td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-radio-tool-button-new-with-stock-from-widget.returns"></a><h4>Returns</h4> <p>A new <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a>. </p> <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> <p class="since">Since: 2.4</p> </div> <hr> <div class="refsect2"> <a name="gtk-radio-tool-button-get-group"></a><h3>gtk_radio_tool_button_get_group ()</h3> <pre class="programlisting"><span class="returnvalue">GSList</span> * gtk_radio_tool_button_get_group (<em class="parameter"><code><a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> *button</code></em>);</pre> <p>Returns the radio button group <em class="parameter"><code>button</code></em> belongs to.</p> <div class="refsect3"> <a name="gtk-radio-tool-button-get-group.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="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a></p></td> <td class="parameter_annotations"> </td> </tr></tbody> </table></div> </div> <div class="refsect3"> <a name="gtk-radio-tool-button-get-group.returns"></a><h4>Returns</h4> <p>The group <em class="parameter"><code>button</code></em> belongs to. </p> <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkRadioButton]</span></p> </div> <p class="since">Since: 2.4</p> </div> <hr> <div class="refsect2"> <a name="gtk-radio-tool-button-set-group"></a><h3>gtk_radio_tool_button_set_group ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> gtk_radio_tool_button_set_group (<em class="parameter"><code><a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> *button</code></em>, <em class="parameter"><code><span class="type">GSList</span> *group</code></em>);</pre> <p>Adds <em class="parameter"><code>button</code></em> to <em class="parameter"><code>group</code></em> , removing it from the group it belonged to before.</p> <div class="refsect3"> <a name="gtk-radio-tool-button-set-group.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="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> <td class="parameter_name"><p>group</p></td> <td class="parameter_description"><p>an existing radio button group, or <code class="literal">NULL</code>. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkRadioButton][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> </tr> </tbody> </table></div> </div> <p class="since">Since: 2.4</p> </div> </div> <div class="refsect1"> <a name="GtkRadioToolButton.other_details"></a><h2>Types and Values</h2> <div class="refsect2"> <a name="GtkRadioToolButton-struct"></a><h3>struct GtkRadioToolButton</h3> <pre class="programlisting">struct GtkRadioToolButton;</pre> </div> </div> <div class="refsect1"> <a name="GtkRadioToolButton.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="GtkRadioToolButton--group"></a><h3>The <code class="literal">“group”</code> property</h3> <pre class="programlisting"> “group” <a class="link" href="GtkRadioToolButton.html" title="GtkRadioToolButton"><span class="type">GtkRadioToolButton</span></a> *</pre> <p>Sets a new group for a radio tool button.</p> <p>Owner: GtkRadioToolButton</p> <p>Flags: Write</p> <p class="since">Since: 2.4</p> </div> </div> <div class="refsect1"> <a name="GtkRadioToolButton.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></p> </div> </div> <div class="footer"> <hr>Generated by GTK-Doc V1.33.1</div> </body> </html>