|
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 : /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>GtkCellRendererToggle</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="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="prev" href="GtkCellRendererText.html" title="GtkCellRendererText">
<link rel="next" href="GtkListStore.html" title="GtkListStore">
<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="GtkCellRendererText.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="TreeWidgetObjects.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="GtkListStore.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="#id3236002" class="shortcut">Top</a>
 | 
<a href="#id3236360" class="shortcut">Description</a>
 | 
<a href="#id3236152" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3236198" class="shortcut">Properties</a>
 | 
<a href="#id3236302" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkCellRendererToggle"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3236002"></a><span class="refentrytitle">GtkCellRendererToggle</span>
</h2>
<p>GtkCellRendererToggle — Renders a toggle button in a cell</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="GtkCellRendererToggle.html#GtkCellRendererToggle-struct">GtkCellRendererToggle</a>;
<a href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>* <a href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-new">gtk_cell_renderer_toggle_new</a>
(void);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-get-radio">gtk_cell_renderer_toggle_get_radio</a>
(<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *toggle);
void <a href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-set-radio">gtk_cell_renderer_toggle_set_radio</a>
(<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *toggle,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> radio);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-get-active">gtk_cell_renderer_toggle_get_active</a>
(<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *toggle);
void <a href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-set-active">gtk_cell_renderer_toggle_set_active</a>
(<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *toggle,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> setting);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3236152"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
+----<a href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>
+----GtkCellRendererToggle
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3236198"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GtkCellRendererToggle.html#GtkCellRendererToggle--activatable">activatable</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkCellRendererToggle.html#GtkCellRendererToggle--active">active</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkCellRendererToggle.html#GtkCellRendererToggle--inconsistent">inconsistent</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
"<a href="GtkCellRendererToggle.html#GtkCellRendererToggle--indicator-size">indicator-size</a>" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a href="GtkCellRendererToggle.html#GtkCellRendererToggle--radio">radio</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3236302"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkCellRendererToggle.html#GtkCellRendererToggle-toggled">toggled</a>" void user_function (<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *cell_renderer,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3236360"></a><h2>Description</h2>
<p>
<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> renders a toggle button in a cell. The
button is drawn as a radio- or checkbutton, depending on the
<a href="GtkCellRendererToggle.html#GtkCellRendererToggle--radio">radio</a>
property. When activated, it emits the toggled signal.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3236394"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3236405"></a><h3>
<a name="GtkCellRendererToggle-struct"></a>GtkCellRendererToggle</h3>
<a class="indexterm" name="id3236418"></a><pre class="programlisting">typedef struct _GtkCellRendererToggle GtkCellRendererToggle;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3236434"></a><h3>
<a name="gtk-cell-renderer-toggle-new"></a>gtk_cell_renderer_toggle_new ()</h3>
<a class="indexterm" name="id3236447"></a><pre class="programlisting"><a href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>* gtk_cell_renderer_toggle_new
(void);</pre>
<p>
Creates a new <a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>. Adjust rendering
parameters using object properties. Object properties can be set
globally (with <a
href="../gobject/gobject-The-Base-Object-Type.html#g-object-set"
><code class="function">g_object_set()</code></a>). Also, with <a href="GtkTreeViewColumn.html" title="GtkTreeViewColumn"><span class="type">GtkTreeViewColumn</span></a>, you
can bind a property to a value in a <a href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>. For example, you
can bind the "active" property on the cell renderer to a boolean value
in the model, thus causing the check button to reflect the state of
the model.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the new cell renderer
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3236528"></a><h3>
<a name="gtk-cell-renderer-toggle-get-radio"></a>gtk_cell_renderer_toggle_get_radio ()</h3>
<a class="indexterm" name="id3236543"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_cell_renderer_toggle_get_radio
(<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *toggle);</pre>
<p>
Returns whether we're rendering radio toggles rather than checkboxes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>toggle</code></em> :</span></td>
<td> a <a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if we're rendering radio toggles rather than checkboxes
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3236624"></a><h3>
<a name="gtk-cell-renderer-toggle-set-radio"></a>gtk_cell_renderer_toggle_set_radio ()</h3>
<a class="indexterm" name="id3236639"></a><pre class="programlisting">void gtk_cell_renderer_toggle_set_radio
(<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *toggle,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> radio);</pre>
<p>
If <em class="parameter"><code>radio</code></em> is <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>, the cell renderer renders a radio toggle
(i.e. a toggle in a group of mutually-exclusive toggles).
If <a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>, it renders a check toggle (a standalone boolean option).
This can be set globally for the cell renderer, or changed just
before rendering each cell in the model (for <a href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, you set
up a per-row setting using <a href="GtkTreeViewColumn.html" title="GtkTreeViewColumn"><span class="type">GtkTreeViewColumn</span></a> to associate model
columns with cell renderer properties).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>toggle</code></em> :</span></td>
<td> a <a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>radio</code></em> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> to make the toggle look like a radio button
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3236778"></a><h3>
<a name="gtk-cell-renderer-toggle-get-active"></a>gtk_cell_renderer_toggle_get_active ()</h3>
<a class="indexterm" name="id3236792"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_cell_renderer_toggle_get_active
(<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *toggle);</pre>
<p>
Returns whether the cell renderer is active. See
<a href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-set-active"><code class="function">gtk_cell_renderer_toggle_set_active()</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>toggle</code></em> :</span></td>
<td> a <a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the cell renderer is active.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3236884"></a><h3>
<a name="gtk-cell-renderer-toggle-set-active"></a>gtk_cell_renderer_toggle_set_active ()</h3>
<a class="indexterm" name="id3236898"></a><pre class="programlisting">void gtk_cell_renderer_toggle_set_active
(<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *toggle,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> setting);</pre>
<p>
Activates or deactivates a cell renderer.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>toggle</code></em> :</span></td>
<td> a <a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>setting</code></em> :</span></td>
<td> the value to set.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3236980"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3236991"></a><h3>
<a name="GtkCellRendererToggle--activatable"></a>The "<code class="literal">activatable</code>" property</h3>
<a class="indexterm" name="id3237008"></a><pre class="programlisting"> "activatable" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>The toggle button can be activated.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3237035"></a><h3>
<a name="GtkCellRendererToggle--active"></a>The "<code class="literal">active</code>" property</h3>
<a class="indexterm" name="id3237051"></a><pre class="programlisting"> "active" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>The toggle state of the button.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3237078"></a><h3>
<a name="GtkCellRendererToggle--inconsistent"></a>The "<code class="literal">inconsistent</code>" property</h3>
<a class="indexterm" name="id3237095"></a><pre class="programlisting"> "inconsistent" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>The inconsistent state of the button.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3237122"></a><h3>
<a name="GtkCellRendererToggle--indicator-size"></a>The "<code class="literal">indicator-size</code>" property</h3>
<a class="indexterm" name="id3237139"></a><pre class="programlisting"> "indicator-size" <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>Size of check or radio indicator.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 12</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3237169"></a><h3>
<a name="GtkCellRendererToggle--radio"></a>The "<code class="literal">radio</code>" property</h3>
<a class="indexterm" name="id3237186"></a><pre class="programlisting"> "radio" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> : Read / Write</pre>
<p>Draw the toggle button as a radio button.</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3237214"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id3237224"></a><h3>
<a name="GtkCellRendererToggle-toggled"></a>The "toggled" signal</h3>
<a class="indexterm" name="id3237235"></a><pre class="programlisting">void user_function (<a href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a> *cell_renderer,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
The ::toggled signal is emitted when the cell is toggled.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>cell_renderer</code></em> :</span></td>
<td> the object which received the signal
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>path</code></em> :</span></td>
<td> string representation of <a href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> describing the
event location
</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>
</div>
</div>
</div>
</body>
</html>