|
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 : /proc/21585/root/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>GtkRadioAction</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="Actions.html" title="Action-based menus and toolbars">
<link rel="prev" href="GtkToggleAction.html" title="GtkToggleAction">
<link rel="next" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<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="GtkToggleAction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Actions.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="SelectorWidgets.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="#id3383667" class="shortcut">Top</a>
 | 
<a href="#id3384016" class="shortcut">Description</a>
 | 
<a href="#id3383851" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3383890" class="shortcut">Properties</a>
 | 
<a href="#id3383959" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkRadioAction"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3383667"></a><span class="refentrytitle">GtkRadioAction</span>
</h2>
<p>GtkRadioAction — An action of which only one in a group can be active</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="GtkRadioAction.html#GtkRadioAction-struct">GtkRadioAction</a>;
<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a>* <a href="GtkRadioAction.html#gtk-radio-action-new">gtk_radio_action_new</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> value);
<a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a>* <a href="GtkRadioAction.html#gtk-radio-action-get-group">gtk_radio_action_get_group</a> (<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action);
void <a href="GtkRadioAction.html#gtk-radio-action-set-group">gtk_radio_action_set_group</a> (<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action,
<a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *group);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkRadioAction.html#gtk-radio-action-get-current-value">gtk_radio_action_get_current_value</a>
(<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action);
void <a href="GtkRadioAction.html#gtk-radio-action-set-current-value">gtk_radio_action_set_current_value</a>
(<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> current_value);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3383851"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a href="GtkAction.html" title="GtkAction">GtkAction</a>
+----<a href="GtkToggleAction.html" title="GtkToggleAction">GtkToggleAction</a>
+----GtkRadioAction
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3383890"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkRadioAction.html#GtkRadioAction--current-value">current-value</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a href="GtkRadioAction.html#GtkRadioAction--group">group</a>" <a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> : Write
"<a href="GtkRadioAction.html#GtkRadioAction--value">value</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3383959"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkRadioAction.html#GtkRadioAction-changed">changed</a>" void user_function (<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action,
<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *current,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first / No recursion
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3384016"></a><h2>Description</h2>
<p>
A <a href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> is similar to <a href="GtkRadioMenuItem.html" title="GtkRadioMenuItem"><span class="type">GtkRadioMenuItem</span></a>. A number of radio
actions can be linked together so that only one may be active at any
one time.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3384049"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3384060"></a><h3>
<a name="GtkRadioAction-struct"></a>GtkRadioAction</h3>
<a class="indexterm" name="id3384073"></a><pre class="programlisting">typedef struct _GtkRadioAction GtkRadioAction;</pre>
<p>
The <span class="structname">GtkRadioAction</span> struct contains
only private members and should not be accessed directly.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3384094"></a><h3>
<a name="gtk-radio-action-new"></a>gtk_radio_action_new ()</h3>
<a class="indexterm" name="id3384109"></a><pre class="programlisting"><a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a>* gtk_radio_action_new (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *label,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *tooltip,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *stock_id,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> value);</pre>
<p>
Creates a new <a href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a> object. To add the action to
a <a href="GtkActionGroup.html" title="GtkActionGroup"><span class="type">GtkActionGroup</span></a> and set the accelerator for the action,
call <a href="GtkActionGroup.html#gtk-action-group-add-action-with-accel"><code class="function">gtk_action_group_add_action_with_accel()</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>name</code></em> :</span></td>
<td> A unique name for the action
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>label</code></em> :</span></td>
<td> The label displayed in menu items and on buttons
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>tooltip</code></em> :</span></td>
<td> A tooltip for this action
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>stock_id</code></em> :</span></td>
<td> The stock icon to display in widgets representing this action
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td> The value which <a href="GtkRadioAction.html#gtk-radio-action-get-current-value"><code class="function">gtk_radio_action_get_current_value()</code></a> should return
if this action is selected.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3384313"></a><h3>
<a name="gtk-radio-action-get-group"></a>gtk_radio_action_get_group ()</h3>
<a class="indexterm" name="id3384329"></a><pre class="programlisting"><a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a>* gtk_radio_action_get_group (<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action);</pre>
<p>
Returns the list representing the radio group for this object.
Note that the returned list is only valid until the next change
to the group.
</p>
<p>
A common way to set up a group of radio group is the following:
</p>
<div class="informalexample"><pre class="programlisting">
GSList *group = NULL;
GtkRadioAction *action;
while (/* more actions to add */)
{
action = gtk_radio_action_new (...);
gtk_radio_action_set_group (action, group);
group = gtk_radio_action_get_group (action);
}
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> the action object
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the list representing the radio group for this object
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3384416"></a><h3>
<a name="gtk-radio-action-set-group"></a>gtk_radio_action_set_group ()</h3>
<a class="indexterm" name="id3384432"></a><pre class="programlisting">void gtk_radio_action_set_group (<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action,
<a
href="../glib/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *group);</pre>
<p>
Sets the radio group for the radio action object.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> the action object
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>group</code></em> :</span></td>
<td> a list representing a radio group
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3384509"></a><h3>
<a name="gtk-radio-action-get-current-value"></a>gtk_radio_action_get_current_value ()</h3>
<a class="indexterm" name="id3384525"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_radio_action_get_current_value
(<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action);</pre>
<p>
Obtains the value property of the currently active member of
the group to which <em class="parameter"><code>action</code></em> belongs.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The value of the currently active group member
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3384606"></a><h3>
<a name="gtk-radio-action-set-current-value"></a>gtk_radio_action_set_current_value ()</h3>
<a class="indexterm" name="id3384623"></a><pre class="programlisting">void gtk_radio_action_set_current_value
(<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> current_value);</pre>
<p>
Sets the currently active group member to the member with value
property <em class="parameter"><code>current_value</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> a <a href="GtkRadioAction.html" title="GtkRadioAction"><span class="type">GtkRadioAction</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>current_value</code></em> :</span></td>
<td> the new value
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.10
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3384716"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3384727"></a><h3>
<a name="GtkRadioAction--current-value"></a>The "<code class="literal">current-value</code>" property</h3>
<a class="indexterm" name="id3384744"></a><pre class="programlisting"> "current-value" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>
The value property of the currently active member of the group to which
this action belongs.</p>
<p>
</p>
<p>Default value: 0</p>
<p>Since 2.10
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3384781"></a><h3>
<a name="GtkRadioAction--group"></a>The "<code class="literal">group</code>" property</h3>
<a class="indexterm" name="id3384797"></a><pre class="programlisting"> "group" <a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> : Write</pre>
<p>
Sets a new group for a radio action.</p>
<p>
</p>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3384829"></a><h3>
<a name="GtkRadioAction--value"></a>The "<code class="literal">value</code>" property</h3>
<a class="indexterm" name="id3384845"></a><pre class="programlisting"> "value" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>
The value is an arbitrary integer which can be used as a
convenient way to determine which action in the group is
currently active in an ::activate or ::changed signal handler.
See <a href="GtkRadioAction.html#gtk-radio-action-get-current-value"><code class="function">gtk_radio_action_get_current_value()</code></a> and <a href="GtkActionGroup.html#GtkRadioActionEntry"><span class="type">GtkRadioActionEntry</span></a>
for convenient ways to get and set this property.</p>
<p>
</p>
<p>Default value: 0</p>
<p>Since 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3384905"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3384916"></a><h3>
<a name="GtkRadioAction-changed"></a>The "changed" signal</h3>
<a class="indexterm" name="id3384926"></a><pre class="programlisting">void user_function (<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *action,
<a href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> *current,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run first / No recursion</pre>
<p>
The ::changed signal is emitted on every member of a radio group when the
active member is changed. The signal gets emitted after the ::activate signals
for the previous and current active members.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> the action on which the signal is emitted
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>current</code></em> :</span></td>
<td> the member of <em class="parameter"><code>action</code></em>s group which has just been activated
</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>
<p>Since 2.4
</p>
</div>
</div>
</div>
</body>
</html>