blob: 9800afa63e0141262f034268b7ebb86e613abbd0 (
plain)
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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtktoggletoolbutton">
<refnamediv>
<refname>gtk.ToggleToolButton</refname>
<refpurpose>A <link
linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
containing a toggle button (new in PyGTK 2.4)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.ToggleToolButton</classname></ooclass>
<ooclass><classname><link linkend="class-gtktoolbutton">gtk.ToolButton</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtktoggletoolbutton">gtk.ToggleToolButton</link></methodname>
<methodparam><parameter role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktoggletoolbutton--set-active">set_active</link></methodname>
<methodparam><parameter role="keyword">is_active</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktoggletoolbutton--get-active">get_active</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbin">gtk.Bin</link>
+-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
+-- <link linkend="class-gtktoolbutton">gtk.ToolButton</link>
+-- <link linkend="class-gtktoggletoolbutton">gtk.ToggleToolButton</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtktoggletoolbutton">
<title>gtk.ToggleToolButton Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para>
<para><link linkend="properties-gtktoolbutton">gtk.ToolButton Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="3.5in"/>
<tbody>
<row valign="top">
<entry>"active"</entry>
<entry>Read-Write</entry>
<entry>If the toggle tool button should be pressed in or not.
This property is available in GTK+ 2.8 and above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtktoggletoolbutton">
<title>gtk.ToggleToolButton Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtktoggletoolbutton">
<title>gtk.ToggleToolButton Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para>
<variablelist>
<varlistentry>
<term>"<link linkend="signal-gtktoggletoolbutton--toggled">toggled</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>toggletoolbutton</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<note>
<para>This widget is available in PyGTK 2.4 and above.</para>
</note>
<para>A <link
linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>
is a <link
linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> that
contains a toggle button. Use the <link
linkend="constructor-gtktoggletoolbutton">gtk.ToggleToolButton</link>()
constructor to create a new <link
linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>.</para>
</refsect1>
<refsect1 id="constructor-gtktoggletoolbutton">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.ToggleToolButton</methodname>
<methodparam><parameter role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">stock_id</parameter> :</term>
<listitem><simpara>the name of a stock item</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a newly created <link linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.4 and above.</para>
</note>
<para>Creates a new <link
linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>. If
<parameter>stock_id</parameter> is not <literal>None</literal> the toggle
tool button contains the image and text from the specified stock
item.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtktoggletoolbutton--set-active">
<title>gtk.ToggleToolButton.set_active</title>
<programlisting><methodsynopsis language="python">
<methodname>set_active</methodname>
<methodparam><parameter role="keyword">is_active</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter
role="keyword">is_active</parameter> :</term>
<listitem><simpara>if <literal>True</literal> the toggle tool
button is active</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>set_active</methodname>() method sets the status
of the toggle tool button to the value specified by
<parameter>is_active</parameter>. If <parameter>is_active</parameter> is
<literal>True</literal> the <link
linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>
is 'pressed in' (active). This method causes the toggled signal to be
emitted.</para>
</refsect2>
<refsect2 id="method-gtktoggletoolbutton--get-active">
<title>gtk.ToggleToolButton.get_active</title>
<programlisting><methodsynopsis language="python">
<methodname>get_active</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the toggle tool
button is pressed in (active)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>get_active</methodname>() method returns
<literal>True</literal> if the toggle tool button is pressed in (active) and
<literal>False</literal> if it is raised.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gtktoggletoolbutton--toggled">
<title>The "toggled" gtk.ToggleToolButton Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>toggletoolbutton</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>toggletoolbutton</parameter> :</term>
<listitem><simpara>the toggletoolbutton that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.4 and above.</para>
</note>
<para>The "toggled" signal is emitted when the toggle tool button
changes state.</para>
</refsect2>
</refsect1>
</refentry>
|
