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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
<?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-gtkactivatable">
<refnamediv>
<refname>gtk.Activatable</refname>
<refpurpose>An interface for activatable widgets.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Activatable</classname></ooclass>
<ooclass><classname><link linkend="class-ginterface">gobject.GInterface</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkactivatable--do-set-related-action">do_set_related_action</link></methodname>
<methodparam><parameter role="keyword">action</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkactivatable--get-related-action">get_related_action</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkactivatable--get-use-action-appearence">get_use_action_appearence</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkactivatable--set-related-action">set_related_action</link></methodname>
<methodparam><parameter role="keyword">action</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkactivatable--set-use-action-appearence">set_use_action_appearence</link></methodname>
<methodparam><parameter role="keyword">use_appearence</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkactivatable--sync-action-properties">sync_action_properties</link></methodname>
<methodparam><parameter role="keyword">action</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-ginterface">gobject.GInterface</link>
+-- <link linkend="class-gtkactivatable">gtk.Activatable</link>
</synopsis>
</refsect1>
<refsect1 id="properties-gtkactivatable">
<title>gtk.Activatable Properties</title>
<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>"related-action"</entry>
<entry>Read/Write</entry>
<entry>
The action that this activatable will activate and receive updates from for various states and possibly appearance.
Note: <link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
implementors need to handle the "related-action" property and call
<methodname><link linkend="method-gtkactivatable--do-set-related-action">gtk.Activatable.do_set_related_action</link></methodname>()
when it changes. This property is available in GTK+ 2.16 and above.
</entry>
</row>
<row valign="top">
<entry>"use-action-appearance"</entry>
<entry>Read/Write</entry>
<entry>
Whether this activatable should reset its layout and appearance when setting the related
action or when the action changes appearance.
See the <link linkend="class-gtkaction"><classname>gtk.Action</classname></link> documentation
directly to find which properties should be ignored by the
<link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
when this property is <literal>False</literal>.
Note: <link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
implementors need to handle the "related-action" property and call
<methodname><link linkend="method-gtkactivatable--do-set-related-action">gtk.Activatable.do_set_related_action</link></methodname>()
when it changes. Default value: <literal>True</literal>. This property is available in GTK+ 2.16 and above.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1>
<title>Known Implementation</title>
<para>
<link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
is implementated by
<link linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link>,
<link linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>,
<link linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>,
<link linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>,
<link linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>,
<link linkend="class-gtktogglebutton"><classname>gtk.ToggleButton</classname></link>,
<link linkend="class-gtkseparatormenuitem"><classname>gtk.SeparatorMenuItem</classname></link>,
<link linkend="class-gtkimagemenuitem"><classname>gtk.ImageMenuItem</classname></link>,
<link linkend="class-gtkcheckbutton"><classname>gtk.CheckButton</classname></link>,
<link linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>,
<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link>,
<link linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>,
<link linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link>,
<link linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>,
<link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>,
<link linkend="class-gtkseparatortoolitem"><classname>gtk.SeparatorToolItem</classname></link>,
<link linkend="class-gtkcheckmenuitem"><classname>gtk.CheckMenuItem</classname></link>,
<link linkend="class-gtktoolbutton"><classname>gtk.ToolButton</classname></link>,
<link linkend="class-gtkfontbutton"><classname>gtkFontButton.</classname></link>,
<link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>,
<link linkend="class-gtktoggletoolbutton"><classname>gtk.ToggleToolButton</classname></link>,
<link linkend="class-gtkvolumebutton"><classname>gtk.VolumeButton</classname></link>,
<link linkend="class-gtkcolorbutton"><classname>gtk.ColorButton</classname></link>.
</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>
Activatable widgets can be connected to a
<link linkend="class-gtkaction"><classname>gtk.Action</classname></link>
and reflects the state of its action. A GtkActivatable can also provide
feedback through its action, as they are responsible for activating their related actions.
</para>
<para>
When extending a class that is already <link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
it is only necessary to implement the
<methodname><link linkend="method-gtkactivatable--do-sync-action-properties">gtk.Activatable.do_sync_action_properties</link></methodname> and
<methodname><link linkend="method-gtkactivatable--do-update">gtk.Activatable.do_update</link></methodname>()
class methods and chain up to the parent implementation, however when introducing a new
<link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
class the "related-action" and "use-action-appearance" properties need to be handled by the implementor.
Handling these properties is mostly a matter of installing the action pointer and boolean flag on your instance,
and calling
<methodname><link linkend="method-gtkactivatable--do-set-related-action">gtk.Activatable.do_set_related_action</link></methodname>() and
<methodname><link linkend="method-gtkactivatable--sync-action-properties">gtk.Activatable.sync_action_properties</link></methodname>()
at the appropriate times.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkactivatable--do-set-related-action">
<title>gtk.Activatable.do_set_related_action</title>
<programlisting><methodsynopsis language="python">
<methodname>do_set_related_action</methodname>
<methodparam><parameter>action</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">action</parameter> :</term>
<listitem><simpara>
the <link linkend="class-gtkaction"><classname>gtk.Action</classname></link> to set.
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<para>
The <methodname>do_set_related_action</methodname>() method is an
utility function for
<link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
implementors.
</para>
<para>
When implementing <link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
you must call this when handling changes of the "related-action", and you must also
use this to break references in GObject->dispose().
</para>
<para>
This function adds a reference to the currently set related action for you,
it also makes sure the GtkActivatable->update() method is called when the related
<link linkend="class-gtkaction"><classname>gtk.Action</classname></link>
properties change and registers to the action's proxy list.
</para>
<note>
Be careful to call this before setting the local copy of the
<link linkend="class-gtkaction"><classname>gtk.Action</classname></link>
property, since this function uses
<methodname><link linkend="method-gtkactivatable--get-related-action">gtk.Activatable.get_related_action</link></methodname>()
to retrieve the previous action
</note>
</refsect2>
<refsect2 id="method-gtkactivatable--get-related-action">
<title>gtk.Activatable.get_related_action</title>
<programlisting><methodsynopsis language="python">
<methodname>get_related_action</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the related <link linkend="class-gtkaction"><classname>gtk.Action</classname></link>
if one is set. </simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<para>
The <methodname>get_related_action</methodname>() method gets the related
<link linkend="class-gtkaction"><classname>gtk.Action</classname></link> for activatable.
</para>
</refsect2>
<refsect2 id="method-gtkactivatable--get-use-action-appearence">
<title>gtk.Activatable.get_use_action_appearence</title>
<programlisting><methodsynopsis language="python">
<methodname>get_use_action_appearence</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>whether activatable uses its actions appearance.
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<para>
The <methodname>get_use_action_appearence</methodname>() method gets whether
this activatable should reset its layout and appearance when setting the
related action or when the action changes appearance.
</para>
</refsect2>
<refsect2 id="method-gtkactivatable--set-related-action">
<title>gtk.Activatable.set_related_action</title>
<programlisting><methodsynopsis language="python">
<methodname>set_related_action</methodname>
<methodparam><parameter>action</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">action</parameter> :</term>
<listitem><simpara>the <link linkend="class-gtkaction"><classname>gtk.Action</classname></link> to set.
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<note>
<link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
implementors need to handle the "related-action" property and call
<methodname><link linkend="method-gtkactivatable--do-set-related-action">gtk.Activatable.do_set_related_action</link></methodname>()
when it changes.
</note>
<para>
The <methodname>set_related_action</methodname>() method sets the related action on the activatable object.
</para>
</refsect2>
<refsect2 id="method-gtkactivatable--set-use-action-appearence">
<title>gtk.Activatable.set_use_action_appearence</title>
<programlisting><methodsynopsis language="python">
<methodname>set_use_action_appearence</methodname>
<methodparam><parameter>use_appearence</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">use_appearence</parameter> :</term>
<listitem><simpara>whether to use the actions appearance.
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<note>
<link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link>
implementors need to handle the "related-action" property and call
<methodname><link linkend="method-gtkactivatable--do-set-related-action">gtk.Activatable.do_set_related_action</link></methodname>()
when it changes.
</note>
<para>
The <methodname>set_use_action_appearence</methodname>() method sets whether
this activatable should reset its layout and appearance when setting the
related action or when the action changes appearance
</para>
</refsect2>
<refsect2 id="method-gtkactivatable--sync-action-properties">
<title>gtk.Activatable.sync_action_properties</title>
<programlisting><methodsynopsis language="python">
<methodname>sync_action_properties</methodname>
<methodparam><parameter>action</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">action</parameter> :</term>
<listitem><simpara>the related <link linkend="class-gtkaction"><classname>gtk.Action</classname></link>
or <literal>None</literal>
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.16 and above.</para>
</note>
<para>
The <methodname>set_use_action_appearence</methodname>() method is called to
update the activatable completely, this is called internally when the "related-action"
property is set or unset and by the implementing class when "use-action-appearance" changes.
</para>
</refsect2>
</refsect1>
</refentry>
|
