atk 2.2.0-x86-mingw32 → 2.2.1-x86-mingw32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Rakefile +1 -1
- data/lib/2.0/atk.so +0 -0
- data/vendor/local/bin/libatk-1.0-0.dll +0 -0
- data/vendor/local/include/atk-1.0/atk/atk-enum-types.h +16 -0
- data/vendor/local/include/atk-1.0/atk/atk.h +3 -0
- data/vendor/local/include/atk-1.0/atk/atkaction.h +8 -1
- data/vendor/local/include/atk-1.0/atk/atkcomponent.h +20 -2
- data/vendor/local/include/atk-1.0/atk/atkdocument.h +29 -2
- data/vendor/local/include/atk-1.0/atk/atkeditabletext.h +8 -0
- data/vendor/local/include/atk-1.0/atk/atkgobjectaccessible.h +3 -0
- data/vendor/local/include/atk-1.0/atk/atkhyperlink.h +9 -1
- data/vendor/local/include/atk-1.0/atk/atkhyperlinkimpl.h +2 -0
- data/vendor/local/include/atk-1.0/atk/atkhypertext.h +4 -0
- data/vendor/local/include/atk-1.0/atk/atkimage.h +6 -0
- data/vendor/local/include/atk-1.0/atk/atkmisc.h +19 -19
- data/vendor/local/include/atk-1.0/atk/atknoopobject.h +4 -0
- data/vendor/local/include/atk-1.0/atk/atknoopobjectfactory.h +2 -0
- data/vendor/local/include/atk-1.0/atk/atkobject.h +133 -26
- data/vendor/local/include/atk-1.0/atk/atkobjectfactory.h +5 -0
- data/vendor/local/include/atk-1.0/atk/atkplug.h +5 -0
- data/vendor/local/include/atk-1.0/atk/atkrange.h +59 -0
- data/vendor/local/include/atk-1.0/atk/atkregistry.h +5 -15
- data/vendor/local/include/atk-1.0/atk/atkrelation.h +10 -0
- data/vendor/local/include/atk-1.0/atk/atkrelationset.h +10 -0
- data/vendor/local/include/atk-1.0/atk/atkselection.h +8 -0
- data/vendor/local/include/atk-1.0/atk/atksocket.h +6 -0
- data/vendor/local/include/atk-1.0/atk/atkstate.h +14 -2
- data/vendor/local/include/atk-1.0/atk/atkstateset.h +12 -0
- data/vendor/local/include/atk-1.0/atk/atkstreamablecontent.h +6 -1
- data/vendor/local/include/atk-1.0/atk/atktable.h +30 -6
- data/vendor/local/include/atk-1.0/atk/atktablecell.h +104 -0
- data/vendor/local/include/atk-1.0/atk/atktext.h +30 -5
- data/vendor/local/include/atk-1.0/atk/atkutil.h +35 -4
- data/vendor/local/include/atk-1.0/atk/atkvalue.h +88 -17
- data/vendor/local/include/atk-1.0/atk/atkversion.h +281 -2
- data/vendor/local/include/atk-1.0/atk/atkwindow.h +1 -0
- data/vendor/local/lib/girepository-1.0/Atk-1.0.typelib +0 -0
- data/vendor/local/lib/libatk-1.0.dll.a +0 -0
- data/vendor/local/lib/libatk-1.0.la +3 -3
- data/vendor/local/lib/pkgconfig/atk.pc +1 -1
- data/vendor/local/share/gir-1.0/Atk-1.0.gir +3410 -899
- data/vendor/local/share/gtk-doc/html/atk/AtkAction.html +343 -233
- data/vendor/local/share/gtk-doc/html/atk/AtkComponent.html +872 -578
- data/vendor/local/share/gtk-doc/html/atk/AtkDocument.html +558 -251
- data/vendor/local/share/gtk-doc/html/atk/AtkEditableText.html +298 -192
- data/vendor/local/share/gtk-doc/html/atk/AtkGObjectAccessible.html +117 -75
- data/vendor/local/share/gtk-doc/html/atk/AtkHyperlink.html +434 -273
- data/vendor/local/share/gtk-doc/html/atk/AtkHypertext.html +195 -119
- data/vendor/local/share/gtk-doc/html/atk/AtkImage.html +224 -143
- data/vendor/local/share/gtk-doc/html/atk/AtkMisc.html +191 -0
- data/vendor/local/share/gtk-doc/html/atk/AtkNoOpObject.html +83 -59
- data/vendor/local/share/gtk-doc/html/atk/AtkNoOpObjectFactory.html +66 -49
- data/vendor/local/share/gtk-doc/html/atk/AtkObject.html +2398 -1337
- data/vendor/local/share/gtk-doc/html/atk/AtkObjectFactory.html +154 -96
- data/vendor/local/share/gtk-doc/html/atk/AtkRegistry.html +192 -118
- data/vendor/local/share/gtk-doc/html/atk/AtkRelation.html +496 -278
- data/vendor/local/share/gtk-doc/html/atk/AtkRelationSet.html +294 -193
- data/vendor/local/share/gtk-doc/html/atk/AtkSelection.html +333 -201
- data/vendor/local/share/gtk-doc/html/atk/AtkStateSet.html +403 -256
- data/vendor/local/share/gtk-doc/html/atk/AtkStreamableContent.html +192 -130
- data/vendor/local/share/gtk-doc/html/atk/AtkTable.html +1363 -776
- data/vendor/local/share/gtk-doc/html/atk/AtkTableCell.html +497 -0
- data/vendor/local/share/gtk-doc/html/atk/AtkText.html +1975 -1446
- data/vendor/local/share/gtk-doc/html/atk/AtkUtil.html +862 -524
- data/vendor/local/share/gtk-doc/html/atk/AtkValue.html +638 -108
- data/vendor/local/share/gtk-doc/html/atk/AtkWindow.html +302 -175
- data/vendor/local/share/gtk-doc/html/atk/accessibles.html +49 -0
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-12.html +18 -18
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-13.html +21 -11
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-20.html +11 -11
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-22.html +10 -10
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-3.html +11 -11
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-30.html +15 -15
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-4.html +9 -9
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-6.html +11 -11
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-9.html +39 -0
- data/vendor/local/share/gtk-doc/html/atk/api-index-2-10.html +35 -0
- data/vendor/local/share/gtk-doc/html/atk/api-index-2-12.html +78 -0
- data/vendor/local/share/gtk-doc/html/atk/api-index-2-2.html +53 -0
- data/vendor/local/share/gtk-doc/html/atk/api-index-2-8.html +47 -0
- data/vendor/local/share/gtk-doc/html/atk/api-index-deprecated.html +75 -25
- data/vendor/local/share/gtk-doc/html/atk/api-index-full.html +358 -288
- data/vendor/local/share/gtk-doc/html/atk/atk-AtkHyperlinkImpl.html +82 -60
- data/vendor/local/share/gtk-doc/html/atk/atk-AtkPlug.html +99 -52
- data/vendor/local/share/gtk-doc/html/atk/atk-AtkRange.html +328 -0
- data/vendor/local/share/gtk-doc/html/atk/atk-AtkSocket.html +139 -91
- data/vendor/local/share/gtk-doc/html/atk/atk-AtkState.html +355 -226
- data/vendor/local/share/gtk-doc/html/atk/atk-Versioning-Utilities.html +203 -142
- data/vendor/local/share/gtk-doc/html/atk/atk.devhelp2 +378 -547
- data/vendor/local/share/gtk-doc/html/atk/atkobject.html +33 -0
- data/vendor/local/share/gtk-doc/html/atk/data.html +49 -0
- data/vendor/local/share/gtk-doc/html/atk/deprecated.html +33 -0
- data/vendor/local/share/gtk-doc/html/atk/index.html +70 -46
- data/vendor/local/share/gtk-doc/html/atk/index.sgml +419 -519
- data/vendor/local/share/gtk-doc/html/atk/{atk.html → interfaces.html} +17 -60
- data/vendor/local/share/gtk-doc/html/atk/overview.html +47 -0
- data/vendor/local/share/gtk-doc/html/atk/style.css +260 -105
- data/vendor/local/share/gtk-doc/html/atk/toolkit.html +33 -0
- data/vendor/local/share/gtk-doc/html/atk/utilities.html +28 -14
- data/vendor/local/share/license/atk/AUTHORS +18 -5
- data/vendor/local/share/locale/an/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/as/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/ca/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/ca@valencia/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/cs/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/da/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/de/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/el/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/es/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/eu/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/fi/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/fr/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/gl/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/he/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/hu/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/id/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/it/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/ko/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/lt/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/lv/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/nb/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/pa/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/pl/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/pt/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/pt_BR/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/ru/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/sk/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/sl/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/sr/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/sr@latin/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/zh_CN/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/zh_HK/LC_MESSAGES/atk10.mo +0 -0
- data/vendor/local/share/locale/zh_TW/LC_MESSAGES/atk10.mo +0 -0
- metadata +27 -19
- data/lib/1.9/atk.so +0 -0
- data/lib/2.1/atk.so +0 -0
- data/vendor/local/lib/atk-1.0.def +0 -248
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-18.html +0 -31
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-24.html +0 -31
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-26.html +0 -31
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-28.html +0 -31
- data/vendor/local/share/gtk-doc/html/atk/api-index-1-32.html +0 -30
@@ -2,28 +2,26 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
|
-
<title>AtkUtil</title>
|
6
|
-
<meta name="generator" content="DocBook XSL Stylesheets V1.
|
5
|
+
<title>ATK - Accessibility Toolkit: AtkUtil</title>
|
6
|
+
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
7
7
|
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
|
8
|
-
<link rel="up" href="
|
9
|
-
<link rel="prev" href="
|
10
|
-
<link rel="next" href="
|
11
|
-
<meta name="generator" content="GTK-Doc V1.
|
8
|
+
<link rel="up" href="toolkit.html" title="Event and toolkit support">
|
9
|
+
<link rel="prev" href="toolkit.html" title="Event and toolkit support">
|
10
|
+
<link rel="next" href="interfaces.html" title="ATK Interfaces">
|
11
|
+
<meta name="generator" content="GTK-Doc V1.21.1 (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">
|
15
|
-
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="
|
16
|
-
<td width="100%" align="left">
|
17
|
-
<a href="#" class="shortcut">Top</a>
|
18
|
-
|
19
|
-
<a href="#AtkUtil.
|
20
|
-
|
|
21
|
-
<a href="#AtkUtil.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
15
|
+
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
|
16
|
+
<td width="100%" align="left" class="shortcuts">
|
17
|
+
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
|
18
|
+
<a href="#AtkUtil.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
19
|
+
<a href="#AtkUtil.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
|
22
20
|
</td>
|
23
21
|
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
24
|
-
<td><a accesskey="u" href="
|
25
|
-
<td><a accesskey="p" href="
|
26
|
-
<td><a accesskey="n" href="
|
22
|
+
<td><a accesskey="u" href="toolkit.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
|
23
|
+
<td><a accesskey="p" href="toolkit.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
24
|
+
<td><a accesskey="n" href="interfaces.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
27
25
|
</tr></table>
|
28
26
|
<div class="refentry">
|
29
27
|
<a name="AtkUtil"></a><div class="titlepage"></div>
|
@@ -32,574 +30,642 @@
|
|
32
30
|
<h2><span class="refentrytitle"><a name="AtkUtil.top_of_page"></a>AtkUtil</span></h2>
|
33
31
|
<p>AtkUtil — A set of ATK utility functions for event and toolkit support.</p>
|
34
32
|
</td>
|
35
|
-
<td valign="top" align="right"></td>
|
33
|
+
<td class="gallery_image" valign="top" align="right"></td>
|
36
34
|
</tr></table></div>
|
37
|
-
<div class="refsynopsisdiv">
|
38
|
-
<a name="AtkUtil.synopsis"></a><h2>Synopsis</h2>
|
39
|
-
<pre class="synopsis">struct <a class="link" href="AtkUtil.html#AtkUtil-struct" title="struct AtkUtil">AtkUtil</a>;
|
40
|
-
enum <a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType">AtkCoordType</a>;
|
41
|
-
<span class="returnvalue">guint</span> <a class="link" href="AtkUtil.html#atk-add-focus-tracker" title="atk_add_focus_tracker ()">atk_add_focus_tracker</a> (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkEventListener" title="AtkEventListener ()"><span class="type">AtkEventListener</span></a> focus_tracker</code></em>);
|
42
|
-
<span class="returnvalue">void</span> <a class="link" href="AtkUtil.html#atk-remove-focus-tracker" title="atk_remove_focus_tracker ()">atk_remove_focus_tracker</a> (<em class="parameter"><code><span class="type">guint</span> tracker_id</code></em>);
|
43
|
-
<span class="returnvalue">void</span> <a class="link" href="AtkUtil.html#atk-focus-tracker-init" title="atk_focus_tracker_init ()">atk_focus_tracker_init</a> (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkEventListenerInit" title="AtkEventListenerInit ()"><span class="type">AtkEventListenerInit</span></a> init</code></em>);
|
44
|
-
<span class="returnvalue">void</span> <a class="link" href="AtkUtil.html#atk-focus-tracker-notify" title="atk_focus_tracker_notify ()">atk_focus_tracker_notify</a> (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>);
|
45
|
-
<span class="returnvalue">void</span> (<a class="link" href="AtkUtil.html#AtkEventListener" title="AtkEventListener ()">*AtkEventListener</a>) (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *obj</code></em>);
|
46
|
-
<span class="returnvalue">void</span> (<a class="link" href="AtkUtil.html#AtkEventListenerInit" title="AtkEventListenerInit ()">*AtkEventListenerInit</a>) (<em class="parameter"><code><span class="type">void</span></code></em>);
|
47
|
-
<span class="returnvalue">guint</span> <a class="link" href="AtkUtil.html#atk-add-global-event-listener" title="atk_add_global_event_listener ()">atk_add_global_event_listener</a> (<em class="parameter"><code><span class="type">GSignalEmissionHook</span> listener</code></em>,
|
48
|
-
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>);
|
49
|
-
<span class="returnvalue">void</span> <a class="link" href="AtkUtil.html#atk-remove-global-event-listener" title="atk_remove_global_event_listener ()">atk_remove_global_event_listener</a> (<em class="parameter"><code><span class="type">guint</span> listener_id</code></em>);
|
50
|
-
struct <a class="link" href="AtkUtil.html#AtkKeyEventStruct" title="struct AtkKeyEventStruct">AtkKeyEventStruct</a>;
|
51
|
-
enum <a class="link" href="AtkUtil.html#AtkKeyEventType" title="enum AtkKeyEventType">AtkKeyEventType</a>;
|
52
|
-
<span class="returnvalue">gint</span> (<a class="link" href="AtkUtil.html#AtkKeySnoopFunc" title="AtkKeySnoopFunc ()">*AtkKeySnoopFunc</a>) (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkKeyEventStruct" title="struct AtkKeyEventStruct"><span class="type">AtkKeyEventStruct</span></a> *event</code></em>,
|
53
|
-
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
|
54
|
-
<span class="returnvalue">guint</span> <a class="link" href="AtkUtil.html#atk-add-key-event-listener" title="atk_add_key_event_listener ()">atk_add_key_event_listener</a> (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkKeySnoopFunc" title="AtkKeySnoopFunc ()"><span class="type">AtkKeySnoopFunc</span></a> listener</code></em>,
|
55
|
-
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
|
56
|
-
<span class="returnvalue">void</span> <a class="link" href="AtkUtil.html#atk-remove-key-event-listener" title="atk_remove_key_event_listener ()">atk_remove_key_event_listener</a> (<em class="parameter"><code><span class="type">guint</span> listener_id</code></em>);
|
57
|
-
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> * <a class="link" href="AtkUtil.html#atk-get-root" title="atk_get_root ()">atk_get_root</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
|
58
|
-
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> * <a class="link" href="AtkUtil.html#atk-get-focus-object" title="atk_get_focus_object ()">atk_get_focus_object</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
|
59
|
-
const <span class="returnvalue">gchar</span> * <a class="link" href="AtkUtil.html#atk-get-toolkit-name" title="atk_get_toolkit_name ()">atk_get_toolkit_name</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
|
60
|
-
const <span class="returnvalue">gchar</span> * <a class="link" href="AtkUtil.html#atk-get-toolkit-version" title="atk_get_toolkit_version ()">atk_get_toolkit_version</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
|
61
|
-
const <span class="returnvalue">gchar</span> * <a class="link" href="AtkUtil.html#atk-get-version" title="atk_get_version ()">atk_get_version</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
|
62
|
-
#define <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE:CAPS" title="ATK_DEFINE_TYPE()">ATK_DEFINE_TYPE</a> (TN,
|
63
|
-
t_n,
|
64
|
-
T_P)
|
65
|
-
#define <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE-EXTENDED:CAPS" title="ATK_DEFINE_TYPE_EXTENDED()">ATK_DEFINE_TYPE_EXTENDED</a> (TN,
|
66
|
-
t_n,
|
67
|
-
T_P,
|
68
|
-
_f_,
|
69
|
-
_C_)
|
70
|
-
#define <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE-WITH-CODE:CAPS" title="ATK_DEFINE_TYPE_WITH_CODE()">ATK_DEFINE_TYPE_WITH_CODE</a> (TN,
|
71
|
-
t_n,
|
72
|
-
T_P,
|
73
|
-
_C_)
|
74
|
-
#define <a class="link" href="AtkUtil.html#ATK-DEFINE-ABSTRACT-TYPE:CAPS" title="ATK_DEFINE_ABSTRACT_TYPE()">ATK_DEFINE_ABSTRACT_TYPE</a> (TN,
|
75
|
-
t_n,
|
76
|
-
T_P)
|
77
|
-
#define <a class="link" href="AtkUtil.html#ATK-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS" title="ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE()">ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE</a> (TN,
|
78
|
-
t_n,
|
79
|
-
T_P,
|
80
|
-
_C_)
|
81
|
-
</pre>
|
82
|
-
</div>
|
83
|
-
<div class="refsect1">
|
84
|
-
<a name="AtkUtil.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
85
|
-
<pre class="synopsis">
|
86
|
-
GObject
|
87
|
-
+----AtkUtil
|
88
|
-
</pre>
|
89
|
-
</div>
|
90
|
-
<div class="refsect1">
|
91
|
-
<a name="AtkUtil.description"></a><h2>Description</h2>
|
92
|
-
<p>
|
93
|
-
A set of ATK utility functions which are used to support event
|
94
|
-
registration of various types, and obtaining the 'root' accessible
|
95
|
-
of a process and information about the current ATK implementation
|
96
|
-
and toolkit version.
|
97
|
-
</p>
|
98
|
-
</div>
|
99
35
|
<div class="refsect1">
|
100
|
-
<a name="AtkUtil.
|
101
|
-
<div class="
|
102
|
-
<
|
103
|
-
<
|
104
|
-
<
|
105
|
-
</
|
106
|
-
</div>
|
107
|
-
<hr>
|
108
|
-
<div class="refsect2">
|
109
|
-
<a name="AtkCoordType"></a><h3>enum AtkCoordType</h3>
|
110
|
-
<pre class="programlisting">typedef enum {
|
111
|
-
ATK_XY_SCREEN,
|
112
|
-
ATK_XY_WINDOW
|
113
|
-
} AtkCoordType;
|
114
|
-
</pre>
|
115
|
-
<p>
|
116
|
-
Specifies how xy coordinates are to be interpreted. Used by functions such
|
117
|
-
as <a class="link" href="AtkComponent.html#atk-component-get-position" title="atk_component_get_position ()"><code class="function">atk_component_get_position()</code></a> and <a class="link" href="AtkText.html#atk-text-get-character-extents" title="atk_text_get_character_extents ()"><code class="function">atk_text_get_character_extents()</code></a>
|
118
|
-
</p>
|
119
|
-
<div class="variablelist"><table border="0">
|
120
|
-
<col align="left" valign="top">
|
36
|
+
<a name="AtkUtil.functions"></a><h2>Functions</h2>
|
37
|
+
<div class="informaltable"><table width="100%" border="0">
|
38
|
+
<colgroup>
|
39
|
+
<col width="150px" class="functions_return">
|
40
|
+
<col class="functions_name">
|
41
|
+
</colgroup>
|
121
42
|
<tbody>
|
122
43
|
<tr>
|
123
|
-
<td
|
124
|
-
<
|
44
|
+
<td class="function_type">
|
45
|
+
<span class="returnvalue">guint</span>
|
46
|
+
</td>
|
47
|
+
<td class="function_name">
|
48
|
+
<a class="link" href="AtkUtil.html#atk-add-focus-tracker" title="atk_add_focus_tracker ()">atk_add_focus_tracker</a> <span class="c_punctuation">()</span>
|
49
|
+
</td>
|
50
|
+
</tr>
|
51
|
+
<tr>
|
52
|
+
<td class="function_type">
|
53
|
+
<span class="returnvalue">void</span>
|
54
|
+
</td>
|
55
|
+
<td class="function_name">
|
56
|
+
<a class="link" href="AtkUtil.html#atk-remove-focus-tracker" title="atk_remove_focus_tracker ()">atk_remove_focus_tracker</a> <span class="c_punctuation">()</span>
|
57
|
+
</td>
|
58
|
+
</tr>
|
59
|
+
<tr>
|
60
|
+
<td class="function_type">
|
61
|
+
<span class="returnvalue">void</span>
|
62
|
+
</td>
|
63
|
+
<td class="function_name">
|
64
|
+
<a class="link" href="AtkUtil.html#atk-focus-tracker-init" title="atk_focus_tracker_init ()">atk_focus_tracker_init</a> <span class="c_punctuation">()</span>
|
65
|
+
</td>
|
66
|
+
</tr>
|
67
|
+
<tr>
|
68
|
+
<td class="function_type">
|
69
|
+
<span class="returnvalue">void</span>
|
70
|
+
</td>
|
71
|
+
<td class="function_name">
|
72
|
+
<a class="link" href="AtkUtil.html#atk-focus-tracker-notify" title="atk_focus_tracker_notify ()">atk_focus_tracker_notify</a> <span class="c_punctuation">()</span>
|
73
|
+
</td>
|
74
|
+
</tr>
|
75
|
+
<tr>
|
76
|
+
<td class="function_type">
|
77
|
+
<span class="returnvalue">void</span>
|
78
|
+
</td>
|
79
|
+
<td class="function_name">
|
80
|
+
<span class="c_punctuation">(</span><a class="link" href="AtkUtil.html#AtkEventListener" title="AtkEventListener ()">*AtkEventListener</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
|
81
|
+
</td>
|
82
|
+
</tr>
|
83
|
+
<tr>
|
84
|
+
<td class="function_type">
|
85
|
+
<span class="returnvalue">void</span>
|
86
|
+
</td>
|
87
|
+
<td class="function_name">
|
88
|
+
<span class="c_punctuation">(</span><a class="link" href="AtkUtil.html#AtkEventListenerInit" title="AtkEventListenerInit ()">*AtkEventListenerInit</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
|
89
|
+
</td>
|
90
|
+
</tr>
|
91
|
+
<tr>
|
92
|
+
<td class="function_type">
|
93
|
+
<span class="returnvalue">guint</span>
|
94
|
+
</td>
|
95
|
+
<td class="function_name">
|
96
|
+
<a class="link" href="AtkUtil.html#atk-add-global-event-listener" title="atk_add_global_event_listener ()">atk_add_global_event_listener</a> <span class="c_punctuation">()</span>
|
97
|
+
</td>
|
98
|
+
</tr>
|
99
|
+
<tr>
|
100
|
+
<td class="function_type">
|
101
|
+
<span class="returnvalue">void</span>
|
102
|
+
</td>
|
103
|
+
<td class="function_name">
|
104
|
+
<a class="link" href="AtkUtil.html#atk-remove-global-event-listener" title="atk_remove_global_event_listener ()">atk_remove_global_event_listener</a> <span class="c_punctuation">()</span>
|
105
|
+
</td>
|
106
|
+
</tr>
|
107
|
+
<tr>
|
108
|
+
<td class="function_type">
|
109
|
+
<span class="returnvalue">gint</span>
|
110
|
+
</td>
|
111
|
+
<td class="function_name">
|
112
|
+
<span class="c_punctuation">(</span><a class="link" href="AtkUtil.html#AtkKeySnoopFunc" title="AtkKeySnoopFunc ()">*AtkKeySnoopFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
|
113
|
+
</td>
|
114
|
+
</tr>
|
115
|
+
<tr>
|
116
|
+
<td class="function_type">
|
117
|
+
<span class="returnvalue">guint</span>
|
118
|
+
</td>
|
119
|
+
<td class="function_name">
|
120
|
+
<a class="link" href="AtkUtil.html#atk-add-key-event-listener" title="atk_add_key_event_listener ()">atk_add_key_event_listener</a> <span class="c_punctuation">()</span>
|
121
|
+
</td>
|
122
|
+
</tr>
|
123
|
+
<tr>
|
124
|
+
<td class="function_type">
|
125
|
+
<span class="returnvalue">void</span>
|
126
|
+
</td>
|
127
|
+
<td class="function_name">
|
128
|
+
<a class="link" href="AtkUtil.html#atk-remove-key-event-listener" title="atk_remove_key_event_listener ()">atk_remove_key_event_listener</a> <span class="c_punctuation">()</span>
|
129
|
+
</td>
|
130
|
+
</tr>
|
131
|
+
<tr>
|
132
|
+
<td class="function_type">
|
133
|
+
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
|
134
|
+
</td>
|
135
|
+
<td class="function_name">
|
136
|
+
<a class="link" href="AtkUtil.html#atk-get-root" title="atk_get_root ()">atk_get_root</a> <span class="c_punctuation">()</span>
|
137
|
+
</td>
|
138
|
+
</tr>
|
139
|
+
<tr>
|
140
|
+
<td class="function_type">
|
141
|
+
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
|
142
|
+
</td>
|
143
|
+
<td class="function_name">
|
144
|
+
<a class="link" href="AtkUtil.html#atk-get-focus-object" title="atk_get_focus_object ()">atk_get_focus_object</a> <span class="c_punctuation">()</span>
|
145
|
+
</td>
|
146
|
+
</tr>
|
147
|
+
<tr>
|
148
|
+
<td class="function_type">const <span class="returnvalue">gchar</span> *
|
149
|
+
</td>
|
150
|
+
<td class="function_name">
|
151
|
+
<a class="link" href="AtkUtil.html#atk-get-toolkit-name" title="atk_get_toolkit_name ()">atk_get_toolkit_name</a> <span class="c_punctuation">()</span>
|
125
152
|
</td>
|
126
153
|
</tr>
|
127
154
|
<tr>
|
128
|
-
<td
|
129
|
-
|
130
|
-
|
155
|
+
<td class="function_type">const <span class="returnvalue">gchar</span> *
|
156
|
+
</td>
|
157
|
+
<td class="function_name">
|
158
|
+
<a class="link" href="AtkUtil.html#atk-get-toolkit-version" title="atk_get_toolkit_version ()">atk_get_toolkit_version</a> <span class="c_punctuation">()</span>
|
159
|
+
</td>
|
160
|
+
</tr>
|
161
|
+
<tr>
|
162
|
+
<td class="function_type">const <span class="returnvalue">gchar</span> *
|
163
|
+
</td>
|
164
|
+
<td class="function_name">
|
165
|
+
<a class="link" href="AtkUtil.html#atk-get-version" title="atk_get_version ()">atk_get_version</a> <span class="c_punctuation">()</span>
|
166
|
+
</td>
|
167
|
+
</tr>
|
168
|
+
<tr>
|
169
|
+
<td class="define_keyword">#define</td>
|
170
|
+
<td class="function_name">
|
171
|
+
<a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE:CAPS" title="ATK_DEFINE_TYPE()">ATK_DEFINE_TYPE</a><span class="c_punctuation">()</span>
|
172
|
+
</td>
|
173
|
+
</tr>
|
174
|
+
<tr>
|
175
|
+
<td class="define_keyword">#define</td>
|
176
|
+
<td class="function_name">
|
177
|
+
<a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE-EXTENDED:CAPS" title="ATK_DEFINE_TYPE_EXTENDED()">ATK_DEFINE_TYPE_EXTENDED</a><span class="c_punctuation">()</span>
|
178
|
+
</td>
|
179
|
+
</tr>
|
180
|
+
<tr>
|
181
|
+
<td class="define_keyword">#define</td>
|
182
|
+
<td class="function_name">
|
183
|
+
<a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE-WITH-CODE:CAPS" title="ATK_DEFINE_TYPE_WITH_CODE()">ATK_DEFINE_TYPE_WITH_CODE</a><span class="c_punctuation">()</span>
|
184
|
+
</td>
|
185
|
+
</tr>
|
186
|
+
<tr>
|
187
|
+
<td class="define_keyword">#define</td>
|
188
|
+
<td class="function_name">
|
189
|
+
<a class="link" href="AtkUtil.html#ATK-DEFINE-ABSTRACT-TYPE:CAPS" title="ATK_DEFINE_ABSTRACT_TYPE()">ATK_DEFINE_ABSTRACT_TYPE</a><span class="c_punctuation">()</span>
|
190
|
+
</td>
|
191
|
+
</tr>
|
192
|
+
<tr>
|
193
|
+
<td class="define_keyword">#define</td>
|
194
|
+
<td class="function_name">
|
195
|
+
<a class="link" href="AtkUtil.html#ATK-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS" title="ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE()">ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE</a><span class="c_punctuation">()</span>
|
131
196
|
</td>
|
132
197
|
</tr>
|
133
198
|
</tbody>
|
134
199
|
</table></div>
|
135
200
|
</div>
|
136
|
-
<
|
137
|
-
<
|
138
|
-
<
|
139
|
-
<
|
140
|
-
<
|
141
|
-
<
|
142
|
-
|
143
|
-
2.9.4. Focus tracking has been dropped as a feature to be
|
144
|
-
implemented by ATK itself. If you need focus tracking on your
|
145
|
-
implementation, subscribe to the state-changed:focused signal.</p>
|
146
|
-
</div>
|
147
|
-
<p>
|
148
|
-
Adds the specified function to the list of functions to be called
|
149
|
-
when an object receives focus.
|
150
|
-
</p>
|
151
|
-
<div class="variablelist"><table border="0">
|
152
|
-
<col align="left" valign="top">
|
201
|
+
<div class="refsect1">
|
202
|
+
<a name="AtkUtil.other"></a><h2>Types and Values</h2>
|
203
|
+
<div class="informaltable"><table width="100%" border="0">
|
204
|
+
<colgroup>
|
205
|
+
<col width="150px" class="name">
|
206
|
+
<col class="description">
|
207
|
+
</colgroup>
|
153
208
|
<tbody>
|
154
209
|
<tr>
|
155
|
-
<td
|
156
|
-
<td
|
157
|
-
|
210
|
+
<td class="datatype_keyword">struct</td>
|
211
|
+
<td class="function_name"><a class="link" href="AtkUtil.html#AtkUtil-struct" title="struct AtkUtil">AtkUtil</a></td>
|
212
|
+
</tr>
|
213
|
+
<tr>
|
214
|
+
<td class="datatype_keyword">struct</td>
|
215
|
+
<td class="function_name"><a class="link" href="AtkUtil.html#AtkUtilClass" title="struct AtkUtilClass">AtkUtilClass</a></td>
|
158
216
|
</tr>
|
159
217
|
<tr>
|
160
|
-
<td
|
161
|
-
<td
|
218
|
+
<td class="datatype_keyword">enum</td>
|
219
|
+
<td class="function_name"><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType">AtkCoordType</a></td>
|
220
|
+
</tr>
|
221
|
+
<tr>
|
222
|
+
<td class="datatype_keyword">struct</td>
|
223
|
+
<td class="function_name"><a class="link" href="AtkUtil.html#AtkKeyEventStruct" title="struct AtkKeyEventStruct">AtkKeyEventStruct</a></td>
|
224
|
+
</tr>
|
225
|
+
<tr>
|
226
|
+
<td class="datatype_keyword">enum</td>
|
227
|
+
<td class="function_name"><a class="link" href="AtkUtil.html#AtkKeyEventType" title="enum AtkKeyEventType">AtkKeyEventType</a></td>
|
162
228
|
</tr>
|
163
229
|
</tbody>
|
164
230
|
</table></div>
|
165
231
|
</div>
|
232
|
+
<div class="refsect1">
|
233
|
+
<a name="AtkUtil.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
234
|
+
<pre class="screen"> GObject
|
235
|
+
<span class="lineart">╰──</span> AtkUtil
|
236
|
+
</pre>
|
237
|
+
</div>
|
238
|
+
<div class="refsect1">
|
239
|
+
<a name="AtkUtil.description"></a><h2>Description</h2>
|
240
|
+
<p>A set of ATK utility functions which are used to support event
|
241
|
+
registration of various types, and obtaining the 'root' accessible
|
242
|
+
of a process and information about the current ATK implementation
|
243
|
+
and toolkit version.</p>
|
244
|
+
</div>
|
245
|
+
<div class="refsect1">
|
246
|
+
<a name="AtkUtil.functions_details"></a><h2>Functions</h2>
|
247
|
+
<div class="refsect2">
|
248
|
+
<a name="atk-add-focus-tracker"></a><h3>atk_add_focus_tracker ()</h3>
|
249
|
+
<pre class="programlisting"><span class="returnvalue">guint</span>
|
250
|
+
atk_add_focus_tracker (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkEventListener" title="AtkEventListener ()"><span class="type">AtkEventListener</span></a> focus_tracker</code></em>);</pre>
|
251
|
+
<div class="warning">
|
252
|
+
<p><code class="literal">atk_add_focus_tracker</code> is deprecated and should not be used in newly-written code.</p>
|
253
|
+
<p>This method is deprecated since ATK version
|
254
|
+
2.9.4. Focus tracking has been dropped as a feature to be
|
255
|
+
implemented by ATK itself. If you need focus tracking on your
|
256
|
+
implementation, subscribe to the state-changed:focused signal.</p>
|
257
|
+
</div>
|
258
|
+
<p>Adds the specified function to the list of functions to be called
|
259
|
+
when an object receives focus.</p>
|
260
|
+
<div class="refsect3">
|
261
|
+
<a name="id-1.4.2.7.2.6"></a><h4>Parameters</h4>
|
262
|
+
<div class="informaltable"><table width="100%" border="0">
|
263
|
+
<colgroup>
|
264
|
+
<col width="150px" class="parameters_name">
|
265
|
+
<col class="parameters_description">
|
266
|
+
<col width="200px" class="parameters_annotations">
|
267
|
+
</colgroup>
|
268
|
+
<tbody><tr>
|
269
|
+
<td class="parameter_name"><p>focus_tracker</p></td>
|
270
|
+
<td class="parameter_description"><p>Function to be added to the list of functions to be called
|
271
|
+
when an object receives focus.</p></td>
|
272
|
+
<td class="parameter_annotations"> </td>
|
273
|
+
</tr></tbody>
|
274
|
+
</table></div>
|
275
|
+
</div>
|
276
|
+
<div class="refsect3">
|
277
|
+
<a name="id-1.4.2.7.2.7"></a><h4>Returns</h4>
|
278
|
+
<p> added focus tracker id, or 0 on failure.</p>
|
279
|
+
<p></p>
|
280
|
+
</div>
|
281
|
+
</div>
|
166
282
|
<hr>
|
167
283
|
<div class="refsect2">
|
168
|
-
<a name="atk-remove-focus-tracker"></a><h3>atk_remove_focus_tracker
|
169
|
-
<pre class="programlisting"><span class="returnvalue">void</span>
|
284
|
+
<a name="atk-remove-focus-tracker"></a><h3>atk_remove_focus_tracker ()</h3>
|
285
|
+
<pre class="programlisting"><span class="returnvalue">void</span>
|
286
|
+
atk_remove_focus_tracker (<em class="parameter"><code><span class="type">guint</span> tracker_id</code></em>);</pre>
|
170
287
|
<div class="warning">
|
171
|
-
<
|
172
|
-
<p
|
288
|
+
<p><code class="literal">atk_remove_focus_tracker</code> is deprecated and should not be used in newly-written code.</p>
|
289
|
+
<p>This method is deprecated since ATK version
|
173
290
|
2.9.4. Focus tracking has been dropped as a feature to be
|
174
291
|
implemented by ATK itself. If you need focus tracking on your
|
175
|
-
implementation, subscribe to the state-changed:focused signal
|
176
|
-
|
177
|
-
<p>
|
178
|
-
Removes the specified focus tracker from the list of functions
|
292
|
+
implementation, subscribe to the state-changed:focused signal.</p>
|
293
|
+
<p>Removes the specified focus tracker from the list of functions
|
179
294
|
to be called when any object receives focus.</p>
|
180
295
|
</div>
|
181
|
-
<div class="
|
182
|
-
<
|
296
|
+
<div class="refsect3">
|
297
|
+
<a name="id-1.4.2.7.3.5"></a><h4>Parameters</h4>
|
298
|
+
<div class="informaltable"><table width="100%" border="0">
|
299
|
+
<colgroup>
|
300
|
+
<col width="150px" class="parameters_name">
|
301
|
+
<col class="parameters_description">
|
302
|
+
<col width="200px" class="parameters_annotations">
|
303
|
+
</colgroup>
|
183
304
|
<tbody><tr>
|
184
|
-
<td
|
185
|
-
<td>the id of the focus tracker to remove</td>
|
305
|
+
<td class="parameter_name"><p>tracker_id</p></td>
|
306
|
+
<td class="parameter_description"><p>the id of the focus tracker to remove</p></td>
|
307
|
+
<td class="parameter_annotations"> </td>
|
186
308
|
</tr></tbody>
|
187
309
|
</table></div>
|
188
310
|
</div>
|
311
|
+
</div>
|
189
312
|
<hr>
|
190
313
|
<div class="refsect2">
|
191
|
-
<a name="atk-focus-tracker-init"></a><h3>atk_focus_tracker_init
|
192
|
-
<pre class="programlisting"><span class="returnvalue">void</span>
|
314
|
+
<a name="atk-focus-tracker-init"></a><h3>atk_focus_tracker_init ()</h3>
|
315
|
+
<pre class="programlisting"><span class="returnvalue">void</span>
|
316
|
+
atk_focus_tracker_init (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkEventListenerInit" title="AtkEventListenerInit ()"><span class="type">AtkEventListenerInit</span></a> init</code></em>);</pre>
|
193
317
|
<div class="warning">
|
194
|
-
<
|
195
|
-
<p
|
318
|
+
<p><code class="literal">atk_focus_tracker_init</code> is deprecated and should not be used in newly-written code.</p>
|
319
|
+
<p>This method is deprecated since ATK version
|
196
320
|
2.9.4. Focus tracking has been dropped as a feature to be
|
197
321
|
implemented by ATK itself.</p>
|
198
322
|
</div>
|
199
|
-
<p>
|
200
|
-
Specifies the function to be called for focus tracker initialization.
|
323
|
+
<p>Specifies the function to be called for focus tracker initialization.
|
201
324
|
This function should be called by an implementation of the
|
202
325
|
ATK interface if any specific work needs to be done to enable
|
203
|
-
focus tracking
|
204
|
-
|
205
|
-
<
|
206
|
-
<
|
326
|
+
focus tracking.</p>
|
327
|
+
<div class="refsect3">
|
328
|
+
<a name="id-1.4.2.7.4.6"></a><h4>Parameters</h4>
|
329
|
+
<div class="informaltable"><table width="100%" border="0">
|
330
|
+
<colgroup>
|
331
|
+
<col width="150px" class="parameters_name">
|
332
|
+
<col class="parameters_description">
|
333
|
+
<col width="200px" class="parameters_annotations">
|
334
|
+
</colgroup>
|
207
335
|
<tbody><tr>
|
208
|
-
<td
|
209
|
-
<td>Function to be called for focus tracker initialization</td>
|
336
|
+
<td class="parameter_name"><p>init</p></td>
|
337
|
+
<td class="parameter_description"><p>Function to be called for focus tracker initialization</p></td>
|
338
|
+
<td class="parameter_annotations"> </td>
|
210
339
|
</tr></tbody>
|
211
340
|
</table></div>
|
212
341
|
</div>
|
342
|
+
</div>
|
213
343
|
<hr>
|
214
344
|
<div class="refsect2">
|
215
|
-
<a name="atk-focus-tracker-notify"></a><h3>atk_focus_tracker_notify
|
216
|
-
<pre class="programlisting"><span class="returnvalue">void</span>
|
345
|
+
<a name="atk-focus-tracker-notify"></a><h3>atk_focus_tracker_notify ()</h3>
|
346
|
+
<pre class="programlisting"><span class="returnvalue">void</span>
|
347
|
+
atk_focus_tracker_notify (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>);</pre>
|
217
348
|
<div class="warning">
|
218
|
-
<
|
219
|
-
<p
|
349
|
+
<p><code class="literal">atk_focus_tracker_notify</code> is deprecated and should not be used in newly-written code.</p>
|
350
|
+
<p>This method is deprecated since ATK version
|
220
351
|
2.9.4. Focus tracking has been dropped as a feature to be
|
221
352
|
implemented by ATK itself.</p>
|
222
353
|
</div>
|
223
|
-
<p>
|
224
|
-
|
225
|
-
|
226
|
-
</
|
227
|
-
<div class="
|
228
|
-
<
|
354
|
+
<p>Cause the focus tracker functions which have been specified to be
|
355
|
+
executed for the object.</p>
|
356
|
+
<div class="refsect3">
|
357
|
+
<a name="id-1.4.2.7.5.6"></a><h4>Parameters</h4>
|
358
|
+
<div class="informaltable"><table width="100%" border="0">
|
359
|
+
<colgroup>
|
360
|
+
<col width="150px" class="parameters_name">
|
361
|
+
<col class="parameters_description">
|
362
|
+
<col width="200px" class="parameters_annotations">
|
363
|
+
</colgroup>
|
229
364
|
<tbody><tr>
|
230
|
-
<td
|
231
|
-
<td>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
|
232
|
-
</td>
|
365
|
+
<td class="parameter_name"><p>object</p></td>
|
366
|
+
<td class="parameter_description"><p>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a></p></td>
|
367
|
+
<td class="parameter_annotations"> </td>
|
233
368
|
</tr></tbody>
|
234
369
|
</table></div>
|
235
370
|
</div>
|
371
|
+
</div>
|
236
372
|
<hr>
|
237
373
|
<div class="refsect2">
|
238
|
-
<a name="AtkEventListener"></a><h3>AtkEventListener
|
239
|
-
<pre class="programlisting"><span class="returnvalue">void</span>
|
240
|
-
<
|
241
|
-
A function which is called when an object emits a matching event,
|
242
|
-
as used in <a class="link" href="AtkUtil.html#atk-add-focus-tracker" title="atk_add_focus_tracker
|
374
|
+
<a name="AtkEventListener"></a><h3>AtkEventListener ()</h3>
|
375
|
+
<pre class="programlisting"><span class="returnvalue">void</span>
|
376
|
+
<span class="c_punctuation">(</span>*AtkEventListener<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *obj</code></em>);</pre>
|
377
|
+
<p>A function which is called when an object emits a matching event,
|
378
|
+
as used in <a class="link" href="AtkUtil.html#atk-add-focus-tracker" title="atk_add_focus_tracker ()"><span class="type">atk_add_focus_tracker</span></a>.
|
243
379
|
Currently the only events for which object-specific handlers are
|
244
380
|
supported are events of type "focus:". Most clients of ATK will prefer to
|
245
|
-
attach signal handlers for the various ATK signals instead
|
246
|
-
|
247
|
-
<
|
248
|
-
|
249
|
-
|
250
|
-
<
|
251
|
-
<col
|
381
|
+
attach signal handlers for the various ATK signals instead.</p>
|
382
|
+
<p>see atk_add_focus_tracker.</p>
|
383
|
+
<div class="refsect3">
|
384
|
+
<a name="id-1.4.2.7.6.6"></a><h4>Parameters</h4>
|
385
|
+
<div class="informaltable"><table width="100%" border="0">
|
386
|
+
<colgroup>
|
387
|
+
<col width="150px" class="parameters_name">
|
388
|
+
<col class="parameters_description">
|
389
|
+
<col width="200px" class="parameters_annotations">
|
390
|
+
</colgroup>
|
252
391
|
<tbody><tr>
|
253
|
-
<td
|
254
|
-
<td>An <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> instance for whom the callback will be called when
|
255
|
-
the specified event (e.g. 'focus:') takes place.</td>
|
392
|
+
<td class="parameter_name"><p>obj</p></td>
|
393
|
+
<td class="parameter_description"><p>An <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> instance for whom the callback will be called when
|
394
|
+
the specified event (e.g. 'focus:') takes place.</p></td>
|
395
|
+
<td class="parameter_annotations"> </td>
|
256
396
|
</tr></tbody>
|
257
397
|
</table></div>
|
258
398
|
</div>
|
399
|
+
</div>
|
259
400
|
<hr>
|
260
401
|
<div class="refsect2">
|
261
|
-
<a name="AtkEventListenerInit"></a><h3>AtkEventListenerInit
|
262
|
-
<pre class="programlisting"><span class="returnvalue">void</span>
|
263
|
-
<
|
264
|
-
An <a class="link" href="AtkUtil.html#AtkEventListenerInit" title="AtkEventListenerInit
|
402
|
+
<a name="AtkEventListenerInit"></a><h3>AtkEventListenerInit ()</h3>
|
403
|
+
<pre class="programlisting"><span class="returnvalue">void</span>
|
404
|
+
<span class="c_punctuation">(</span>*AtkEventListenerInit<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
405
|
+
<p>An <a class="link" href="AtkUtil.html#AtkEventListenerInit" title="AtkEventListenerInit ()"><span class="type">AtkEventListenerInit</span></a> function is a special function that is
|
265
406
|
called in order to initialize the per-object event registration system
|
266
|
-
used by <a class="link" href="AtkUtil.html#AtkEventListener" title="AtkEventListener
|
267
|
-
|
268
|
-
<p>
|
269
|
-
see atk_focus_tracker_init.
|
270
|
-
</p>
|
407
|
+
used by <a class="link" href="AtkUtil.html#AtkEventListener" title="AtkEventListener ()"><span class="type">AtkEventListener</span></a>, if any preparation is required. </p>
|
408
|
+
<p>see atk_focus_tracker_init.</p>
|
271
409
|
</div>
|
272
410
|
<hr>
|
273
411
|
<div class="refsect2">
|
274
|
-
<a name="atk-add-global-event-listener"></a><h3>atk_add_global_event_listener
|
275
|
-
<pre class="programlisting"><span class="returnvalue">guint</span>
|
276
|
-
|
277
|
-
<
|
278
|
-
Adds the specified function to the list of functions to be called
|
279
|
-
when an ATK event of type event_type occurs
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
"ATK:<atk_type>:<atk_event>:<atk_event_detail>
|
284
|
-
</p>
|
285
|
-
<p>
|
286
|
-
Where "ATK" works as the namespace, <atk_interface> is the name of
|
412
|
+
<a name="atk-add-global-event-listener"></a><h3>atk_add_global_event_listener ()</h3>
|
413
|
+
<pre class="programlisting"><span class="returnvalue">guint</span>
|
414
|
+
atk_add_global_event_listener (<em class="parameter"><code><span class="type">GSignalEmissionHook</span> listener</code></em>,
|
415
|
+
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>);</pre>
|
416
|
+
<p>Adds the specified function to the list of functions to be called
|
417
|
+
when an ATK event of type event_type occurs.</p>
|
418
|
+
<p>The format of event_type is the following:
|
419
|
+
"ATK:<atk_type>:<atk_event>:<atk_event_detail></p>
|
420
|
+
<p>Where "ATK" works as the namespace, <atk_interface> is the name of
|
287
421
|
the ATK type (interface or object), <atk_event> is the name of the
|
288
422
|
signal defined on that interface and <atk_event_detail> is the
|
289
423
|
gsignal detail of that signal. You can find more info about gsignal
|
290
424
|
details here:
|
291
|
-
http://developer.gnome.org/gobject/stable/gobject-Signals.html
|
292
|
-
|
293
|
-
<p>
|
294
|
-
The first three parameters are mandatory. The last one is optional.
|
295
|
-
</p>
|
296
|
-
<p>
|
297
|
-
For example:
|
425
|
+
http://developer.gnome.org/gobject/stable/gobject-Signals.html</p>
|
426
|
+
<p>The first three parameters are mandatory. The last one is optional.</p>
|
427
|
+
<p>For example:
|
298
428
|
ATK:AtkObject:state-change
|
299
429
|
ATK:AtkText:text-selection-changed
|
300
|
-
ATK:AtkText:text-insert:system
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
this
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
<
|
430
|
+
ATK:AtkText:text-insert:system</p>
|
431
|
+
<p>Toolkit implementor note: ATK provides a default implementation for
|
432
|
+
this virtual method. ATK implementors are discouraged from
|
433
|
+
reimplementing this method.</p>
|
434
|
+
<p>Toolkit implementor note: this method is not intended to be used by
|
435
|
+
ATK implementors but by ATK consumers.</p>
|
436
|
+
<p>ATK consumers note: as this method adds a listener for a given ATK
|
437
|
+
type, that type should be already registered on the GType system
|
438
|
+
before calling this method. A simple way to do that is creating an
|
439
|
+
instance of <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject"><span class="type">AtkNoOpObject</span></a>. This class implements all ATK
|
440
|
+
interfaces, so creating the instance will register all ATK types as
|
441
|
+
a collateral effect.</p>
|
442
|
+
<div class="refsect3">
|
443
|
+
<a name="id-1.4.2.7.8.12"></a><h4>Parameters</h4>
|
444
|
+
<div class="informaltable"><table width="100%" border="0">
|
445
|
+
<colgroup>
|
446
|
+
<col width="150px" class="parameters_name">
|
447
|
+
<col class="parameters_description">
|
448
|
+
<col width="200px" class="parameters_annotations">
|
449
|
+
</colgroup>
|
310
450
|
<tbody>
|
311
451
|
<tr>
|
312
|
-
<td
|
313
|
-
<td>the listener to notify</td>
|
314
|
-
</
|
315
|
-
<tr>
|
316
|
-
<td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
|
317
|
-
<td>the type of event for which notification is requested</td>
|
452
|
+
<td class="parameter_name"><p>listener</p></td>
|
453
|
+
<td class="parameter_description"><p>the listener to notify</p></td>
|
454
|
+
<td class="parameter_annotations"> </td>
|
318
455
|
</tr>
|
319
456
|
<tr>
|
320
|
-
<td
|
321
|
-
<td>
|
457
|
+
<td class="parameter_name"><p>event_type</p></td>
|
458
|
+
<td class="parameter_description"><p>the type of event for which notification is requested</p></td>
|
459
|
+
<td class="parameter_annotations"> </td>
|
322
460
|
</tr>
|
323
461
|
</tbody>
|
324
462
|
</table></div>
|
325
463
|
</div>
|
464
|
+
<div class="refsect3">
|
465
|
+
<a name="id-1.4.2.7.8.13"></a><h4>Returns</h4>
|
466
|
+
<p> added event listener id, or 0 on failure.</p>
|
467
|
+
<p></p>
|
468
|
+
</div>
|
469
|
+
</div>
|
326
470
|
<hr>
|
327
471
|
<div class="refsect2">
|
328
|
-
<a name="atk-remove-global-event-listener"></a><h3>atk_remove_global_event_listener
|
329
|
-
<pre class="programlisting"><span class="returnvalue">void</span>
|
330
|
-
<
|
331
|
-
<em class="parameter"><code>listener_id</code></em>
|
332
|
-
|
333
|
-
|
334
|
-
<p>
|
335
|
-
|
336
|
-
this
|
337
|
-
|
338
|
-
|
339
|
-
</p>
|
340
|
-
<
|
341
|
-
|
342
|
-
|
343
|
-
<
|
344
|
-
<col
|
472
|
+
<a name="atk-remove-global-event-listener"></a><h3>atk_remove_global_event_listener ()</h3>
|
473
|
+
<pre class="programlisting"><span class="returnvalue">void</span>
|
474
|
+
atk_remove_global_event_listener (<em class="parameter"><code><span class="type">guint</span> listener_id</code></em>);</pre>
|
475
|
+
<p><em class="parameter"><code>listener_id</code></em>
|
476
|
+
is the value returned by <a class="link" href="AtkUtil.html#atk-add-global-event-listener" title="atk_add_global_event_listener ()"><span class="type">atk_add_global_event_listener</span></a>
|
477
|
+
when you registered that event listener.</p>
|
478
|
+
<p>Toolkit implementor note: ATK provides a default implementation for
|
479
|
+
this virtual method. ATK implementors are discouraged from
|
480
|
+
reimplementing this method.</p>
|
481
|
+
<p>Toolkit implementor note: this method is not intended to be used by
|
482
|
+
ATK implementors but by ATK consumers.</p>
|
483
|
+
<p>Removes the specified event listener</p>
|
484
|
+
<div class="refsect3">
|
485
|
+
<a name="id-1.4.2.7.9.8"></a><h4>Parameters</h4>
|
486
|
+
<div class="informaltable"><table width="100%" border="0">
|
487
|
+
<colgroup>
|
488
|
+
<col width="150px" class="parameters_name">
|
489
|
+
<col class="parameters_description">
|
490
|
+
<col width="200px" class="parameters_annotations">
|
491
|
+
</colgroup>
|
345
492
|
<tbody><tr>
|
346
|
-
<td
|
347
|
-
<td>the id of the event listener to remove</td>
|
493
|
+
<td class="parameter_name"><p>listener_id</p></td>
|
494
|
+
<td class="parameter_description"><p>the id of the event listener to remove</p></td>
|
495
|
+
<td class="parameter_annotations"> </td>
|
348
496
|
</tr></tbody>
|
349
497
|
</table></div>
|
350
498
|
</div>
|
351
|
-
<hr>
|
352
|
-
<div class="refsect2">
|
353
|
-
<a name="AtkKeyEventStruct"></a><h3>struct AtkKeyEventStruct</h3>
|
354
|
-
<pre class="programlisting">struct AtkKeyEventStruct {
|
355
|
-
gint type;
|
356
|
-
guint state;
|
357
|
-
guint keyval;
|
358
|
-
gint length;
|
359
|
-
gchar *string;
|
360
|
-
guint16 keycode;
|
361
|
-
guint32 timestamp;
|
362
|
-
};
|
363
|
-
</pre>
|
364
|
-
<p>
|
365
|
-
Encapsulates information about a key event.
|
366
|
-
</p>
|
367
|
-
<div class="variablelist"><table border="0">
|
368
|
-
<col align="left" valign="top">
|
369
|
-
<tbody>
|
370
|
-
<tr>
|
371
|
-
<td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="AtkKeyEventStruct.type"></a>type</code></em>;</span></p></td>
|
372
|
-
<td>An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE</td>
|
373
|
-
</tr>
|
374
|
-
<tr>
|
375
|
-
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="AtkKeyEventStruct.state"></a>state</code></em>;</span></p></td>
|
376
|
-
<td>A bitmask representing the state of the modifier keys immediately after the event takes place.
|
377
|
-
The meaning of the bits is currently defined to match the bitmask used by GDK in
|
378
|
-
GdkEventType.state, see
|
379
|
-
http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html<span class="type">GdkEventKey</span>
|
380
|
-
</td>
|
381
|
-
</tr>
|
382
|
-
<tr>
|
383
|
-
<td><p><span class="term"><span class="type">guint</span> <em class="structfield"><code><a name="AtkKeyEventStruct.keyval"></a>keyval</code></em>;</span></p></td>
|
384
|
-
<td>A guint representing a keysym value corresponding to those used by GDK and X11: see
|
385
|
-
/usr/X11/include/keysymdef.h.</td>
|
386
|
-
</tr>
|
387
|
-
<tr>
|
388
|
-
<td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="AtkKeyEventStruct.length"></a>length</code></em>;</span></p></td>
|
389
|
-
<td>The length of member <span class="type">string</span>.</td>
|
390
|
-
</tr>
|
391
|
-
<tr>
|
392
|
-
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="AtkKeyEventStruct.string"></a>string</code></em>;</span></p></td>
|
393
|
-
<td>A string containing one of the following: either a string approximating the text that would
|
394
|
-
result from this keypress, if the key is a control or graphic character, or a symbolic name for this keypress.
|
395
|
-
Alphanumeric and printable keys will have the symbolic key name in this string member, for instance "A". "0",
|
396
|
-
"semicolon", "aacute". Keypad keys have the prefix "KP".</td>
|
397
|
-
</tr>
|
398
|
-
<tr>
|
399
|
-
<td><p><span class="term"><span class="type">guint16</span> <em class="structfield"><code><a name="AtkKeyEventStruct.keycode"></a>keycode</code></em>;</span></p></td>
|
400
|
-
<td>The raw hardware code that generated the key event. This field is raraly useful.</td>
|
401
|
-
</tr>
|
402
|
-
<tr>
|
403
|
-
<td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="AtkKeyEventStruct.timestamp"></a>timestamp</code></em>;</span></p></td>
|
404
|
-
<td>A timestamp in milliseconds indicating when the event occurred.
|
405
|
-
These timestamps are relative to a starting point which should be considered arbitrary,
|
406
|
-
and only used to compare the dispatch times of events to one another.</td>
|
407
|
-
</tr>
|
408
|
-
</tbody>
|
409
|
-
</table></div>
|
410
499
|
</div>
|
411
500
|
<hr>
|
412
501
|
<div class="refsect2">
|
413
|
-
<a name="
|
414
|
-
<pre class="programlisting">
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
<
|
421
|
-
|
422
|
-
|
423
|
-
<
|
424
|
-
<col
|
502
|
+
<a name="AtkKeySnoopFunc"></a><h3>AtkKeySnoopFunc ()</h3>
|
503
|
+
<pre class="programlisting"><span class="returnvalue">gint</span>
|
504
|
+
<span class="c_punctuation">(</span>*AtkKeySnoopFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkKeyEventStruct" title="struct AtkKeyEventStruct"><span class="type">AtkKeyEventStruct</span></a> *event</code></em>,
|
505
|
+
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
|
506
|
+
<p>An <a class="link" href="AtkUtil.html#AtkKeySnoopFunc" title="AtkKeySnoopFunc ()"><span class="type">AtkKeySnoopFunc</span></a> is a type of callback which is called whenever a key event occurs,
|
507
|
+
if registered via atk_add_key_event_listener. It allows for pre-emptive
|
508
|
+
interception of key events via the return code as described below.</p>
|
509
|
+
<div class="refsect3">
|
510
|
+
<a name="id-1.4.2.7.10.5"></a><h4>Parameters</h4>
|
511
|
+
<div class="informaltable"><table width="100%" border="0">
|
512
|
+
<colgroup>
|
513
|
+
<col width="150px" class="parameters_name">
|
514
|
+
<col class="parameters_description">
|
515
|
+
<col width="200px" class="parameters_annotations">
|
516
|
+
</colgroup>
|
425
517
|
<tbody>
|
426
518
|
<tr>
|
427
|
-
<td
|
428
|
-
<td>
|
429
|
-
|
430
|
-
</
|
431
|
-
<tr>
|
432
|
-
<td><p><a name="ATK-KEY-EVENT-RELEASE:CAPS"></a><span class="term"><code class="literal">ATK_KEY_EVENT_RELEASE</code></span></p></td>
|
433
|
-
<td>specifies a key release event
|
434
|
-
</td>
|
519
|
+
<td class="parameter_name"><p>event</p></td>
|
520
|
+
<td class="parameter_description"><p>an AtkKeyEventStruct containing information about the key event for which
|
521
|
+
notification is being given.</p></td>
|
522
|
+
<td class="parameter_annotations"> </td>
|
435
523
|
</tr>
|
436
524
|
<tr>
|
437
|
-
<td
|
438
|
-
<td>
|
439
|
-
</td>
|
525
|
+
<td class="parameter_name"><p>user_data</p></td>
|
526
|
+
<td class="parameter_description"><p>a block of data which will be passed to the event listener, on notification.</p></td>
|
527
|
+
<td class="parameter_annotations"> </td>
|
440
528
|
</tr>
|
441
529
|
</tbody>
|
442
530
|
</table></div>
|
443
531
|
</div>
|
444
|
-
<
|
445
|
-
<
|
446
|
-
<
|
447
|
-
<pre class="programlisting"><span class="returnvalue">gint</span> (*AtkKeySnoopFunc) (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkKeyEventStruct" title="struct AtkKeyEventStruct"><span class="type">AtkKeyEventStruct</span></a> *event</code></em>,
|
448
|
-
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
|
449
|
-
<p>
|
450
|
-
An <a class="link" href="AtkUtil.html#AtkKeySnoopFunc" title="AtkKeySnoopFunc ()"><span class="type">AtkKeySnoopFunc</span></a> is a type of callback which is called whenever a key event occurs,
|
451
|
-
if registered via atk_add_key_event_listener. It allows for pre-emptive
|
452
|
-
interception of key events via the return code as described below.
|
453
|
-
</p>
|
454
|
-
<div class="variablelist"><table border="0">
|
455
|
-
<col align="left" valign="top">
|
456
|
-
<tbody>
|
457
|
-
<tr>
|
458
|
-
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
|
459
|
-
<td>an AtkKeyEventStruct containing information about the key event for which
|
460
|
-
notification is being given.</td>
|
461
|
-
</tr>
|
462
|
-
<tr>
|
463
|
-
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
|
464
|
-
<td>a block of data which will be passed to the event listener, on notification.</td>
|
465
|
-
</tr>
|
466
|
-
<tr>
|
467
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
468
|
-
<td>TRUE (nonzero) if the event emission should be stopped and the event
|
532
|
+
<div class="refsect3">
|
533
|
+
<a name="id-1.4.2.7.10.6"></a><h4>Returns</h4>
|
534
|
+
<p> TRUE (nonzero) if the event emission should be stopped and the event
|
469
535
|
discarded without being passed to the normal GUI recipient; FALSE (zero) if the
|
470
|
-
event dispatch to the client application should proceed as normal
|
471
|
-
see atk_add_key_event_listener.</
|
472
|
-
|
473
|
-
</
|
474
|
-
</table></div>
|
536
|
+
event dispatch to the client application should proceed as normal.</p>
|
537
|
+
<p>see atk_add_key_event_listener.</p>
|
538
|
+
<p></p>
|
539
|
+
</div>
|
475
540
|
</div>
|
476
541
|
<hr>
|
477
542
|
<div class="refsect2">
|
478
|
-
<a name="atk-add-key-event-listener"></a><h3>atk_add_key_event_listener
|
479
|
-
<pre class="programlisting"><span class="returnvalue">guint</span>
|
480
|
-
|
481
|
-
<
|
482
|
-
Adds the specified function to the list of functions to be called
|
483
|
-
when a key event occurs. The <em class="parameter"><code>data</code></em>
|
484
|
-
|
485
|
-
</
|
486
|
-
<
|
487
|
-
|
543
|
+
<a name="atk-add-key-event-listener"></a><h3>atk_add_key_event_listener ()</h3>
|
544
|
+
<pre class="programlisting"><span class="returnvalue">guint</span>
|
545
|
+
atk_add_key_event_listener (<em class="parameter"><code><a class="link" href="AtkUtil.html#AtkKeySnoopFunc" title="AtkKeySnoopFunc ()"><span class="type">AtkKeySnoopFunc</span></a> listener</code></em>,
|
546
|
+
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
|
547
|
+
<p>Adds the specified function to the list of functions to be called
|
548
|
+
when a key event occurs. The <em class="parameter"><code>data</code></em>
|
549
|
+
element will be passed to the
|
550
|
+
<a class="link" href="AtkUtil.html#AtkKeySnoopFunc" title="AtkKeySnoopFunc ()"><span class="type">AtkKeySnoopFunc</span></a> (<em class="parameter"><code>listener</code></em>
|
551
|
+
) as the <em class="parameter"><code>func_data</code></em>
|
552
|
+
param, on notification.</p>
|
553
|
+
<div class="refsect3">
|
554
|
+
<a name="id-1.4.2.7.11.5"></a><h4>Parameters</h4>
|
555
|
+
<div class="informaltable"><table width="100%" border="0">
|
556
|
+
<colgroup>
|
557
|
+
<col width="150px" class="parameters_name">
|
558
|
+
<col class="parameters_description">
|
559
|
+
<col width="200px" class="parameters_annotations">
|
560
|
+
</colgroup>
|
488
561
|
<tbody>
|
489
562
|
<tr>
|
490
|
-
<td
|
491
|
-
<td>the listener to notify</td>
|
492
|
-
</
|
493
|
-
<tr>
|
494
|
-
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
|
495
|
-
<td>a <span class="type">gpointer</span> that points to a block of data that should be sent to the registered listeners,
|
496
|
-
along with the event notification, when it occurs.</td>
|
563
|
+
<td class="parameter_name"><p>listener</p></td>
|
564
|
+
<td class="parameter_description"><p>the listener to notify</p></td>
|
565
|
+
<td class="parameter_annotations"> </td>
|
497
566
|
</tr>
|
498
567
|
<tr>
|
499
|
-
<td
|
500
|
-
<td>
|
568
|
+
<td class="parameter_name"><p>data</p></td>
|
569
|
+
<td class="parameter_description"><p>a <span class="type">gpointer</span> that points to a block of data that should be sent to the registered listeners,
|
570
|
+
along with the event notification, when it occurs. </p></td>
|
571
|
+
<td class="parameter_annotations"> </td>
|
501
572
|
</tr>
|
502
573
|
</tbody>
|
503
574
|
</table></div>
|
504
575
|
</div>
|
576
|
+
<div class="refsect3">
|
577
|
+
<a name="id-1.4.2.7.11.6"></a><h4>Returns</h4>
|
578
|
+
<p> added event listener id, or 0 on failure.</p>
|
579
|
+
<p></p>
|
580
|
+
</div>
|
581
|
+
</div>
|
505
582
|
<hr>
|
506
583
|
<div class="refsect2">
|
507
|
-
<a name="atk-remove-key-event-listener"></a><h3>atk_remove_key_event_listener
|
508
|
-
<pre class="programlisting"><span class="returnvalue">void</span>
|
509
|
-
<
|
510
|
-
<em class="parameter"><code>listener_id</code></em>
|
511
|
-
|
512
|
-
|
513
|
-
<p>
|
514
|
-
|
515
|
-
</
|
516
|
-
<div class="
|
517
|
-
<
|
584
|
+
<a name="atk-remove-key-event-listener"></a><h3>atk_remove_key_event_listener ()</h3>
|
585
|
+
<pre class="programlisting"><span class="returnvalue">void</span>
|
586
|
+
atk_remove_key_event_listener (<em class="parameter"><code><span class="type">guint</span> listener_id</code></em>);</pre>
|
587
|
+
<p><em class="parameter"><code>listener_id</code></em>
|
588
|
+
is the value returned by <a class="link" href="AtkUtil.html#atk-add-key-event-listener" title="atk_add_key_event_listener ()"><span class="type">atk_add_key_event_listener</span></a>
|
589
|
+
when you registered that event listener.</p>
|
590
|
+
<p>Removes the specified event listener.</p>
|
591
|
+
<div class="refsect3">
|
592
|
+
<a name="id-1.4.2.7.12.6"></a><h4>Parameters</h4>
|
593
|
+
<div class="informaltable"><table width="100%" border="0">
|
594
|
+
<colgroup>
|
595
|
+
<col width="150px" class="parameters_name">
|
596
|
+
<col class="parameters_description">
|
597
|
+
<col width="200px" class="parameters_annotations">
|
598
|
+
</colgroup>
|
518
599
|
<tbody><tr>
|
519
|
-
<td
|
520
|
-
<td>the id of the event listener to remove</td>
|
600
|
+
<td class="parameter_name"><p>listener_id</p></td>
|
601
|
+
<td class="parameter_description"><p>the id of the event listener to remove</p></td>
|
602
|
+
<td class="parameter_annotations"> </td>
|
521
603
|
</tr></tbody>
|
522
604
|
</table></div>
|
523
605
|
</div>
|
606
|
+
</div>
|
524
607
|
<hr>
|
525
608
|
<div class="refsect2">
|
526
|
-
<a name="atk-get-root"></a><h3>atk_get_root
|
527
|
-
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a>
|
528
|
-
<
|
529
|
-
Gets the root accessible container for the current application
|
530
|
-
|
531
|
-
<
|
532
|
-
<
|
533
|
-
|
534
|
-
<
|
535
|
-
|
536
|
-
application. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
|
537
|
-
</td>
|
538
|
-
</tr></tbody>
|
539
|
-
</table></div>
|
609
|
+
<a name="atk-get-root"></a><h3>atk_get_root ()</h3>
|
610
|
+
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
|
611
|
+
atk_get_root (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
612
|
+
<p>Gets the root accessible container for the current application.</p>
|
613
|
+
<div class="refsect3">
|
614
|
+
<a name="id-1.4.2.7.13.5"></a><h4>Returns</h4>
|
615
|
+
<p> the root accessible container for the current
|
616
|
+
application. </p>
|
617
|
+
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
|
618
|
+
</div>
|
540
619
|
</div>
|
541
620
|
<hr>
|
542
621
|
<div class="refsect2">
|
543
|
-
<a name="atk-get-focus-object"></a><h3>atk_get_focus_object
|
544
|
-
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a>
|
545
|
-
<
|
546
|
-
Gets the currently focused object
|
547
|
-
|
548
|
-
<
|
549
|
-
<
|
550
|
-
|
551
|
-
<
|
552
|
-
|
553
|
-
application. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
|
554
|
-
</td>
|
555
|
-
</tr></tbody>
|
556
|
-
</table></div>
|
622
|
+
<a name="atk-get-focus-object"></a><h3>atk_get_focus_object ()</h3>
|
623
|
+
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
|
624
|
+
atk_get_focus_object (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
625
|
+
<p>Gets the currently focused object.</p>
|
626
|
+
<div class="refsect3">
|
627
|
+
<a name="id-1.4.2.7.14.5"></a><h4>Returns</h4>
|
628
|
+
<p> the currently focused object for the current
|
629
|
+
application. </p>
|
630
|
+
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
|
631
|
+
</div>
|
557
632
|
<p class="since">Since 1.6</p>
|
558
633
|
</div>
|
559
634
|
<hr>
|
560
635
|
<div class="refsect2">
|
561
|
-
<a name="atk-get-toolkit-name"></a><h3>atk_get_toolkit_name
|
562
|
-
<pre class="programlisting">const <span class="returnvalue">gchar</span>
|
563
|
-
<
|
564
|
-
Gets name string for the GUI toolkit implementing ATK for this application
|
565
|
-
|
566
|
-
<
|
567
|
-
<
|
568
|
-
<
|
569
|
-
|
570
|
-
<td>name string for the GUI toolkit implementing ATK for this application</td>
|
571
|
-
</tr></tbody>
|
572
|
-
</table></div>
|
636
|
+
<a name="atk-get-toolkit-name"></a><h3>atk_get_toolkit_name ()</h3>
|
637
|
+
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
638
|
+
atk_get_toolkit_name (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
639
|
+
<p>Gets name string for the GUI toolkit implementing ATK for this application.</p>
|
640
|
+
<div class="refsect3">
|
641
|
+
<a name="id-1.4.2.7.15.5"></a><h4>Returns</h4>
|
642
|
+
<p> name string for the GUI toolkit implementing ATK for this application</p>
|
643
|
+
<p></p>
|
644
|
+
</div>
|
573
645
|
</div>
|
574
646
|
<hr>
|
575
647
|
<div class="refsect2">
|
576
|
-
<a name="atk-get-toolkit-version"></a><h3>atk_get_toolkit_version
|
577
|
-
<pre class="programlisting">const <span class="returnvalue">gchar</span>
|
578
|
-
<
|
579
|
-
Gets version string for the GUI toolkit implementing ATK for this application
|
580
|
-
|
581
|
-
<
|
582
|
-
<
|
583
|
-
<
|
584
|
-
|
585
|
-
<td>version string for the GUI toolkit implementing ATK for this application</td>
|
586
|
-
</tr></tbody>
|
587
|
-
</table></div>
|
648
|
+
<a name="atk-get-toolkit-version"></a><h3>atk_get_toolkit_version ()</h3>
|
649
|
+
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
650
|
+
atk_get_toolkit_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
651
|
+
<p>Gets version string for the GUI toolkit implementing ATK for this application.</p>
|
652
|
+
<div class="refsect3">
|
653
|
+
<a name="id-1.4.2.7.16.5"></a><h4>Returns</h4>
|
654
|
+
<p> version string for the GUI toolkit implementing ATK for this application</p>
|
655
|
+
<p></p>
|
656
|
+
</div>
|
588
657
|
</div>
|
589
658
|
<hr>
|
590
659
|
<div class="refsect2">
|
591
|
-
<a name="atk-get-version"></a><h3>atk_get_version
|
592
|
-
<pre class="programlisting">const <span class="returnvalue">gchar</span>
|
593
|
-
<
|
594
|
-
Gets the current version for ATK
|
595
|
-
|
596
|
-
<
|
597
|
-
<
|
598
|
-
<
|
599
|
-
|
600
|
-
<td>version string for ATK</td>
|
601
|
-
</tr></tbody>
|
602
|
-
</table></div>
|
660
|
+
<a name="atk-get-version"></a><h3>atk_get_version ()</h3>
|
661
|
+
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
|
662
|
+
atk_get_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
663
|
+
<p>Gets the current version for ATK.</p>
|
664
|
+
<div class="refsect3">
|
665
|
+
<a name="id-1.4.2.7.17.5"></a><h4>Returns</h4>
|
666
|
+
<p> version string for ATK</p>
|
667
|
+
<p></p>
|
668
|
+
</div>
|
603
669
|
<p class="since">Since 1.20</p>
|
604
670
|
</div>
|
605
671
|
<hr>
|
@@ -607,30 +673,39 @@ Gets the current version for ATK.
|
|
607
673
|
<a name="ATK-DEFINE-TYPE:CAPS"></a><h3>ATK_DEFINE_TYPE()</h3>
|
608
674
|
<pre class="programlisting">#define ATK_DEFINE_TYPE(TN, t_n, T_P) ATK_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
|
609
675
|
</pre>
|
610
|
-
<p>
|
611
|
-
A convenience macro for type ATK implementations, which declares a class
|
676
|
+
<p>A convenience macro for type ATK implementations, which declares a class
|
612
677
|
initialization function, an instance initialization function (see <span class="type">GTypeInfo</span>
|
613
678
|
for information about these) and a static variable named
|
614
|
-
<em class="parameter"><code>t_n</code></em>
|
615
|
-
|
616
|
-
</p>
|
617
|
-
<div class="
|
618
|
-
<
|
679
|
+
<em class="parameter"><code>t_n</code></em>
|
680
|
+
_parent_class pointing to the parent class. Furthermore, it
|
681
|
+
defines a <code class="function">_get_type()</code> function.</p>
|
682
|
+
<div class="refsect3">
|
683
|
+
<a name="id-1.4.2.7.18.5"></a><h4>Parameters</h4>
|
684
|
+
<div class="informaltable"><table width="100%" border="0">
|
685
|
+
<colgroup>
|
686
|
+
<col width="150px" class="parameters_name">
|
687
|
+
<col class="parameters_description">
|
688
|
+
<col width="200px" class="parameters_annotations">
|
689
|
+
</colgroup>
|
619
690
|
<tbody>
|
620
691
|
<tr>
|
621
|
-
<td
|
622
|
-
<td>The name of the new type, in Camel case.</td>
|
692
|
+
<td class="parameter_name"><p>TN</p></td>
|
693
|
+
<td class="parameter_description"><p>The name of the new type, in Camel case.</p></td>
|
694
|
+
<td class="parameter_annotations"> </td>
|
623
695
|
</tr>
|
624
696
|
<tr>
|
625
|
-
<td
|
626
|
-
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
|
697
|
+
<td class="parameter_name"><p>t_n</p></td>
|
698
|
+
<td class="parameter_description"><p>The name of the new type, in lowercase, with words separated by '_'.</p></td>
|
699
|
+
<td class="parameter_annotations"> </td>
|
627
700
|
</tr>
|
628
701
|
<tr>
|
629
|
-
<td
|
630
|
-
<td>The <span class="type">GType</span> of the parent type.</td>
|
702
|
+
<td class="parameter_name"><p>T_P</p></td>
|
703
|
+
<td class="parameter_description"><p>The <span class="type">GType</span> of the parent type.</p></td>
|
704
|
+
<td class="parameter_annotations"> </td>
|
631
705
|
</tr>
|
632
706
|
</tbody>
|
633
707
|
</table></div>
|
708
|
+
</div>
|
634
709
|
<p class="since">Since 1.22</p>
|
635
710
|
</div>
|
636
711
|
<hr>
|
@@ -638,37 +713,45 @@ defines a <code class="function">_get_type()</code> function.
|
|
638
713
|
<a name="ATK-DEFINE-TYPE-EXTENDED:CAPS"></a><h3>ATK_DEFINE_TYPE_EXTENDED()</h3>
|
639
714
|
<pre class="programlisting">#define ATK_DEFINE_TYPE_EXTENDED(TN, t_n, T_P, _f_, _C_) _ATK_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, _f_) {_C_;} _ATK_DEFINE_TYPE_EXTENDED_END()
|
640
715
|
</pre>
|
641
|
-
<p>
|
642
|
-
|
643
|
-
<
|
644
|
-
</
|
645
|
-
<div class="
|
646
|
-
<
|
716
|
+
<p>The most general convenience macro for ATK type implementations, on which
|
717
|
+
<a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE:CAPS" title="ATK_DEFINE_TYPE()"><code class="function">ATK_DEFINE_TYPE()</code></a>, etc are based.</p>
|
718
|
+
<div class="refsect3">
|
719
|
+
<a name="id-1.4.2.7.19.5"></a><h4>Parameters</h4>
|
720
|
+
<div class="informaltable"><table width="100%" border="0">
|
721
|
+
<colgroup>
|
722
|
+
<col width="150px" class="parameters_name">
|
723
|
+
<col class="parameters_description">
|
724
|
+
<col width="200px" class="parameters_annotations">
|
725
|
+
</colgroup>
|
647
726
|
<tbody>
|
648
727
|
<tr>
|
649
|
-
<td
|
650
|
-
<td>The name of the new type, in Camel case.</td>
|
728
|
+
<td class="parameter_name"><p>TN</p></td>
|
729
|
+
<td class="parameter_description"><p>The name of the new type, in Camel case.</p></td>
|
730
|
+
<td class="parameter_annotations"> </td>
|
651
731
|
</tr>
|
652
732
|
<tr>
|
653
|
-
<td
|
654
|
-
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
|
733
|
+
<td class="parameter_name"><p>t_n</p></td>
|
734
|
+
<td class="parameter_description"><p>The name of the new type, in lowercase, with words separated by '_'.</p></td>
|
735
|
+
<td class="parameter_annotations"> </td>
|
655
736
|
</tr>
|
656
737
|
<tr>
|
657
|
-
<td
|
658
|
-
<td>The <span class="type">GType</span> of the parent type.</td>
|
738
|
+
<td class="parameter_name"><p>T_P</p></td>
|
739
|
+
<td class="parameter_description"><p>The <span class="type">GType</span> of the parent type.</p></td>
|
740
|
+
<td class="parameter_annotations"> </td>
|
659
741
|
</tr>
|
660
742
|
<tr>
|
661
|
-
<td
|
662
|
-
<td>
|
663
|
-
<
|
664
|
-
</td>
|
743
|
+
<td class="parameter_name"><p>_f_</p></td>
|
744
|
+
<td class="parameter_description"><p><span class="type">GTypeFlags</span> to pass to <code class="function">g_type_register_static()</code></p></td>
|
745
|
+
<td class="parameter_annotations"> </td>
|
665
746
|
</tr>
|
666
747
|
<tr>
|
667
|
-
<td
|
668
|
-
<td>Custom code that gets inserted in the <code class="function">_get_type()</code> function.</td>
|
748
|
+
<td class="parameter_name"><p>_C_</p></td>
|
749
|
+
<td class="parameter_description"><p>Custom code that gets inserted in the <code class="function">_get_type()</code> function.</p></td>
|
750
|
+
<td class="parameter_annotations"> </td>
|
669
751
|
</tr>
|
670
752
|
</tbody>
|
671
753
|
</table></div>
|
754
|
+
</div>
|
672
755
|
<p class="since">Since 1.22</p>
|
673
756
|
</div>
|
674
757
|
<hr>
|
@@ -676,32 +759,41 @@ The most general convenience macro for ATK type implementations, on which
|
|
676
759
|
<a name="ATK-DEFINE-TYPE-WITH-CODE:CAPS"></a><h3>ATK_DEFINE_TYPE_WITH_CODE()</h3>
|
677
760
|
<pre class="programlisting">#define ATK_DEFINE_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _ATK_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, 0) {_C_;} _ATK_DEFINE_TYPE_EXTENDED_END()
|
678
761
|
</pre>
|
679
|
-
<p>
|
680
|
-
A convenience macro for ATK type implementations.
|
762
|
+
<p>A convenience macro for ATK type implementations.
|
681
763
|
Similar to <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE:CAPS" title="ATK_DEFINE_TYPE()"><code class="function">ATK_DEFINE_TYPE()</code></a>, but allows you to insert custom code into the
|
682
|
-
<code class="function">_get_type()</code> function, e.g. interface implementations via <code class="function">G_IMPLEMENT_INTERFACE()</code
|
683
|
-
|
684
|
-
<
|
685
|
-
<
|
764
|
+
<code class="function">_get_type()</code> function, e.g. interface implementations via <code class="function">G_IMPLEMENT_INTERFACE()</code>.</p>
|
765
|
+
<div class="refsect3">
|
766
|
+
<a name="id-1.4.2.7.20.5"></a><h4>Parameters</h4>
|
767
|
+
<div class="informaltable"><table width="100%" border="0">
|
768
|
+
<colgroup>
|
769
|
+
<col width="150px" class="parameters_name">
|
770
|
+
<col class="parameters_description">
|
771
|
+
<col width="200px" class="parameters_annotations">
|
772
|
+
</colgroup>
|
686
773
|
<tbody>
|
687
774
|
<tr>
|
688
|
-
<td
|
689
|
-
<td>The name of the new type, in Camel case.</td>
|
775
|
+
<td class="parameter_name"><p>TN</p></td>
|
776
|
+
<td class="parameter_description"><p>The name of the new type, in Camel case.</p></td>
|
777
|
+
<td class="parameter_annotations"> </td>
|
690
778
|
</tr>
|
691
779
|
<tr>
|
692
|
-
<td
|
693
|
-
<td>The name of the new type in lowercase, with words separated by '_'.</td>
|
780
|
+
<td class="parameter_name"><p>t_n</p></td>
|
781
|
+
<td class="parameter_description"><p>The name of the new type in lowercase, with words separated by '_'.</p></td>
|
782
|
+
<td class="parameter_annotations"> </td>
|
694
783
|
</tr>
|
695
784
|
<tr>
|
696
|
-
<td
|
697
|
-
<td>The <span class="type">GType</span> of the parent type.</td>
|
785
|
+
<td class="parameter_name"><p>T_P</p></td>
|
786
|
+
<td class="parameter_description"><p>The <span class="type">GType</span> of the parent type.</p></td>
|
787
|
+
<td class="parameter_annotations"> </td>
|
698
788
|
</tr>
|
699
789
|
<tr>
|
700
|
-
<td
|
701
|
-
<td>Custom code that gets inserted in the <code class="function">_get_type()</code> function.</td>
|
790
|
+
<td class="parameter_name"><p>_C_</p></td>
|
791
|
+
<td class="parameter_description"><p>Custom code that gets inserted in the <code class="function">_get_type()</code> function.</p></td>
|
792
|
+
<td class="parameter_annotations"> </td>
|
702
793
|
</tr>
|
703
794
|
</tbody>
|
704
795
|
</table></div>
|
796
|
+
</div>
|
705
797
|
<p class="since">Since 1.22</p>
|
706
798
|
</div>
|
707
799
|
<hr>
|
@@ -709,27 +801,35 @@ Similar to <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE:CAPS" title="ATK_D
|
|
709
801
|
<a name="ATK-DEFINE-ABSTRACT-TYPE:CAPS"></a><h3>ATK_DEFINE_ABSTRACT_TYPE()</h3>
|
710
802
|
<pre class="programlisting">#define ATK_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P) ATK_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
|
711
803
|
</pre>
|
712
|
-
<p>
|
713
|
-
|
714
|
-
|
715
|
-
</
|
716
|
-
<div class="
|
717
|
-
<
|
804
|
+
<p>A convenience macro for ATK type implementations.
|
805
|
+
Similar to <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE:CAPS" title="ATK_DEFINE_TYPE()"><code class="function">ATK_DEFINE_TYPE()</code></a>, but defines an abstract type.</p>
|
806
|
+
<div class="refsect3">
|
807
|
+
<a name="id-1.4.2.7.21.5"></a><h4>Parameters</h4>
|
808
|
+
<div class="informaltable"><table width="100%" border="0">
|
809
|
+
<colgroup>
|
810
|
+
<col width="150px" class="parameters_name">
|
811
|
+
<col class="parameters_description">
|
812
|
+
<col width="200px" class="parameters_annotations">
|
813
|
+
</colgroup>
|
718
814
|
<tbody>
|
719
815
|
<tr>
|
720
|
-
<td
|
721
|
-
<td>The name of the new type, in Camel case.</td>
|
816
|
+
<td class="parameter_name"><p>TN</p></td>
|
817
|
+
<td class="parameter_description"><p>The name of the new type, in Camel case.</p></td>
|
818
|
+
<td class="parameter_annotations"> </td>
|
722
819
|
</tr>
|
723
820
|
<tr>
|
724
|
-
<td
|
725
|
-
<td>The name of the new type, in lowercase, with words separated by '_'.</td>
|
821
|
+
<td class="parameter_name"><p>t_n</p></td>
|
822
|
+
<td class="parameter_description"><p>The name of the new type, in lowercase, with words separated by '_'.</p></td>
|
823
|
+
<td class="parameter_annotations"> </td>
|
726
824
|
</tr>
|
727
825
|
<tr>
|
728
|
-
<td
|
729
|
-
<td>The <span class="type">GType</span> of the parent type.</td>
|
826
|
+
<td class="parameter_name"><p>T_P</p></td>
|
827
|
+
<td class="parameter_description"><p>The <span class="type">GType</span> of the parent type.</p></td>
|
828
|
+
<td class="parameter_annotations"> </td>
|
730
829
|
</tr>
|
731
830
|
</tbody>
|
732
831
|
</table></div>
|
832
|
+
</div>
|
733
833
|
<p class="since">Since 1.22</p>
|
734
834
|
</div>
|
735
835
|
<hr>
|
@@ -737,37 +837,275 @@ Similar to <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE:CAPS" title="ATK_D
|
|
737
837
|
<a name="ATK-DEFINE-ABSTRACT-TYPE-WITH-CODE:CAPS"></a><h3>ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE()</h3>
|
738
838
|
<pre class="programlisting">#define ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _ATK_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT) {_C_;} _ATK_DEFINE_TYPE_EXTENDED_END()
|
739
839
|
</pre>
|
840
|
+
<p>A convenience macro for ATK type implementations.
|
841
|
+
Similar to <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE-WITH-CODE:CAPS" title="ATK_DEFINE_TYPE_WITH_CODE()"><code class="function">ATK_DEFINE_TYPE_WITH_CODE()</code></a>, but defines an abstract type.</p>
|
842
|
+
<div class="refsect3">
|
843
|
+
<a name="id-1.4.2.7.22.5"></a><h4>Parameters</h4>
|
844
|
+
<div class="informaltable"><table width="100%" border="0">
|
845
|
+
<colgroup>
|
846
|
+
<col width="150px" class="parameters_name">
|
847
|
+
<col class="parameters_description">
|
848
|
+
<col width="200px" class="parameters_annotations">
|
849
|
+
</colgroup>
|
850
|
+
<tbody>
|
851
|
+
<tr>
|
852
|
+
<td class="parameter_name"><p>TN</p></td>
|
853
|
+
<td class="parameter_description"><p>The name of the new type, in Camel case.</p></td>
|
854
|
+
<td class="parameter_annotations"> </td>
|
855
|
+
</tr>
|
856
|
+
<tr>
|
857
|
+
<td class="parameter_name"><p>t_n</p></td>
|
858
|
+
<td class="parameter_description"><p>The name of the new type, in lowercase, with words separated by '_'.</p></td>
|
859
|
+
<td class="parameter_annotations"> </td>
|
860
|
+
</tr>
|
861
|
+
<tr>
|
862
|
+
<td class="parameter_name"><p>T_P</p></td>
|
863
|
+
<td class="parameter_description"><p>The <span class="type">GType</span> of the parent type.</p></td>
|
864
|
+
<td class="parameter_annotations"> </td>
|
865
|
+
</tr>
|
866
|
+
<tr>
|
867
|
+
<td class="parameter_name"><p>_C_</p></td>
|
868
|
+
<td class="parameter_description"><p>Custom code that gets inserted in the <code class="function">_get_type()</code> function.</p></td>
|
869
|
+
<td class="parameter_annotations"> </td>
|
870
|
+
</tr>
|
871
|
+
</tbody>
|
872
|
+
</table></div>
|
873
|
+
</div>
|
874
|
+
<p class="since">Since 1.22</p>
|
875
|
+
</div>
|
876
|
+
</div>
|
877
|
+
<div class="refsect1">
|
878
|
+
<a name="AtkUtil.other_details"></a><h2>Types and Values</h2>
|
879
|
+
<div class="refsect2">
|
880
|
+
<a name="AtkUtil-struct"></a><h3>struct AtkUtil</h3>
|
881
|
+
<pre class="programlisting">struct AtkUtil;</pre>
|
740
882
|
<p>
|
741
|
-
A convenience macro for ATK type implementations.
|
742
|
-
Similar to <a class="link" href="AtkUtil.html#ATK-DEFINE-TYPE-WITH-CODE:CAPS" title="ATK_DEFINE_TYPE_WITH_CODE()"><code class="function">ATK_DEFINE_TYPE_WITH_CODE()</code></a>, but defines an abstract type.
|
743
883
|
</p>
|
744
|
-
|
745
|
-
<
|
884
|
+
</div>
|
885
|
+
<hr>
|
886
|
+
<div class="refsect2">
|
887
|
+
<a name="AtkUtilClass"></a><h3>struct AtkUtilClass</h3>
|
888
|
+
<pre class="programlisting">struct AtkUtilClass {
|
889
|
+
GObjectClass parent;
|
890
|
+
guint (* add_global_event_listener) (GSignalEmissionHook listener,
|
891
|
+
const gchar *event_type);
|
892
|
+
void (* remove_global_event_listener) (guint listener_id);
|
893
|
+
guint (* add_key_event_listener) (AtkKeySnoopFunc listener,
|
894
|
+
gpointer data);
|
895
|
+
void (* remove_key_event_listener) (guint listener_id);
|
896
|
+
AtkObject* (* get_root) (void);
|
897
|
+
const gchar* (* get_toolkit_name) (void);
|
898
|
+
const gchar* (* get_toolkit_version) (void);
|
899
|
+
};
|
900
|
+
</pre>
|
901
|
+
<div class="refsect3">
|
902
|
+
<a name="id-1.4.2.8.3.4"></a><h4>Members</h4>
|
903
|
+
<div class="informaltable"><table width="100%" border="0">
|
904
|
+
<colgroup>
|
905
|
+
<col width="300px" class="struct_members_name">
|
906
|
+
<col class="struct_members_description">
|
907
|
+
<col width="200px" class="struct_members_annotations">
|
908
|
+
</colgroup>
|
746
909
|
<tbody>
|
747
910
|
<tr>
|
748
|
-
<td><p><span class="
|
749
|
-
<td>
|
911
|
+
<td class="struct_member_name"><p><span class="type">GObjectClass</span> <em class="structfield"><code><a name="AtkUtilClass.parent"></a>parent</code></em>;</p></td>
|
912
|
+
<td class="struct_member_description"> </td>
|
913
|
+
<td class="struct_member_annotations"> </td>
|
914
|
+
</tr>
|
915
|
+
<tr>
|
916
|
+
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkUtilClass.add-global-event-listener"></a>add_global_event_listener</code></em> ()</p></td>
|
917
|
+
<td class="struct_member_description"><p>adds the specified function to the list
|
918
|
+
of functions to be called when an ATK event occurs. ATK
|
919
|
+
implementors are discouraged from reimplementing this method.</p></td>
|
920
|
+
<td class="struct_member_annotations"> </td>
|
921
|
+
</tr>
|
922
|
+
<tr>
|
923
|
+
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkUtilClass.remove-global-event-listener"></a>remove_global_event_listener</code></em> ()</p></td>
|
924
|
+
<td class="struct_member_description"><p>removes the specified function to
|
925
|
+
the list of functions to be called when an ATK event occurs. ATK
|
926
|
+
implementors are discouraged from reimplementing this method.</p></td>
|
927
|
+
<td class="struct_member_annotations"> </td>
|
750
928
|
</tr>
|
751
929
|
<tr>
|
752
|
-
<td
|
753
|
-
<td>
|
930
|
+
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkUtilClass.add-key-event-listener"></a>add_key_event_listener</code></em> ()</p></td>
|
931
|
+
<td class="struct_member_description"><p>adds the specified function to the list of
|
932
|
+
functions to be called when a key event occurs.</p></td>
|
933
|
+
<td class="struct_member_annotations"> </td>
|
754
934
|
</tr>
|
755
935
|
<tr>
|
756
|
-
<td
|
757
|
-
<td
|
936
|
+
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkUtilClass.remove-key-event-listener"></a>remove_key_event_listener</code></em> ()</p></td>
|
937
|
+
<td class="struct_member_description"><p>remove the specified function to the
|
938
|
+
list of functions to be called when a key event occurs.</p></td>
|
939
|
+
<td class="struct_member_annotations"> </td>
|
758
940
|
</tr>
|
759
941
|
<tr>
|
760
|
-
<td
|
761
|
-
<td>
|
942
|
+
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkUtilClass.get-root"></a>get_root</code></em> ()</p></td>
|
943
|
+
<td class="struct_member_description"><p>gets the root accessible container for the current
|
944
|
+
application.</p></td>
|
945
|
+
<td class="struct_member_annotations"> </td>
|
946
|
+
</tr>
|
947
|
+
<tr>
|
948
|
+
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkUtilClass.get-toolkit-name"></a>get_toolkit_name</code></em> ()</p></td>
|
949
|
+
<td class="struct_member_description"><p>gets name string for the GUI toolkit
|
950
|
+
implementing ATK for this application.</p></td>
|
951
|
+
<td class="struct_member_annotations"> </td>
|
952
|
+
</tr>
|
953
|
+
<tr>
|
954
|
+
<td class="struct_member_name"><p><em class="structfield"><code><a name="AtkUtilClass.get-toolkit-version"></a>get_toolkit_version</code></em> ()</p></td>
|
955
|
+
<td class="struct_member_description"><p>gets version string for the GUI toolkit
|
956
|
+
implementing ATK for this application.</p></td>
|
957
|
+
<td class="struct_member_annotations"> </td>
|
762
958
|
</tr>
|
763
959
|
</tbody>
|
764
960
|
</table></div>
|
765
|
-
|
961
|
+
</div>
|
962
|
+
</div>
|
963
|
+
<hr>
|
964
|
+
<div class="refsect2">
|
965
|
+
<a name="AtkCoordType"></a><h3>enum AtkCoordType</h3>
|
966
|
+
<p>Specifies how xy coordinates are to be interpreted. Used by functions such
|
967
|
+
as <a class="link" href="AtkComponent.html#atk-component-get-position" title="atk_component_get_position ()"><code class="function">atk_component_get_position()</code></a> and <a class="link" href="AtkText.html#atk-text-get-character-extents" title="atk_text_get_character_extents ()"><code class="function">atk_text_get_character_extents()</code></a></p>
|
968
|
+
<div class="refsect3">
|
969
|
+
<a name="id-1.4.2.8.4.4"></a><h4>Members</h4>
|
970
|
+
<div class="informaltable"><table width="100%" border="0">
|
971
|
+
<colgroup>
|
972
|
+
<col width="300px" class="enum_members_name">
|
973
|
+
<col class="enum_members_description">
|
974
|
+
<col width="200px" class="enum_members_annotations">
|
975
|
+
</colgroup>
|
976
|
+
<tbody>
|
977
|
+
<tr>
|
978
|
+
<td class="enum_member_name"><p><a name="ATK-XY-SCREEN:CAPS"></a>ATK_XY_SCREEN</p></td>
|
979
|
+
<td class="enum_member_description">
|
980
|
+
<p>specifies xy coordinates relative to the screen</p>
|
981
|
+
</td>
|
982
|
+
<td class="enum_member_annotations"> </td>
|
983
|
+
</tr>
|
984
|
+
<tr>
|
985
|
+
<td class="enum_member_name"><p><a name="ATK-XY-WINDOW:CAPS"></a>ATK_XY_WINDOW</p></td>
|
986
|
+
<td class="enum_member_description">
|
987
|
+
<p>specifies xy coordinates relative to the widget's
|
988
|
+
top-level window</p>
|
989
|
+
</td>
|
990
|
+
<td class="enum_member_annotations"> </td>
|
991
|
+
</tr>
|
992
|
+
</tbody>
|
993
|
+
</table></div>
|
994
|
+
</div>
|
995
|
+
</div>
|
996
|
+
<hr>
|
997
|
+
<div class="refsect2">
|
998
|
+
<a name="AtkKeyEventStruct"></a><h3>struct AtkKeyEventStruct</h3>
|
999
|
+
<pre class="programlisting">struct AtkKeyEventStruct {
|
1000
|
+
gint type;
|
1001
|
+
guint state;
|
1002
|
+
guint keyval;
|
1003
|
+
gint length;
|
1004
|
+
gchar *string;
|
1005
|
+
guint16 keycode;
|
1006
|
+
guint32 timestamp;
|
1007
|
+
};
|
1008
|
+
</pre>
|
1009
|
+
<p>Encapsulates information about a key event.</p>
|
1010
|
+
<div class="refsect3">
|
1011
|
+
<a name="id-1.4.2.8.5.5"></a><h4>Members</h4>
|
1012
|
+
<div class="informaltable"><table width="100%" border="0">
|
1013
|
+
<colgroup>
|
1014
|
+
<col width="300px" class="struct_members_name">
|
1015
|
+
<col class="struct_members_description">
|
1016
|
+
<col width="200px" class="struct_members_annotations">
|
1017
|
+
</colgroup>
|
1018
|
+
<tbody>
|
1019
|
+
<tr>
|
1020
|
+
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="AtkKeyEventStruct.type"></a>type</code></em>;</p></td>
|
1021
|
+
<td class="struct_member_description"><p>An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE</p></td>
|
1022
|
+
<td class="struct_member_annotations"> </td>
|
1023
|
+
</tr>
|
1024
|
+
<tr>
|
1025
|
+
<td class="struct_member_name"><p><span class="type">guint</span> <em class="structfield"><code><a name="AtkKeyEventStruct.state"></a>state</code></em>;</p></td>
|
1026
|
+
<td class="struct_member_description"><p>A bitmask representing the state of the modifier keys immediately after the event takes place.
|
1027
|
+
The meaning of the bits is currently defined to match the bitmask used by GDK in
|
1028
|
+
GdkEventType.state, see
|
1029
|
+
http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html<span class="type">GdkEventKey</span></p></td>
|
1030
|
+
<td class="struct_member_annotations"> </td>
|
1031
|
+
</tr>
|
1032
|
+
<tr>
|
1033
|
+
<td class="struct_member_name"><p><span class="type">guint</span> <em class="structfield"><code><a name="AtkKeyEventStruct.keyval"></a>keyval</code></em>;</p></td>
|
1034
|
+
<td class="struct_member_description"><p>A guint representing a keysym value corresponding to those used by GDK and X11: see
|
1035
|
+
/usr/X11/include/keysymdef.h.</p></td>
|
1036
|
+
<td class="struct_member_annotations"> </td>
|
1037
|
+
</tr>
|
1038
|
+
<tr>
|
1039
|
+
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="AtkKeyEventStruct.length"></a>length</code></em>;</p></td>
|
1040
|
+
<td class="struct_member_description"><p>The length of member <span class="type">string</span>.</p></td>
|
1041
|
+
<td class="struct_member_annotations"> </td>
|
1042
|
+
</tr>
|
1043
|
+
<tr>
|
1044
|
+
<td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="AtkKeyEventStruct.string"></a>string</code></em>;</p></td>
|
1045
|
+
<td class="struct_member_description"><p>A string containing one of the following: either a string approximating the text that would
|
1046
|
+
result from this keypress, if the key is a control or graphic character, or a symbolic name for this keypress.
|
1047
|
+
Alphanumeric and printable keys will have the symbolic key name in this string member, for instance "A". "0",
|
1048
|
+
"semicolon", "aacute". Keypad keys have the prefix "KP".</p></td>
|
1049
|
+
<td class="struct_member_annotations"> </td>
|
1050
|
+
</tr>
|
1051
|
+
<tr>
|
1052
|
+
<td class="struct_member_name"><p><span class="type">guint16</span> <em class="structfield"><code><a name="AtkKeyEventStruct.keycode"></a>keycode</code></em>;</p></td>
|
1053
|
+
<td class="struct_member_description"><p>The raw hardware code that generated the key event. This field is raraly useful.</p></td>
|
1054
|
+
<td class="struct_member_annotations"> </td>
|
1055
|
+
</tr>
|
1056
|
+
<tr>
|
1057
|
+
<td class="struct_member_name"><p><span class="type">guint32</span> <em class="structfield"><code><a name="AtkKeyEventStruct.timestamp"></a>timestamp</code></em>;</p></td>
|
1058
|
+
<td class="struct_member_description"><p>A timestamp in milliseconds indicating when the event occurred.
|
1059
|
+
These timestamps are relative to a starting point which should be considered arbitrary,
|
1060
|
+
and only used to compare the dispatch times of events to one another.</p></td>
|
1061
|
+
<td class="struct_member_annotations"> </td>
|
1062
|
+
</tr>
|
1063
|
+
</tbody>
|
1064
|
+
</table></div>
|
1065
|
+
</div>
|
1066
|
+
</div>
|
1067
|
+
<hr>
|
1068
|
+
<div class="refsect2">
|
1069
|
+
<a name="AtkKeyEventType"></a><h3>enum AtkKeyEventType</h3>
|
1070
|
+
<p>Specifies the type of a keyboard evemt.</p>
|
1071
|
+
<div class="refsect3">
|
1072
|
+
<a name="id-1.4.2.8.6.4"></a><h4>Members</h4>
|
1073
|
+
<div class="informaltable"><table width="100%" border="0">
|
1074
|
+
<colgroup>
|
1075
|
+
<col width="300px" class="enum_members_name">
|
1076
|
+
<col class="enum_members_description">
|
1077
|
+
<col width="200px" class="enum_members_annotations">
|
1078
|
+
</colgroup>
|
1079
|
+
<tbody>
|
1080
|
+
<tr>
|
1081
|
+
<td class="enum_member_name"><p><a name="ATK-KEY-EVENT-PRESS:CAPS"></a>ATK_KEY_EVENT_PRESS</p></td>
|
1082
|
+
<td class="enum_member_description">
|
1083
|
+
<p>specifies a key press event</p>
|
1084
|
+
</td>
|
1085
|
+
<td class="enum_member_annotations"> </td>
|
1086
|
+
</tr>
|
1087
|
+
<tr>
|
1088
|
+
<td class="enum_member_name"><p><a name="ATK-KEY-EVENT-RELEASE:CAPS"></a>ATK_KEY_EVENT_RELEASE</p></td>
|
1089
|
+
<td class="enum_member_description">
|
1090
|
+
<p>specifies a key release event</p>
|
1091
|
+
</td>
|
1092
|
+
<td class="enum_member_annotations"> </td>
|
1093
|
+
</tr>
|
1094
|
+
<tr>
|
1095
|
+
<td class="enum_member_name"><p><a name="ATK-KEY-EVENT-LAST-DEFINED:CAPS"></a>ATK_KEY_EVENT_LAST_DEFINED</p></td>
|
1096
|
+
<td class="enum_member_description">
|
1097
|
+
<p>Not a valid value; specifies end of enumeration</p>
|
1098
|
+
</td>
|
1099
|
+
<td class="enum_member_annotations"> </td>
|
1100
|
+
</tr>
|
1101
|
+
</tbody>
|
1102
|
+
</table></div>
|
1103
|
+
</div>
|
766
1104
|
</div>
|
767
1105
|
</div>
|
768
1106
|
</div>
|
769
1107
|
<div class="footer">
|
770
1108
|
<hr>
|
771
|
-
Generated by GTK-Doc V1.
|
1109
|
+
Generated by GTK-Doc V1.21.1</div>
|
772
1110
|
</body>
|
773
1111
|
</html>
|