File: classGFC_1_1Gtk_1_1CellRendererToggle.html

package info (click to toggle)
gfcui 2.3.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 43,420 kB
  • ctags: 18,023
  • sloc: cpp: 53,967; sh: 31,555; makefile: 1,322; perl: 108
file content (306 lines) | stat: -rw-r--r-- 18,131 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <meta content="text/html; charset=ISO-8859-1"
 http-equiv="content-type">
  <title>GTK+ Foundation Classes</title>
  <link href="gfc.css" rel="stylesheet" type="text/css">
  <meta content="The GFC Development Team" name="author">
  <meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
 alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
 border="0" cellpadding="0" cellspacing="0">
  <tbody>
    <tr>
      <td
 style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
 alt="GFC Logo" src="../images/gfc.png"
 style="width: 207px; height: 92px;"></td>
      <td
 style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
 alt="GFC Title Logo" src="../images/gfc-title.png"
 style="width: 418px; height: 76px;"><br>
      </td>
    </tr>
    <tr>
      <td
 style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
 style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
      </td>
      <td
 style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
 style="font-family: helvetica,arial,sans-serif;"><a
 href="../html/index.html">Main Page</a>&nbsp; |&nbsp; <a
 href="../html/namespaces.html">Namespace List</a>&nbsp; |&nbsp; <a
 href="classes.html">Alphabetical List</a>&nbsp; |&nbsp; <a
 href="../html/annotated.html">Class List</a>&nbsp; |&nbsp; <a
 href="../html/files.html">File List</a></small><br>
      </td>
    </tr>
  </tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::CellRendererToggle Class Reference</h1>A GtkCellRendererToggle C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="cellrenderertoggle_8hh-source.html">gfc/gtk/cellrenderertoggle.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Gtk::CellRendererToggle:
<p><center><img src="classGFC_1_1Gtk_1_1CellRendererToggle.png" usemap="#GFC::Gtk::CellRendererToggle_map" border="0" alt=""></center>
<map name="GFC::Gtk::CellRendererToggle_map">
<area href="classGFC_1_1Gtk_1_1CellRenderer.html" alt="GFC::Gtk::CellRenderer" shape="rect" coords="0,224,181,248">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,181,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,181,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,181,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,181,24">
</map>
<a href="classGFC_1_1Gtk_1_1CellRendererToggle-members.html">List of all members.</a><h2>Property Prototypes</h2>
<ul>
<li><a class="anchor" name="z400_8" doxytag="GFC::Gtk::CellRendererToggle::active_property" ></a>
const ActivePropertyType <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z400_8">active_property</a>
<dl class="el"><dd class="mdescRight">The toggle state of the button (see <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z405_0">prop_active()</a>). <br></dl><li><a class="anchor" name="z400_9" doxytag="GFC::Gtk::CellRendererToggle::activatable_property" ></a>
const ActivatablePropertyType <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z400_9">activatable_property</a>
<dl class="el"><dd class="mdescRight">The toggle button can be activated (see <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z405_1">prop_activatable()</a>). <br></dl><li><a class="anchor" name="z400_10" doxytag="GFC::Gtk::CellRendererToggle::radio_property" ></a>
const RadioPropertyType <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z400_10">radio_property</a>
<dl class="el"><dd class="mdescRight">Draw the toggle button as a radio button (see <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z405_2">prop_radio()</a>). <br></dl><li><a class="anchor" name="z400_11" doxytag="GFC::Gtk::CellRendererToggle::inconsistent_property" ></a>
const InconsistentPropertyType <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z400_11">inconsistent_property</a>
<dl class="el"><dd class="mdescRight">The inconsistent state of the button (see <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z405_3">prop_inconsistent()</a>). <br></dl></ul>
<h2>Signal Prototypes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ToggledSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z401_2">toggled_signal</a>
<dl class="el"><dd class="mdescRight">Toggled signal (see <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z406_0">sig_toggled()</a>).  <a href="#z401_2"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z402_0">CellRendererToggle</a> ()
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html">CellRendererToggle</a>.  <a href="#z402_0"></a><br></dl><li><a class="anchor" name="z402_1" doxytag="GFC::Gtk::CellRendererToggle::~CellRendererToggle" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z402_1">~CellRendererToggle</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z403_0" doxytag="GFC::Gtk::CellRendererToggle::gtk_cell_renderer_toggle" ></a>
GtkCellRendererToggle * <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z403_0">gtk_cell_renderer_toggle</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkCellRendererToggle structure. <br></dl><li><a class="anchor" name="z403_1" doxytag="GFC::Gtk::CellRendererToggle::operator GtkCellRendererToggle *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z403_1">operator GtkCellRendererToggle *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html">CellRendererToggle</a> to a GtkCellRendererToggle pointer. <br></dl><li><a class="anchor" name="z403_2" doxytag="GFC::Gtk::CellRendererToggle::get_active" ></a>
bool <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z403_2">get_active</a> () const
<dl class="el"><dd class="mdescRight">Returns true if the cell renderer is active (see <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z404_0">set_active()</a>). <br></dl><li><a class="anchor" name="z403_3" doxytag="GFC::Gtk::CellRendererToggle::get_radio" ></a>
bool <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z403_3">get_radio</a> () const
<dl class="el"><dd class="mdescRight">Returns true if we're rendering radio toggles rather than checkboxes. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>void <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z404_0">set_active</a> (bool setting)
<dl class="el"><dd class="mdescRight">Activates or deactivates a cell renderer.  <a href="#z404_0"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z404_1">set_radio</a> (bool radio)
<dl class="el"><dd class="mdescRight">If radio is <em>true</em>, the cell renderer renders a radio toggle; if <em>false</em> it renders a check toggle.  <a href="#z404_1"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Property Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z405_0" doxytag="GFC::Gtk::CellRendererToggle::prop_active" ></a>
const ActivePropertyProxy <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z405_0">prop_active</a> ()
<dl class="el"><dd class="mdescRight">The toggle state of the button (bool : Read / Write). <br></dl><li><a class="anchor" name="z405_1" doxytag="GFC::Gtk::CellRendererToggle::prop_activatable" ></a>
const ActivatablePropertyProxy <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z405_1">prop_activatable</a> ()
<dl class="el"><dd class="mdescRight">The toggle button can be activated (bool : Read / Write). <br></dl><li><a class="anchor" name="z405_2" doxytag="GFC::Gtk::CellRendererToggle::prop_radio" ></a>
const RadioPropertyProxy <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z405_2">prop_radio</a> ()
<dl class="el"><dd class="mdescRight">Draw the toggle button as a radio button (bool : Read / Write). <br></dl><li><a class="anchor" name="z405_3" doxytag="GFC::Gtk::CellRendererToggle::prop_inconsistent" ></a>
const InconsistentPropertyProxy <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z405_3">prop_inconsistent</a> ()
<dl class="el"><dd class="mdescRight">The inconsistent state of the button (bool : Read / Write). <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z406_0" doxytag="GFC::Gtk::CellRendererToggle::sig_toggled" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">ToggledSignalProxy</a> <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z406_0">sig_toggled</a> ()
<dl class="el"><dd class="mdescRight">Connect to the toggled_signal; emitted when the state of the <a class="el" href="classGFC_1_1Gtk_1_1CellRenderer.html">CellRenderer</a> is changed. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z399_0">CellRendererToggle</a> (GtkCellRendererToggle *cell, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html">CellRendererToggle</a> from an existing GtkCellRendererToggle.  <a href="#z399_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkCellRendererToggle C++ wrapper class. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="z399_0" doxytag="GFC::Gtk::CellRendererToggle::CellRendererToggle" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> GFC::Gtk::CellRendererToggle::CellRendererToggle           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">GtkCellRendererToggle *&nbsp;</td>
          <td class="mdname" nowrap> <em>cell</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>bool&nbsp;</td>
          <td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [explicit, protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html">CellRendererToggle</a> from an existing GtkCellRendererToggle. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>cell</em>&nbsp;</td><td>A pointer to a GtkCellRendererToggle. </td></tr>
    <tr><td></td><td valign=top><em>owns_reference</em>&nbsp;</td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
  </table>
</dl>
<br>
The <em>cell</em> can be a newly created GtkCellRendererToggle or an existing GtkCellRendererToggle. (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>).     </td>
  </tr>
</table>
<a class="anchor" name="z402_0" doxytag="GFC::Gtk::CellRendererToggle::CellRendererToggle" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> GFC::Gtk::CellRendererToggle::CellRendererToggle           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html">CellRendererToggle</a>. 
<p>
Adjust rendering parameters using object properties. Also, with <a class="el" href="classGFC_1_1Gtk_1_1TreeViewColumn.html">TreeViewColumn</a>, you can bind a property to a value in a <a class="el" href="classGFC_1_1Gtk_1_1TreeModel.html">TreeModel</a>. For example, you can bind the "active" property on the cell renderer to a bool value in the model, thus causing the check button to reflect the state of the model.     </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z404_0" doxytag="GFC::Gtk::CellRendererToggle::set_active" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void GFC::Gtk::CellRendererToggle::set_active           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">bool&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>setting</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Activates or deactivates a cell renderer. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>setting</em>&nbsp;</td><td>The value to set. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z404_1" doxytag="GFC::Gtk::CellRendererToggle::set_radio" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void GFC::Gtk::CellRendererToggle::set_radio           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">bool&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>radio</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
If radio is <em>true</em>, the cell renderer renders a radio toggle; if <em>false</em> it renders a check toggle. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>radio</em>&nbsp;</td><td><em>true</em> to make the toggle look like a radio button.</td></tr>
  </table>
</dl>
<br>
This can be set globally for the cell renderer, or changed just before rendering each cell in the model (for <a class="el" href="classGFC_1_1Gtk_1_1TreeView.html">TreeView</a>, you set up a per-row setting using <a class="el" href="classGFC_1_1Gtk_1_1TreeViewColumn.html">TreeViewColumn</a> to associate model columns with cell renderer properties).     </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z401_2" doxytag="GFC::Gtk::CellRendererToggle::toggled_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">ToggledSignalType</a> <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z401_2">GFC::Gtk::CellRendererToggle::toggled_signal</a><code> [static, protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Toggled signal (see <a class="el" href="classGFC_1_1Gtk_1_1CellRendererToggle.html#z406_0">sig_toggled()</a>). 
<p>
Calls a slot with the signature: <div class="fragment"><pre>             <span class="keywordtype">void</span> function(<span class="keyword">const</span> String&amp; path);
             <span class="comment">// path: A widget-dependent string representation of the event location.</span>
</pre></div>    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cellrenderertoggle_8hh-source.html">cellrenderertoggle.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:38 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>