diff options
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gtk3/GtkSwitch.html')
| -rw-r--r-- | gtk+-mingw/share/gtk-doc/html/gtk3/GtkSwitch.html | 236 |
1 files changed, 0 insertions, 236 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gtk3/GtkSwitch.html b/gtk+-mingw/share/gtk-doc/html/gtk3/GtkSwitch.html deleted file mode 100644 index 5b85387..0000000 --- a/gtk+-mingw/share/gtk-doc/html/gtk3/GtkSwitch.html +++ /dev/null @@ -1,236 +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>GtkSwitch</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="ButtonWidgets.html" title="Buttons and Toggles"> -<link rel="prev" href="GtkVolumeButton.html" title="GtkVolumeButton"> -<link rel="next" href="GtkLockButton.html" title="GtkLockButton"> -<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="GtkVolumeButton.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ButtonWidgets.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="GtkLockButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#GtkSwitch.synopsis" class="shortcut">Top</a> - | - <a href="#GtkSwitch.description" class="shortcut">Description</a> - | - <a href="#GtkSwitch.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#GtkSwitch.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#GtkSwitch.properties" class="shortcut">Properties</a> - | - <a href="#GtkSwitch.style-properties" class="shortcut">Style Properties</a> - | - <a href="#GtkSwitch.signals" class="shortcut">Signals</a> -</td></tr> -</table> -<div class="refentry"> -<a name="GtkSwitch"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="GtkSwitch.top_of_page"></a>GtkSwitch</span></h2> -<p>GtkSwitch — A "light switch" style toggle</p> -</td> -<td valign="top" align="right"><img src="switch.png"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="GtkSwitch.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <gtk/gtk.h> - -struct <a class="link" href="GtkSwitch.html#GtkSwitch-struct" title="struct GtkSwitch">GtkSwitch</a>; -<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkSwitch.html#gtk-switch-new" title="gtk_switch_new ()">gtk_switch_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); -<span class="returnvalue">void</span> <a class="link" href="GtkSwitch.html#gtk-switch-set-active" title="gtk_switch_set_active ()">gtk_switch_set_active</a> (<em class="parameter"><code><a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> *sw</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="GtkSwitch.html#gtk-switch-get-active" title="gtk_switch_get_active ()">gtk_switch_get_active</a> (<em class="parameter"><code><a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> *sw</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="GtkSwitch.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 href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> - +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> - +----GtkSwitch -</pre> -</div> -<div class="refsect1"> -<a name="GtkSwitch.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -GtkSwitch implements - AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>, <a class="link" href="GtkActionable.html" title="GtkActionable">GtkActionable</a> and <a class="link" href="GtkActivatable.html" title="GtkActivatable">GtkActivatable</a>.</p> -</div> -<div class="refsect1"> -<a name="GtkSwitch.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="GtkSwitch.html#GtkSwitch--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 -</pre> -</div> -<div class="refsect1"> -<a name="GtkSwitch.style-properties"></a><h2>Style Properties</h2> -<pre class="synopsis"> - "<a class="link" href="GtkSwitch.html#GtkSwitch--s-slider-width" title='The "slider-width" style property'>slider-width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read -</pre> -</div> -<div class="refsect1"> -<a name="GtkSwitch.signals"></a><h2>Signals</h2> -<pre class="synopsis"> - "<a class="link" href="GtkSwitch.html#GtkSwitch-activate" title='The "activate" signal'>activate</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a> -</pre> -</div> -<div class="refsect1"> -<a name="GtkSwitch.description"></a><h2>Description</h2> -<p> -<a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> is a widget that has two states: on or off. The user can control -which state should be active by clicking the empty area, or by dragging the -handle. -</p> -</div> -<div class="refsect1"> -<a name="GtkSwitch.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="GtkSwitch-struct"></a><h3>struct GtkSwitch</h3> -<pre class="programlisting">struct GtkSwitch;</pre> -<p> -The <span class="structname">GtkSwitch</span> structure contains private -data and it should only be accessed using the provided API. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-switch-new"></a><h3>gtk_switch_new ()</h3> -<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_switch_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p> -Creates a new <a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> widget. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody><tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the newly created <a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> instance</td> -</tr></tbody> -</table></div> -<p class="since">Since 3.0</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-switch-set-active"></a><h3>gtk_switch_set_active ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gtk_switch_set_active (<em class="parameter"><code><a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> *sw</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> -Changes the state of <em class="parameter"><code>sw</code></em> to the desired one. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>sw</code></em> :</span></p></td> -<td>a <a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>is_active</code></em> :</span></p></td> -<td> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>sw</code></em> should be active, and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 3.0</p> -</div> -<hr> -<div class="refsect2"> -<a name="gtk-switch-get-active"></a><h3>gtk_switch_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_switch_get_active (<em class="parameter"><code><a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> *sw</code></em>);</pre> -<p> -Gets whether the <a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> is in its "on" or "off" state. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>sw</code></em> :</span></p></td> -<td>a <a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> is active, and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 3.0</p> -</div> -</div> -<div class="refsect1"> -<a name="GtkSwitch.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="GtkSwitch--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 <a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> widget is in its on or off state. -</p> -<p>Default value: FALSE</p> -</div> -</div> -<div class="refsect1"> -<a name="GtkSwitch.style-property-details"></a><h2>Style Property Details</h2> -<div class="refsect2"> -<a name="GtkSwitch--s-slider-width"></a><h3>The <code class="literal">"slider-width"</code> style property</h3> -<pre class="programlisting"> "slider-width" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read</pre> -<p> -The minimum width of the <a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> handle, in pixels. -</p> -<p>Allowed values: >= 36</p> -<p>Default value: 36</p> -</div> -</div> -<div class="refsect1"> -<a name="GtkSwitch.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="GtkSwitch-activate"></a><h3>The <code class="literal">"activate"</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSwitch.html" title="GtkSwitch"><span class="type">GtkSwitch</span></a> *widget, - <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-ACTION:CAPS"><code class="literal">Action</code></a></pre> -<p> -The ::activate signal on GtkSwitch is an action signal and -emitting it causes the switch to animate. -Applications should never connect to this signal, but use the -notify::active signal. -</p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>widget</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 class="refsect1"> -<a name="GtkSwitch.see-also"></a><h2>See Also</h2> -<a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file |