49
49
<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle-struct" title="GtkCellRendererToggle">GtkCellRendererToggle</a>;
50
50
<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="returnvalue">GtkCellRenderer</span></a> * <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-new" title="gtk_cell_renderer_toggle_new ()">gtk_cell_renderer_toggle_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
51
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-get-radio" title="gtk_cell_renderer_toggle_get_radio ()">gtk_cell_renderer_toggle_get_radio</a> (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-get-radio" title="gtk_cell_renderer_toggle_get_radio ()">gtk_cell_renderer_toggle_get_radio</a> (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);
52
52
<span class="returnvalue">void</span> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-set-radio" title="gtk_cell_renderer_toggle_set_radio ()">gtk_cell_renderer_toggle_set_radio</a> (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>,
53
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> radio</code></em>);
54
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-get-active" title="gtk_cell_renderer_toggle_get_active ()">gtk_cell_renderer_toggle_get_active</a> (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);
53
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> radio</code></em>);
54
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-get-active" title="gtk_cell_renderer_toggle_get_active ()">gtk_cell_renderer_toggle_get_active</a> (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);
55
55
<span class="returnvalue">void</span> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-set-active" title="gtk_cell_renderer_toggle_set_active ()">gtk_cell_renderer_toggle_set_active</a> (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>,
56
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);
57
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-get-activatable" title="gtk_cell_renderer_toggle_get_activatable ()">gtk_cell_renderer_toggle_get_activatable</a>
56
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);
57
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-get-activatable" title="gtk_cell_renderer_toggle_get_activatable ()">gtk_cell_renderer_toggle_get_activatable</a>
58
58
(<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);
59
59
<span class="returnvalue">void</span> <a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-set-activatable" title="gtk_cell_renderer_toggle_set_activatable ()">gtk_cell_renderer_toggle_set_activatable</a>
60
60
(<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>,
61
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);
61
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);
64
64
<div class="refsect1" title="Object Hierarchy">
65
65
<a name="GtkCellRendererToggle.object-hierarchy"></a><h2>Object Hierarchy</h2>
66
66
<pre class="synopsis">
67
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
68
+----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
67
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
68
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
69
69
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
70
70
+----<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>
71
71
+----GtkCellRendererToggle
74
74
<div class="refsect1" title="Properties">
75
75
<a name="GtkCellRendererToggle.properties"></a><h2>Properties</h2>
76
76
<pre class="synopsis">
77
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--activatable" title='The "activatable" property'>activatable</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
78
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--active" title='The "active" property'>active</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
79
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--inconsistent" title='The "inconsistent" property'>inconsistent</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
80
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--indicator-size" title='The "indicator-size" property'>indicator-size</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
81
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--radio" title='The "radio" property'>radio</a>" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
77
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--activatable" title='The "activatable" property'>activatable</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
78
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--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
79
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--inconsistent" title='The "inconsistent" property'>inconsistent</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
80
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--indicator-size" title='The "indicator-size" property'>indicator-size</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
81
"<a class="link" href="GtkCellRendererToggle.html#GtkCellRendererToggle--radio" title='The "radio" property'>radio</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
84
84
<div class="refsect1" title="Signals">
112
112
Creates a new <a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>. Adjust rendering
113
113
parameters using object properties. Object properties can be set
114
globally (with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-set"><code class="function">g_object_set()</code></a>). Also, with <a class="link" href="GtkTreeViewColumn.html" title="GtkTreeViewColumn"><span class="type">GtkTreeViewColumn</span></a>, you
114
globally (with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-set"><code class="function">g_object_set()</code></a>). Also, with <a class="link" href="GtkTreeViewColumn.html" title="GtkTreeViewColumn"><span class="type">GtkTreeViewColumn</span></a>, you
115
115
can bind a property to a value in a <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>. For example, you
116
116
can bind the "active" property on the cell renderer to a boolean value
117
117
in the model, thus causing the check button to reflect the state of
130
130
<div class="refsect2" title="gtk_cell_renderer_toggle_get_radio ()">
131
131
<a name="gtk-cell-renderer-toggle-get-radio"></a><h3>gtk_cell_renderer_toggle_get_radio ()</h3>
132
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_toggle_get_radio (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);</pre>
132
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_toggle_get_radio (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);</pre>
134
134
Returns whether we're rendering radio toggles rather than checkboxes.
153
153
<div class="refsect2" title="gtk_cell_renderer_toggle_set_radio ()">
154
154
<a name="gtk-cell-renderer-toggle-set-radio"></a><h3>gtk_cell_renderer_toggle_set_radio ()</h3>
155
155
<pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_toggle_set_radio (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>,
156
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> radio</code></em>);</pre>
156
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> radio</code></em>);</pre>
158
If <em class="parameter"><code>radio</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the cell renderer renders a radio toggle
158
If <em class="parameter"><code>radio</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the cell renderer renders a radio toggle
159
159
(i.e. a toggle in a group of mutually-exclusive toggles).
160
If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, it renders a check toggle (a standalone boolean option).
160
If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, it renders a check toggle (a standalone boolean option).
161
161
This can be set globally for the cell renderer, or changed just
162
162
before rendering each cell in the model (for <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, you set
163
163
up a per-row setting using <a class="link" href="GtkTreeViewColumn.html" title="GtkTreeViewColumn"><span class="type">GtkTreeViewColumn</span></a> to associate model
184
184
<div class="refsect2" title="gtk_cell_renderer_toggle_get_active ()">
185
185
<a name="gtk-cell-renderer-toggle-get-active"></a><h3>gtk_cell_renderer_toggle_get_active ()</h3>
186
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_toggle_get_active (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);</pre>
186
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_toggle_get_active (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);</pre>
188
188
Returns whether the cell renderer is active. See
189
189
<a class="link" href="GtkCellRendererToggle.html#gtk-cell-renderer-toggle-set-active" title="gtk_cell_renderer_toggle_set_active ()"><code class="function">gtk_cell_renderer_toggle_set_active()</code></a>.
208
208
<div class="refsect2" title="gtk_cell_renderer_toggle_set_active ()">
209
209
<a name="gtk-cell-renderer-toggle-set-active"></a><h3>gtk_cell_renderer_toggle_set_active ()</h3>
210
210
<pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_toggle_set_active (<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>,
211
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);</pre>
211
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);</pre>
213
213
Activates or deactivates a cell renderer.
232
232
<div class="refsect2" title="gtk_cell_renderer_toggle_get_activatable ()">
233
233
<a name="gtk-cell-renderer-toggle-get-activatable"></a><h3>gtk_cell_renderer_toggle_get_activatable ()</h3>
234
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_toggle_get_activatable
234
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_toggle_get_activatable
235
235
(<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>);</pre>
237
237
Returns whether the cell renderer is activatable. See
260
260
<a name="gtk-cell-renderer-toggle-set-activatable"></a><h3>gtk_cell_renderer_toggle_set_activatable ()</h3>
261
261
<pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_toggle_set_activatable
262
262
(<em class="parameter"><code><a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *toggle</code></em>,
263
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);</pre>
263
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);</pre>
265
265
Makes the cell renderer activatable.
286
286
<a name="GtkCellRendererToggle.property-details"></a><h2>Property Details</h2>
287
287
<div class="refsect2" title='The "activatable" property'>
288
288
<a name="GtkCellRendererToggle--activatable"></a><h3>The <code class="literal">"activatable"</code> property</h3>
289
<pre class="programlisting"> "activatable" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
289
<pre class="programlisting"> "activatable" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
290
290
<p>The toggle button can be activated.</p>
291
291
<p>Default value: TRUE</p>
294
294
<div class="refsect2" title='The "active" property'>
295
295
<a name="GtkCellRendererToggle--active"></a><h3>The <code class="literal">"active"</code> property</h3>
296
<pre class="programlisting"> "active" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
296
<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>
297
297
<p>The toggle state of the button.</p>
298
298
<p>Default value: FALSE</p>
301
301
<div class="refsect2" title='The "inconsistent" property'>
302
302
<a name="GtkCellRendererToggle--inconsistent"></a><h3>The <code class="literal">"inconsistent"</code> property</h3>
303
<pre class="programlisting"> "inconsistent" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
303
<pre class="programlisting"> "inconsistent" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
304
304
<p>The inconsistent state of the button.</p>
305
305
<p>Default value: FALSE</p>
308
308
<div class="refsect2" title='The "indicator-size" property'>
309
309
<a name="GtkCellRendererToggle--indicator-size"></a><h3>The <code class="literal">"indicator-size"</code> property</h3>
310
<pre class="programlisting"> "indicator-size" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
310
<pre class="programlisting"> "indicator-size" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
311
311
<p>Size of check or radio indicator.</p>
312
312
<p>Allowed values: >= 0</p>
313
313
<p>Default value: 13</p>
316
316
<div class="refsect2" title='The "radio" property'>
317
317
<a name="GtkCellRendererToggle--radio"></a><h3>The <code class="literal">"radio"</code> property</h3>
318
<pre class="programlisting"> "radio" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
318
<pre class="programlisting"> "radio" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
319
319
<p>Draw the toggle button as a radio button.</p>
320
320
<p>Default value: FALSE</p>
325
325
<div class="refsect2" title='The "toggled" signal'>
326
326
<a name="GtkCellRendererToggle-toggled"></a><h3>The <code class="literal">"toggled"</code> signal</h3>
327
327
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a> *cell_renderer,
328
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path,
329
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
328
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path,
329
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre>
331
331
The ::toggled signal is emitted when the cell is toggled.