~ubuntu-branches/ubuntu/precise/gtk+2.0/precise-updates

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkToggleButton.html

  • Committer: Package Import Robot
  • Author(s): Ken VanDine
  • Date: 2011-12-01 11:40:06 UTC
  • mfrom: (1.14.11)
  • Revision ID: package-import@ubuntu.com-20111201114006-nrmf6qu3pg512veo
Tags: 2.24.8-0ubuntu1
* New upstream release 
  - gtkfilechooser should be more robust to malformed URIs
    in .gtk-bookmarks (LP: #189494)
* debian/patches/010_make_bg_changes_queue_repaint.patch
  - dropped it introduces performance regressions in some gtk2 
    apps (LP: #889019)
* 101_filechooser.patch, 000git_file_chooser.patch: dropped, upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ButtonWidgets.html" title="Buttons and Toggles">
9
9
<link rel="prev" href="GtkRadioButton.html" title="GtkRadioButton">
10
10
<link rel="next" href="GtkLinkButton.html" title="GtkLinkButton">
11
 
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
50
50
 
51
51
struct              <a class="link" href="GtkToggleButton.html#GtkToggleButton-struct" title="struct GtkToggleButton">GtkToggleButton</a>;
52
52
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkToggleButton.html#gtk-toggle-button-new" title="gtk_toggle_button_new ()">gtk_toggle_button_new</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
53
 
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkToggleButton.html#gtk-toggle-button-new-with-label" title="gtk_toggle_button_new_with_label ()">gtk_toggle_button_new_with_label</a>    (<em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);
54
 
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkToggleButton.html#gtk-toggle-button-new-with-mnemonic" title="gtk_toggle_button_new_with_mnemonic ()">gtk_toggle_button_new_with_mnemonic</a> (<em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);
 
53
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkToggleButton.html#gtk-toggle-button-new-with-label" title="gtk_toggle_button_new_with_label ()">gtk_toggle_button_new_with_label</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> *label</code></em>);
 
54
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkToggleButton.html#gtk-toggle-button-new-with-mnemonic" title="gtk_toggle_button_new_with_mnemonic ()">gtk_toggle_button_new_with_mnemonic</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> *label</code></em>);
55
55
<span class="returnvalue">void</span>                <a class="link" href="GtkToggleButton.html#gtk-toggle-button-set-mode" title="gtk_toggle_button_set_mode ()">gtk_toggle_button_set_mode</a>          (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> draw_indicator</code></em>);
57
 
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkToggleButton.html#gtk-toggle-button-get-mode" title="gtk_toggle_button_get_mode ()">gtk_toggle_button_get_mode</a>          (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);
 
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> draw_indicator</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="GtkToggleButton.html#gtk-toggle-button-get-mode" title="gtk_toggle_button_get_mode ()">gtk_toggle_button_get_mode</a>          (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);
58
58
#define             <a class="link" href="GtkToggleButton.html#gtk-toggle-button-set-state" title="gtk_toggle_button_set_state">gtk_toggle_button_set_state</a>
59
59
<span class="returnvalue">void</span>                <a class="link" href="GtkToggleButton.html#gtk-toggle-button-toggled" title="gtk_toggle_button_toggled ()">gtk_toggle_button_toggled</a>           (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);
60
 
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkToggleButton.html#gtk-toggle-button-get-active" title="gtk_toggle_button_get_active ()">gtk_toggle_button_get_active</a>        (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);
 
60
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkToggleButton.html#gtk-toggle-button-get-active" title="gtk_toggle_button_get_active ()">gtk_toggle_button_get_active</a>        (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);
61
61
<span class="returnvalue">void</span>                <a class="link" href="GtkToggleButton.html#gtk-toggle-button-set-active" title="gtk_toggle_button_set_active ()">gtk_toggle_button_set_active</a>        (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>,
62
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> is_active</code></em>);
63
 
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkToggleButton.html#gtk-toggle-button-get-inconsistent" title="gtk_toggle_button_get_inconsistent ()">gtk_toggle_button_get_inconsistent</a>  (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);
 
62
                                                         <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>);
 
63
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GtkToggleButton.html#gtk-toggle-button-get-inconsistent" title="gtk_toggle_button_get_inconsistent ()">gtk_toggle_button_get_inconsistent</a>  (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);
64
64
<span class="returnvalue">void</span>                <a class="link" href="GtkToggleButton.html#gtk-toggle-button-set-inconsistent" title="gtk_toggle_button_set_inconsistent ()">gtk_toggle_button_set_inconsistent</a>  (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>,
65
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> setting</code></em>);
 
65
                                                         <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>);
66
66
</pre>
67
67
</div>
68
68
<div class="refsect1">
69
69
<a name="GtkToggleButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
70
70
<pre class="synopsis">
71
 
  GObject
72
 
   +----GInitiallyUnowned
 
71
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
72
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
73
73
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
74
74
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
75
75
                     +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
88
88
<div class="refsect1">
89
89
<a name="GtkToggleButton.properties"></a><h2>Properties</h2>
90
90
<pre class="synopsis">
91
 
  "<a class="link" href="GtkToggleButton.html#GtkToggleButton--active" title='The "active" property'>active</a>"                   <span class="type">gboolean</span>              : Read / Write
92
 
  "<a class="link" href="GtkToggleButton.html#GtkToggleButton--draw-indicator" title='The "draw-indicator" property'>draw-indicator</a>"           <span class="type">gboolean</span>              : Read / Write
93
 
  "<a class="link" href="GtkToggleButton.html#GtkToggleButton--inconsistent" title='The "inconsistent" property'>inconsistent</a>"             <span class="type">gboolean</span>              : Read / Write
 
91
  "<a class="link" href="GtkToggleButton.html#GtkToggleButton--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
 
92
  "<a class="link" href="GtkToggleButton.html#GtkToggleButton--draw-indicator" title='The "draw-indicator" property'>draw-indicator</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
93
  "<a class="link" href="GtkToggleButton.html#GtkToggleButton--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
94
94
</pre>
95
95
</div>
96
96
<div class="refsect1">
97
97
<a name="GtkToggleButton.signals"></a><h2>Signals</h2>
98
98
<pre class="synopsis">
99
 
  "<a class="link" href="GtkToggleButton.html#GtkToggleButton-toggled" title='The "toggled" signal'>toggled</a>"                                        : <code class="literal">Run First</code>
 
99
  "<a class="link" href="GtkToggleButton.html#GtkToggleButton-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>
100
100
</pre>
101
101
</div>
102
102
<div class="refsect1">
121
121
To simply switch the state of a toggle button, use gtk_toggle_button_toggled.
122
122
</p>
123
123
<div class="example">
124
 
<a name="id804253"></a><p class="title"><b>Example 16. Creating two <span class="structname">GtkToggleButton</span> widgets.</b></p>
 
124
<a name="id796750"></a><p class="title"><b>Example 16. Creating two <span class="structname">GtkToggleButton</span> widgets.</b></p>
125
125
<div class="example-contents">
126
126
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
127
127
    <tbody>
149
149
<span class="normal">   dialog </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkDialog.html#gtk-dialog-new">gtk_dialog_new</a></span><span class="normal"> </span><span class="symbol">();</span>
150
150
<span class="normal">   toggle1 </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkToggleButton.html#gtk-toggle-button-new-with-label">gtk_toggle_button_new_with_label</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Hi, i'm a toggle button."</span><span class="symbol">);</span>
151
151
<span class="normal">   </span><span class="comment">/* Makes this toggle button invisible */</span>
152
 
<span class="normal">   </span><span class="function"><a href="GtkToggleButton.html#gtk-toggle-button-set-mode">gtk_toggle_button_set_mode</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_TOGGLE_BUTTON</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">toggle1</span><span class="symbol">),</span><span class="normal"> TRUE</span><span class="symbol">);</span>
153
 
<span class="normal">   </span><span class="function">g_signal_connect</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">toggle1</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"toggled"</span><span class="symbol">,</span>
154
 
<span class="normal">                     </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">output_state</span><span class="symbol">),</span><span class="normal"> <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span>
 
152
<span class="normal">   </span><span class="function"><a href="GtkToggleButton.html#gtk-toggle-button-set-mode">gtk_toggle_button_set_mode</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_TOGGLE_BUTTON</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">toggle1</span><span class="symbol">),</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">);</span>
 
153
<span class="normal">   </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">toggle1</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"toggled"</span><span class="symbol">,</span>
 
154
<span class="normal">                     </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">output_state</span><span class="symbol">),</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
155
155
<span class="normal">   </span><span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_DIALOG</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dialog</span><span class="symbol">)-&gt;</span><span class="normal">action_area</span><span class="symbol">),</span>
156
 
<span class="normal">                       toggle1</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
 
156
<span class="normal">                       toggle1</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
157
157
<span class="normal">   toggle2 </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkToggleButton.html#gtk-toggle-button-new-with-label">gtk_toggle_button_new_with_label</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Hi, i'm another toggle button."</span><span class="symbol">);</span>
158
 
<span class="normal">   </span><span class="function"><a href="GtkToggleButton.html#gtk-toggle-button-set-mode">gtk_toggle_button_set_mode</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_TOGGLE_BUTTON</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">toggle2</span><span class="symbol">),</span><span class="normal"> FALSE</span><span class="symbol">);</span>
159
 
<span class="normal">   </span><span class="function">g_signal_connect</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">toggle2</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"toggled"</span><span class="symbol">,</span>
160
 
<span class="normal">                     </span><span class="function">G_CALLBACK</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">output_state</span><span class="symbol">),</span><span class="normal"> <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span>
 
158
<span class="normal">   </span><span class="function"><a href="GtkToggleButton.html#gtk-toggle-button-set-mode">gtk_toggle_button_set_mode</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_TOGGLE_BUTTON</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">toggle2</span><span class="symbol">),</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">);</span>
 
159
<span class="normal">   </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">toggle2</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"toggled"</span><span class="symbol">,</span>
 
160
<span class="normal">                     </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">output_state</span><span class="symbol">),</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
161
161
<span class="normal">   </span><span class="function"><a href="GtkBox.html#gtk-box-pack-start">gtk_box_pack_start</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BOX</span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_DIALOG</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dialog</span><span class="symbol">)-&gt;</span><span class="normal">action_area</span><span class="symbol">),</span>
162
 
<span class="normal">                       toggle2</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> FALSE</span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
 
162
<span class="normal">                       toggle2</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">2</span><span class="symbol">);</span>
163
163
<span class="normal">   </span><span class="function"><a href="GtkWidget.html#gtk-widget-show-all">gtk_widget_show_all</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dialog</span><span class="symbol">);</span>
164
164
<span class="cbracket">}</span></pre></td>
165
165
      </tr>
197
197
<hr>
198
198
<div class="refsect2">
199
199
<a name="gtk-toggle-button-new-with-label"></a><h3>gtk_toggle_button_new_with_label ()</h3>
200
 
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_toggle_button_new_with_label    (<em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre>
 
200
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_toggle_button_new_with_label    (<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>);</pre>
201
201
<p>
202
202
Creates a new toggle button with a text label.
203
203
</p>
218
218
<hr>
219
219
<div class="refsect2">
220
220
<a name="gtk-toggle-button-new-with-mnemonic"></a><h3>gtk_toggle_button_new_with_mnemonic ()</h3>
221
 
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_toggle_button_new_with_mnemonic (<em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre>
 
221
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_toggle_button_new_with_mnemonic (<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>);</pre>
222
222
<p>
223
223
Creates a new <a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> containing a label. The label
224
224
will be created using <a class="link" href="GtkLabel.html#gtk-label-new-with-mnemonic" title="gtk_label_new_with_mnemonic ()"><code class="function">gtk_label_new_with_mnemonic()</code></a>, so underscores
244
244
<div class="refsect2">
245
245
<a name="gtk-toggle-button-set-mode"></a><h3>gtk_toggle_button_set_mode ()</h3>
246
246
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_toggle_button_set_mode          (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>,
247
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> draw_indicator</code></em>);</pre>
 
247
                                                         <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_indicator</code></em>);</pre>
248
248
<p>
249
249
Sets whether the button is displayed as a separate indicator and label.
250
250
You can call this function on a checkbutton or a radiobutton with
251
 
<em class="parameter"><code>draw_indicator</code></em> = <code class="literal">FALSE</code> to make the button look like a normal button
 
251
<em class="parameter"><code>draw_indicator</code></em> = <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to make the button look like a normal button
252
252
</p>
253
253
<p>
254
254
This function only affects instances of classes like <a class="link" href="GtkCheckButton.html" title="GtkCheckButton"><span class="type">GtkCheckButton</span></a>
265
265
</tr>
266
266
<tr>
267
267
<td><p><span class="term"><em class="parameter"><code>draw_indicator</code></em> :</span></p></td>
268
 
<td>if <code class="literal">TRUE</code>, draw the button as a separate indicator
269
 
and label; if <code class="literal">FALSE</code>, draw the button like a normal button</td>
 
268
<td>if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, draw the button as a separate indicator
 
269
and label; if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, draw the button like a normal button</td>
270
270
</tr>
271
271
</tbody>
272
272
</table></div>
274
274
<hr>
275
275
<div class="refsect2">
276
276
<a name="gtk-toggle-button-get-mode"></a><h3>gtk_toggle_button_get_mode ()</h3>
277
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_toggle_button_get_mode          (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);</pre>
 
277
<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_button_get_mode          (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);</pre>
278
278
<p>
279
279
Retrieves whether the button is displayed as a separate indicator
280
280
and label. See <a class="link" href="GtkToggleButton.html#gtk-toggle-button-set-mode" title="gtk_toggle_button_set_mode ()"><code class="function">gtk_toggle_button_set_mode()</code></a>.
290
290
<tr>
291
291
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
292
292
<td>
293
 
<code class="literal">TRUE</code> if the togglebutton is drawn as a separate indicator
 
293
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the togglebutton is drawn as a separate indicator
294
294
and label.</td>
295
295
</tr>
296
296
</tbody>
329
329
<hr>
330
330
<div class="refsect2">
331
331
<a name="gtk-toggle-button-get-active"></a><h3>gtk_toggle_button_get_active ()</h3>
332
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_toggle_button_get_active        (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);</pre>
 
332
<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_button_get_active        (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);</pre>
333
333
<p>
334
 
Queries a <a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> and returns its current state. Returns <code class="literal">TRUE</code> if
335
 
the toggle button is pressed in and <code class="literal">FALSE</code> if it is raised.
 
334
Queries a <a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> and returns its current state. Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if
 
335
the toggle button is pressed in and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is raised.
336
336
</p>
337
337
<div class="variablelist"><table border="0">
338
338
<col align="left" valign="top">
343
343
</tr>
344
344
<tr>
345
345
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
346
 
<td>a <span class="type">gboolean</span> value.</td>
 
346
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value.</td>
347
347
</tr>
348
348
</tbody>
349
349
</table></div>
352
352
<div class="refsect2">
353
353
<a name="gtk-toggle-button-set-active"></a><h3>gtk_toggle_button_set_active ()</h3>
354
354
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_toggle_button_set_active        (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>,
355
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> is_active</code></em>);</pre>
 
355
                                                         <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>
356
356
<p>
357
 
Sets the status of the toggle button. Set to <code class="literal">TRUE</code> if you want the
358
 
GtkToggleButton to be 'pressed in', and <code class="literal">FALSE</code> to raise it.
 
357
Sets the status of the toggle button. Set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if you want the
 
358
GtkToggleButton to be 'pressed in', and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to raise it.
359
359
This action causes the toggled signal to be emitted.
360
360
</p>
361
361
<div class="variablelist"><table border="0">
368
368
<tr>
369
369
<td><p><span class="term"><em class="parameter"><code>is_active</code></em> :</span></p></td>
370
370
<td>
371
 
<code class="literal">TRUE</code> or <code class="literal">FALSE</code>.</td>
 
371
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
372
372
</tr>
373
373
</tbody>
374
374
</table></div>
376
376
<hr>
377
377
<div class="refsect2">
378
378
<a name="gtk-toggle-button-get-inconsistent"></a><h3>gtk_toggle_button_get_inconsistent ()</h3>
379
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_toggle_button_get_inconsistent  (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);</pre>
 
379
<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_button_get_inconsistent  (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>);</pre>
380
380
<p>
381
381
Gets the value set by <a class="link" href="GtkToggleButton.html#gtk-toggle-button-set-inconsistent" title="gtk_toggle_button_set_inconsistent ()"><code class="function">gtk_toggle_button_set_inconsistent()</code></a>.
382
382
</p>
391
391
<tr>
392
392
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
393
393
<td>
394
 
<code class="literal">TRUE</code> if the button is displayed as inconsistent, <code class="literal">FALSE</code> otherwise</td>
 
394
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the button is displayed as inconsistent, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
395
395
</tr>
396
396
</tbody>
397
397
</table></div>
400
400
<div class="refsect2">
401
401
<a name="gtk-toggle-button-set-inconsistent"></a><h3>gtk_toggle_button_set_inconsistent ()</h3>
402
402
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_toggle_button_set_inconsistent  (<em class="parameter"><code><a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *toggle_button</code></em>,
403
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> setting</code></em>);</pre>
 
403
                                                         <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>
404
404
<p>
405
405
If the user has selected a range of elements (such as some text or
406
406
spreadsheet cells) that are affected by a toggle button, and the
422
422
<tr>
423
423
<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
424
424
<td>
425
 
<code class="literal">TRUE</code> if state is inconsistent</td>
 
425
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if state is inconsistent</td>
426
426
</tr>
427
427
</tbody>
428
428
</table></div>
432
432
<a name="GtkToggleButton.property-details"></a><h2>Property Details</h2>
433
433
<div class="refsect2">
434
434
<a name="GtkToggleButton--active"></a><h3>The <code class="literal">"active"</code> property</h3>
435
 
<pre class="programlisting">  "active"                   <span class="type">gboolean</span>              : Read / Write</pre>
 
435
<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>
436
436
<p>If the toggle button should be pressed in or not.</p>
437
437
<p>Default value: FALSE</p>
438
438
</div>
439
439
<hr>
440
440
<div class="refsect2">
441
441
<a name="GtkToggleButton--draw-indicator"></a><h3>The <code class="literal">"draw-indicator"</code> property</h3>
442
 
<pre class="programlisting">  "draw-indicator"           <span class="type">gboolean</span>              : Read / Write</pre>
 
442
<pre class="programlisting">  "draw-indicator"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
443
443
<p>If the toggle part of the button is displayed.</p>
444
444
<p>Default value: FALSE</p>
445
445
</div>
446
446
<hr>
447
447
<div class="refsect2">
448
448
<a name="GtkToggleButton--inconsistent"></a><h3>The <code class="literal">"inconsistent"</code> property</h3>
449
 
<pre class="programlisting">  "inconsistent"             <span class="type">gboolean</span>              : Read / Write</pre>
 
449
<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>
450
450
<p>If the toggle button is in an "in between" state.</p>
451
451
<p>Default value: FALSE</p>
452
452
</div>
456
456
<div class="refsect2">
457
457
<a name="GtkToggleButton-toggled"></a><h3>The <code class="literal">"toggled"</code> signal</h3>
458
458
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a> *togglebutton,
459
 
                                                        <span class="type">gpointer</span>         user_data)         : <code class="literal">Run First</code></pre>
 
459
                                                        <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>
460
460
<p>
461
461
Should be connected if you wish to perform an action whenever the
462
462
<a class="link" href="GtkToggleButton.html" title="GtkToggleButton"><span class="type">GtkToggleButton</span></a>'s state is changed.
503
503
</div>
504
504
<div class="footer">
505
505
<hr>
506
 
          Generated by GTK-Doc V1.17.1</div>
 
506
          Generated by GTK-Doc V1.17</div>
507
507
</body>
508
508
</html>
 
 
b'\\ No newline at end of file'