diff options
author | Leo Tenenbaum <pommicket@gmail.com> | 2018-08-20 21:12:06 -0400 |
---|---|---|
committer | Leo Tenenbaum <pommicket@gmail.com> | 2018-08-20 21:12:06 -0400 |
commit | 63e87c2d0c9d263f14c77b68f85c67d46ece82a9 (patch) | |
tree | 6260365cbf7d24f37d27669e8538227fcb72e243 /gtk+-mingw/share/gtk-doc/html/gtk3/GtkToggleAction.html | |
parent | a4460f6d9453bbd7e584937686449cef3e19f052 (diff) |
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gtk3/GtkToggleAction.html')
-rw-r--r-- | gtk+-mingw/share/gtk-doc/html/gtk3/GtkToggleAction.html | 314 |
1 files changed, 0 insertions, 314 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gtk3/GtkToggleAction.html b/gtk+-mingw/share/gtk-doc/html/gtk3/GtkToggleAction.html deleted file mode 100644 index f2f009f..0000000 --- a/gtk+-mingw/share/gtk-doc/html/gtk3/GtkToggleAction.html +++ /dev/null @@ -1,314 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>GtkToggleAction</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> -<link rel="home" href="index.html" title="GTK+ 3 Reference Manual"> -<link rel="up" href="Actions.html" title="Action-based menus and toolbars"> -<link rel="prev" href="GtkAction.html" title="GtkAction"> -<link rel="next" href="GtkRadioAction.html" title="GtkRadioAction"> -<meta name="generator" content="GTK-Doc V1.18.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="2"> -<tr valign="middle"> -<td><a accesskey="p" href="GtkAction.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+ 3 Reference Manual</th> -<td><a accesskey="n" href="GtkRadioAction.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#GtkToggleAction.synopsis" class="shortcut">Top</a> - | - <a href="#GtkToggleAction.description" class="shortcut">Description</a> - | - <a href="#GtkToggleAction.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#GtkToggleAction.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#GtkToggleAction.properties" class="shortcut">Properties</a> - | - <a href="#GtkToggleAction.signals" class="shortcut">Signals</a> -</td></tr> -</table> -<div class="refentry"> -<a name="GtkToggleAction"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="GtkToggleAction.top_of_page"></a>GtkToggleAction</span></h2> -<p>GtkToggleAction — An action which can be toggled between two states</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="GtkToggleAction.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <gtk/gtk.h> - -struct <a class="link" href="GtkToggleAction.html#GtkToggleAction-struct" title="struct GtkToggleAction">GtkToggleAction</a>; -<a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="returnvalue">GtkToggleAction</span></a> * <a class="link" href="GtkToggleAction.html#gtk-toggle-action-new" title="gtk_toggle_action_new ()">gtk_toggle_action_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>); -<span class="returnvalue">void</span> <a class="link" href="GtkToggleAction.html#gtk-toggle-action-toggled" title="gtk_toggle_action_toggled ()">gtk_toggle_action_toggled</a> (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>); -<span class="returnvalue">void</span> <a class="link" href="GtkToggleAction.html#gtk-toggle-action-set-active" title="gtk_toggle_action_set_active ()">gtk_toggle_action_set_active</a> (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_active</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkToggleAction.html#gtk-toggle-action-get-active" title="gtk_toggle_action_get_active ()">gtk_toggle_action_get_active</a> (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>); -<span class="returnvalue">void</span> <a class="link" href="GtkToggleAction.html#gtk-toggle-action-set-draw-as-radio" title="gtk_toggle_action_set_draw_as_radio ()">gtk_toggle_action_set_draw_as_radio</a> (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> draw_as_radio</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkToggleAction.html#gtk-toggle-action-get-draw-as-radio" title="gtk_toggle_action_get_draw_as_radio ()">gtk_toggle_action_get_draw_as_radio</a> (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="GtkToggleAction.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - +----<a class="link" href="GtkAction.html" title="GtkAction">GtkAction</a> - +----GtkToggleAction - +----<a class="link" href="GtkRadioAction.html" title="GtkRadioAction">GtkRadioAction</a> -</pre> -</div> -<div class="refsect1"> -<a name="GtkToggleAction.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -GtkToggleAction implements - <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p> -</div> -<div class="refsect1"> -<a name="GtkToggleAction.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="GtkToggleAction.html#GtkToggleAction--active" title='The "active" property'>active</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write - "<a class="link" href="GtkToggleAction.html#GtkToggleAction--draw-as-radio" title='The "draw-as-radio" property'>draw-as-radio</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write -</pre> -</div> -<div class="refsect1"> -<a name="GtkToggleAction.signals"></a><h2>Signals</h2> -<pre class="synopsis"> - "<a class="link" href="GtkToggleAction.html#GtkToggleAction-toggled" title='The "toggled" signal'>toggled</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a> -</pre> -</div> -<div class="refsect1"> -<a name="GtkToggleAction.description"></a><h2>Description</h2> -<p> -A <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> corresponds roughly to a <a class="link" href="GtkCheckMenuItem.html" title="GtkCheckMenuItem"><span class="type">GtkCheckMenuItem</span></a>. It has an -"active" state specifying whether the action has been checked or not. -</p> -</div> -<div class="refsect1"> -<a name="GtkToggleAction.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="GtkToggleAction-struct"></a><h3>struct GtkToggleAction</h3> -<pre class="programlisting">struct GtkToggleAction;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-toggle-action-new"></a><h3>gtk_toggle_action_new ()</h3> -<pre class="programlisting"><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="returnvalue">GtkToggleAction</span></a> * gtk_toggle_action_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tooltip</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock_id</code></em>);</pre> -<p> -Creates a new <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> object. To add the action to -a <a class="link" href="GtkActionGroup.html" title="GtkActionGroup"><span class="type">GtkActionGroup</span></a> and set the accelerator for the action, -call <a class="link" href="GtkActionGroup.html#gtk-action-group-add-action-with-accel" title="gtk_action_group_add_action_with_accel ()"><code class="function">gtk_action_group_add_action_with_accel()</code></a>. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>A unique name for the action</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td> -<td>The label displayed in menu items and on buttons, -or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <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><p><span class="term"><em class="parameter"><code>tooltip</code></em> :</span></p></td> -<td>A tooltip for the action, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <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><p><span class="term"><em class="parameter"><code>stock_id</code></em> :</span></p></td> -<td>The stock icon to display in widgets representing -the action, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a new <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.4</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-toggle-action-toggled"></a><h3>gtk_toggle_action_toggled ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gtk_toggle_action_toggled (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>);</pre> -<p> -Emits the "toggled" signal on the toggle action. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>the action object</td> -</tr></tbody> -</table></div> -<p class="since">Since 2.4</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-toggle-action-set-active"></a><h3>gtk_toggle_action_set_active ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gtk_toggle_action_set_active (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_active</code></em>);</pre> -<p> -Sets the checked state on the toggle action. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>the action object</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>is_active</code></em> :</span></p></td> -<td>whether the action should be checked or not</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.4</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-toggle-action-get-active"></a><h3>gtk_toggle_action_get_active ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_toggle_action_get_active (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>);</pre> -<p> -Returns the checked state of the toggle action. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>the action object</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the checked state of the toggle action</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.4</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-toggle-action-set-draw-as-radio"></a><h3>gtk_toggle_action_set_draw_as_radio ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gtk_toggle_action_set_draw_as_radio (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> draw_as_radio</code></em>);</pre> -<p> -Sets whether the action should have proxies like a radio action. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>the action object</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>draw_as_radio</code></em> :</span></p></td> -<td>whether the action should have proxies like a radio -action</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.4</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-toggle-action-get-draw-as-radio"></a><h3>gtk_toggle_action_get_draw_as_radio ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_toggle_action_get_draw_as_radio (<em class="parameter"><code><a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *action</code></em>);</pre> -<p> -Returns whether the action should have proxies like a radio action. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td> -<td>the action object</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>whether the action should have proxies like a radio action.</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.4</p> -</div> -</div> -<div class="refsect1"> -<a name="GtkToggleAction.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="GtkToggleAction--active"></a><h3>The <code class="literal">"active"</code> property</h3> -<pre class="programlisting"> "active" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre> -<p> -Whether the toggle action should be active. -</p> -<p>Default value: FALSE</p> -<p class="since">Since 2.10</p> -</div> -<hr> -<div class="refsect2"> -<a name="GtkToggleAction--draw-as-radio"></a><h3>The <code class="literal">"draw-as-radio"</code> property</h3> -<pre class="programlisting"> "draw-as-radio" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre> -<p> -Whether the proxies for this action look like radio action proxies. -</p> -<p> -This is an appearance property and thus only applies if -<a class="link" href="GtkActivatable.html#GtkActivatable--use-action-appearance" title='The "use-action-appearance" property'><span class="type">"use-action-appearance"</span></a> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. -</p> -<p>Default value: FALSE</p> -</div> -</div> -<div class="refsect1"> -<a name="GtkToggleAction.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="GtkToggleAction-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="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> *toggleaction, - <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre> -<p> -Should be connected if you wish to perform an action -whenever the <a class="link" href="GtkToggleAction.html" title="GtkToggleAction"><span class="type">GtkToggleAction</span></a> state is changed. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>toggleaction</code></em> :</span></p></td> -<td>the object which received the signal.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>user data set when the signal handler was connected.</td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file |