~ubuntu-branches/ubuntu/precise/atk1.0/precise

« back to all changes in this revision

Viewing changes to docs/html/AtkObject.html

  • Committer: Package Import Robot
  • Author(s): Luke Yelavich
  • Date: 2012-03-07 09:14:51 UTC
  • mfrom: (1.2.41)
  • Revision ID: package-import@ubuntu.com-20120307091451-lvrxjpc5wy2okfyt
Tags: 2.3.91-0ubuntu1
* New upstream release
  - Bug 665549: add sanity-check of atk_text_get_text
  - Bug 668441: atk_action_get_keybinding docs are confusing and need
    updating
  - Using abstract atk_object_get_name to check accessible-name
    notification
  - Updated Belarusian, Estonian, Hungarian, Turkish, Norwegian,
    Ukranian and Uyghur translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="atk.html" title="ATK Library">
9
9
<link rel="prev" href="AtkNoOpObjectFactory.html" title="AtkNoOpObjectFactory">
10
10
<link rel="next" href="AtkObjectFactory.html" title="AtkObjectFactory">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.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">
45
45
<a name="AtkObject.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">struct              <a class="link" href="AtkObject.html#AtkObject-struct" title="struct AtkObject">AtkObject</a>;
47
47
enum                <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole">AtkRole</a>;
48
 
<a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             <a class="link" href="AtkObject.html#atk-role-register" title="atk_role_register ()">atk_role_register</a>                   (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
 
48
<a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             <a class="link" href="AtkObject.html#atk-role-register" title="atk_role_register ()">atk_role_register</a>                   (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
49
49
enum                <a class="link" href="AtkObject.html#AtkLayer" title="enum AtkLayer">AtkLayer</a>;
50
50
                    <a class="link" href="AtkObject.html#AtkImplementor" title="AtkImplementor">AtkImplementor</a>;
51
51
                    <a class="link" href="AtkObject.html#AtkPropertyValues" title="AtkPropertyValues">AtkPropertyValues</a>;
52
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="AtkObject.html#AtkFunction" title="AtkFunction ()">*AtkFunction</a>)                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
 
52
<span class="returnvalue">gboolean</span>            (<a class="link" href="AtkObject.html#AtkFunction" title="AtkFunction ()">*AtkFunction</a>)                      (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
53
53
<span class="returnvalue">void</span>                (<a class="link" href="AtkObject.html#AtkPropertyChangeHandler" title="AtkPropertyChangeHandler ()">*AtkPropertyChangeHandler</a>)         (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *Param1</code></em>,
54
54
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html#AtkPropertyValues" title="AtkPropertyValues"><span class="type">AtkPropertyValues</span></a> *Param2</code></em>);
55
55
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *         <a class="link" href="AtkObject.html#atk-implementor-ref-accessible" title="atk_implementor_ref_accessible ()">atk_implementor_ref_accessible</a>      (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkImplementor" title="AtkImplementor"><span class="type">AtkImplementor</span></a> *implementor</code></em>);
56
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkObject.html#atk-object-get-name" title="atk_object_get_name ()">atk_object_get_name</a>                 (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
57
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkObject.html#atk-object-get-description" title="atk_object_get_description ()">atk_object_get_description</a>          (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
 
56
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkObject.html#atk-object-get-name" title="atk_object_get_name ()">atk_object_get_name</a>                 (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
 
57
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkObject.html#atk-object-get-description" title="atk_object_get_description ()">atk_object_get_description</a>          (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
58
58
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *         <a class="link" href="AtkObject.html#atk-object-get-parent" title="atk_object_get_parent ()">atk_object_get_parent</a>               (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
59
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="AtkObject.html#atk-object-get-n-accessible-children" title="atk_object_get_n_accessible_children ()">atk_object_get_n_accessible_children</a>
 
59
<span class="returnvalue">gint</span>                <a class="link" href="AtkObject.html#atk-object-get-n-accessible-children" title="atk_object_get_n_accessible_children ()">atk_object_get_n_accessible_children</a>
60
60
                                                        (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
61
61
<a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *         <a class="link" href="AtkObject.html#atk-object-ref-accessible-child" title="atk_object_ref_accessible_child ()">atk_object_ref_accessible_child</a>     (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
62
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
 
62
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);
63
63
<a class="link" href="AtkRelationSet.html" title="AtkRelationSet"><span class="returnvalue">AtkRelationSet</span></a> *    <a class="link" href="AtkObject.html#atk-object-ref-relation-set" title="atk_object_ref_relation_set ()">atk_object_ref_relation_set</a>         (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
64
64
<a class="link" href="AtkObject.html#AtkLayer" title="enum AtkLayer"><span class="returnvalue">AtkLayer</span></a>            <a class="link" href="AtkObject.html#atk-object-get-layer" title="atk_object_get_layer ()">atk_object_get_layer</a>                (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
65
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="AtkObject.html#atk-object-get-mdi-zorder" title="atk_object_get_mdi_zorder ()">atk_object_get_mdi_zorder</a>           (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
 
65
<span class="returnvalue">gint</span>                <a class="link" href="AtkObject.html#atk-object-get-mdi-zorder" title="atk_object_get_mdi_zorder ()">atk_object_get_mdi_zorder</a>           (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
66
66
<a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             <a class="link" href="AtkObject.html#atk-object-get-role" title="atk_object_get_role ()">atk_object_get_role</a>                 (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
67
67
<a class="link" href="AtkStateSet.html" title="AtkStateSet"><span class="returnvalue">AtkStateSet</span></a> *       <a class="link" href="AtkObject.html#atk-object-ref-state-set" title="atk_object_ref_state_set ()">atk_object_ref_state_set</a>            (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
68
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="AtkObject.html#atk-object-get-index-in-parent" title="atk_object_get_index_in_parent ()">atk_object_get_index_in_parent</a>      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
 
68
<span class="returnvalue">gint</span>                <a class="link" href="AtkObject.html#atk-object-get-index-in-parent" title="atk_object_get_index_in_parent ()">atk_object_get_index_in_parent</a>      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
69
69
<span class="returnvalue">void</span>                <a class="link" href="AtkObject.html#atk-object-set-name" title="atk_object_set_name ()">atk_object_set_name</a>                 (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
70
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
 
70
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
71
71
<span class="returnvalue">void</span>                <a class="link" href="AtkObject.html#atk-object-set-description" title="atk_object_set_description ()">atk_object_set_description</a>          (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
72
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);
 
72
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>);
73
73
<span class="returnvalue">void</span>                <a class="link" href="AtkObject.html#atk-object-set-parent" title="atk_object_set_parent ()">atk_object_set_parent</a>               (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
74
74
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *parent</code></em>);
75
75
<span class="returnvalue">void</span>                <a class="link" href="AtkObject.html#atk-object-set-role" title="atk_object_set_role ()">atk_object_set_role</a>                 (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
76
76
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);
77
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="AtkObject.html#atk-object-connect-property-change-handler" title="atk_object_connect_property_change_handler ()">atk_object_connect_property_change_handler</a>
 
77
<span class="returnvalue">guint</span>               <a class="link" href="AtkObject.html#atk-object-connect-property-change-handler" title="atk_object_connect_property_change_handler ()">atk_object_connect_property_change_handler</a>
78
78
                                                        (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
79
79
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html#AtkPropertyChangeHandler" title="AtkPropertyChangeHandler ()"><span class="type">AtkPropertyChangeHandler</span></a> *handler</code></em>);
80
80
<span class="returnvalue">void</span>                <a class="link" href="AtkObject.html#atk-object-remove-property-change-handler" title="atk_object_remove_property_change_handler ()">atk_object_remove_property_change_handler</a>
81
81
                                                        (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
82
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> handler_id</code></em>);
 
82
                                                         <em class="parameter"><code><span class="type">guint</span> handler_id</code></em>);
83
83
<span class="returnvalue">void</span>                <a class="link" href="AtkObject.html#atk-object-notify-state-change" title="atk_object_notify_state_change ()">atk_object_notify_state_change</a>      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
84
84
                                                         <em class="parameter"><code><a class="link" href="atk-AtkState.html#AtkState" title="AtkState"><span class="type">AtkState</span></a> state</code></em>,
85
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);
 
85
                                                         <em class="parameter"><code><span class="type">gboolean</span> value</code></em>);
86
86
<span class="returnvalue">void</span>                <a class="link" href="AtkObject.html#atk-object-initialize" title="atk_object_initialize ()">atk_object_initialize</a>               (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
87
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
88
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtkObject.html#atk-object-add-relationship" title="atk_object_add_relationship ()">atk_object_add_relationship</a>         (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
 
87
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
88
<span class="returnvalue">gboolean</span>            <a class="link" href="AtkObject.html#atk-object-add-relationship" title="atk_object_add_relationship ()">atk_object_add_relationship</a>         (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
89
89
                                                         <em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>,
90
90
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);
91
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtkObject.html#atk-object-remove-relationship" title="atk_object_remove_relationship ()">atk_object_remove_relationship</a>      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
 
91
<span class="returnvalue">gboolean</span>            <a class="link" href="AtkObject.html#atk-object-remove-relationship" title="atk_object_remove_relationship ()">atk_object_remove_relationship</a>      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
92
92
                                                         <em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>,
93
93
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);
94
94
<a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *   <a class="link" href="AtkObject.html#atk-object-get-attributes" title="atk_object_get_attributes ()">atk_object_get_attributes</a>           (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);
95
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkObject.html#atk-role-get-name" title="atk_role_get_name ()">atk_role_get_name</a>                   (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);
96
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="AtkObject.html#atk-role-get-localized-name" title="atk_role_get_localized_name ()">atk_role_get_localized_name</a>         (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);
97
 
<a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             <a class="link" href="AtkObject.html#atk-role-for-name" title="atk_role_for_name ()">atk_role_for_name</a>                   (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
 
95
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkObject.html#atk-role-get-name" title="atk_role_get_name ()">atk_role_get_name</a>                   (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);
 
96
const <span class="returnvalue">gchar</span> *       <a class="link" href="AtkObject.html#atk-role-get-localized-name" title="atk_role_get_localized_name ()">atk_role_get_localized_name</a>         (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);
 
97
<a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             <a class="link" href="AtkObject.html#atk-role-for-name" title="atk_role_for_name ()">atk_role_for_name</a>                   (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
98
98
</pre>
99
99
</div>
100
100
<div class="refsect1">
101
101
<a name="AtkObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
102
102
<pre class="synopsis">
103
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
103
  GObject
104
104
   +----AtkObject
105
105
         +----<a class="link" href="AtkGObjectAccessible.html" title="AtkGObjectAccessible">AtkGObjectAccessible</a>
106
106
         +----<a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>
109
109
<div class="refsect1">
110
110
<a name="AtkObject.properties"></a><h2>Properties</h2>
111
111
<pre class="synopsis">
112
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-component-layer" title='The "accessible-component-layer" property'>accessible-component-layer</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
113
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-component-mdi-zorder" title='The "accessible-component-mdi-zorder" property'>accessible-component-mdi-zorder</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
114
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-description" title='The "accessible-description" property'>accessible-description</a>"   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
115
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-hypertext-nlinks" title='The "accessible-hypertext-nlinks" property'>accessible-hypertext-nlinks</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read
116
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-name" title='The "accessible-name" property'>accessible-name</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
112
  "<a class="link" href="AtkObject.html#AtkObject--accessible-component-layer" title='The "accessible-component-layer" property'>accessible-component-layer</a>" <span class="type">gint</span>                  : Read
 
113
  "<a class="link" href="AtkObject.html#AtkObject--accessible-component-mdi-zorder" title='The "accessible-component-mdi-zorder" property'>accessible-component-mdi-zorder</a>" <span class="type">gint</span>                  : Read
 
114
  "<a class="link" href="AtkObject.html#AtkObject--accessible-description" title='The "accessible-description" property'>accessible-description</a>"   <span class="type">gchar</span>*                : Read / Write
 
115
  "<a class="link" href="AtkObject.html#AtkObject--accessible-hypertext-nlinks" title='The "accessible-hypertext-nlinks" property'>accessible-hypertext-nlinks</a>" <span class="type">gint</span>                  : Read
 
116
  "<a class="link" href="AtkObject.html#AtkObject--accessible-name" title='The "accessible-name" property'>accessible-name</a>"          <span class="type">gchar</span>*                : Read / Write
117
117
  "<a class="link" href="AtkObject.html#AtkObject--accessible-parent" title='The "accessible-parent" property'>accessible-parent</a>"        <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>*            : Read / Write
118
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-role" title='The "accessible-role" property'>accessible-role</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
119
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-caption" title='The "accessible-table-caption" property'>accessible-table-caption</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
118
  "<a class="link" href="AtkObject.html#AtkObject--accessible-role" title='The "accessible-role" property'>accessible-role</a>"          <span class="type">gint</span>                  : Read / Write
 
119
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-caption" title='The "accessible-table-caption" property'>accessible-table-caption</a>" <span class="type">gchar</span>*                : Read / Write
120
120
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-caption-object" title='The "accessible-table-caption-object" property'>accessible-table-caption-object</a>" <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>*            : Read / Write
121
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-column-description" title='The "accessible-table-column-description" property'>accessible-table-column-description</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
121
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-column-description" title='The "accessible-table-column-description" property'>accessible-table-column-description</a>" <span class="type">gchar</span>*                : Read / Write
122
122
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-column-header" title='The "accessible-table-column-header" property'>accessible-table-column-header</a>" <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>*            : Read / Write
123
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-row-description" title='The "accessible-table-row-description" property'>accessible-table-row-description</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
123
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-row-description" title='The "accessible-table-row-description" property'>accessible-table-row-description</a>" <span class="type">gchar</span>*                : Read / Write
124
124
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-row-header" title='The "accessible-table-row-header" property'>accessible-table-row-header</a>" <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>*            : Read / Write
125
125
  "<a class="link" href="AtkObject.html#AtkObject--accessible-table-summary" title='The "accessible-table-summary" property'>accessible-table-summary</a>" <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>*            : Read / Write
126
 
  "<a class="link" href="AtkObject.html#AtkObject--accessible-value" title='The "accessible-value" property'>accessible-value</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
 
126
  "<a class="link" href="AtkObject.html#AtkObject--accessible-value" title='The "accessible-value" property'>accessible-value</a>"         <span class="type">gdouble</span>               : Read / Write
127
127
</pre>
128
128
</div>
129
129
<div class="refsect1">
130
130
<a name="AtkObject.signals"></a><h2>Signals</h2>
131
131
<pre class="synopsis">
132
 
  "<a class="link" href="AtkObject.html#AtkObject-active-descendant-changed" title='The "active-descendant-changed" signal'>active-descendant-changed</a>"                      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
133
 
  "<a class="link" href="AtkObject.html#AtkObject-children-changed" title='The "children-changed" signal'>children-changed</a>"                               : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
134
 
  "<a class="link" href="AtkObject.html#AtkObject-focus-event" title='The "focus-event" signal'>focus-event</a>"                                    : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
135
 
  "<a class="link" href="AtkObject.html#AtkObject-property-change" title='The "property-change" signal'>property-change</a>"                                : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
136
 
  "<a class="link" href="AtkObject.html#AtkObject-state-change" title='The "state-change" signal'>state-change</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
137
 
  "<a class="link" href="AtkObject.html#AtkObject-visible-data-changed" title='The "visible-data-changed" signal'>visible-data-changed</a>"                           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
132
  "<a class="link" href="AtkObject.html#AtkObject-active-descendant-changed" title='The "active-descendant-changed" signal'>active-descendant-changed</a>"                      : <code class="literal">Has Details</code>
 
133
  "<a class="link" href="AtkObject.html#AtkObject-children-changed" title='The "children-changed" signal'>children-changed</a>"                               : <code class="literal">Has Details</code>
 
134
  "<a class="link" href="AtkObject.html#AtkObject-focus-event" title='The "focus-event" signal'>focus-event</a>"                                    : <code class="literal">Run Last</code>
 
135
  "<a class="link" href="AtkObject.html#AtkObject-property-change" title='The "property-change" signal'>property-change</a>"                                : <code class="literal">Has Details</code>
 
136
  "<a class="link" href="AtkObject.html#AtkObject-state-change" title='The "state-change" signal'>state-change</a>"                                   : <code class="literal">Has Details</code>
 
137
  "<a class="link" href="AtkObject.html#AtkObject-visible-data-changed" title='The "visible-data-changed" signal'>visible-data-changed</a>"                           : <code class="literal">Run Last</code>
138
138
</pre>
139
139
</div>
140
140
<div class="refsect1">
152
152
<p>All UI components in an application which provide useful
153
153
information or services to the user must provide corresponding
154
154
<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> instances on request (in GTK+, for instance, usually
155
 
on a call to #<a href="http://library.gnome.org/devel/gtk/GtkWidget.html#gtk-widget-get-accessible"><code class="function">gtk_widget_get_accessible()</code></a>), either via ATK support
 
155
on a call to #<code class="function">gtk_widget_get_accessible()</code>), either via ATK support
156
156
built into the toolkit for the widget class or ancestor class, or in
157
157
the case of custom widgets, if the inherited <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> implementation
158
158
is insufficient, via instances of a new <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> subclass.
811
811
<hr>
812
812
<div class="refsect2">
813
813
<a name="atk-role-register"></a><h3>atk_role_register ()</h3>
814
 
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             atk_role_register                   (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 
814
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             atk_role_register                   (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
815
815
<p>
816
816
Registers the role specified by <em class="parameter"><code>name</code></em>.
817
817
</p>
941
941
<col align="left" valign="top">
942
942
<tbody>
943
943
<tr>
944
 
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="AtkPropertyValues.property-name"></a>property_name</code></em>;</span></p></td>
 
944
<td><p><span class="term">const <span class="type">gchar</span> *<em class="structfield"><code><a name="AtkPropertyValues.property-name"></a>property_name</code></em>;</span></p></td>
945
945
<td>The name of the ATK property which is being presented or which has been changed.</td>
946
946
</tr>
947
947
<tr>
948
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="AtkPropertyValues.old-value"></a>old_value</code></em>;</span></p></td>
 
948
<td><p><span class="term"><span class="type">GValue</span> <em class="structfield"><code><a name="AtkPropertyValues.old-value"></a>old_value</code></em>;</span></p></td>
949
949
<td>The old property value, NULL; in some contexts this value is undefined (see note below).</td>
950
950
</tr>
951
951
<tr>
952
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <em class="structfield"><code><a name="AtkPropertyValues.new-value"></a>new_value</code></em>;</span></p></td>
 
952
<td><p><span class="term"><span class="type">GValue</span> <em class="structfield"><code><a name="AtkPropertyValues.new-value"></a>new_value</code></em>;</span></p></td>
953
953
<td>The new value of the named property.</td>
954
954
</tr>
955
955
</tbody>
958
958
<hr>
959
959
<div class="refsect2">
960
960
<a name="AtkFunction"></a><h3>AtkFunction ()</h3>
961
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*AtkFunction)                      (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
961
<pre class="programlisting"><span class="returnvalue">gboolean</span>            (*AtkFunction)                      (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
962
962
<p>
963
963
An AtkFunction is a function definition used for padding which has been added
964
964
to class and interface structures to allow for expansion in the future.
1015
1015
<tbody>
1016
1016
<tr>
1017
1017
<td><p><span class="term"><em class="parameter"><code>implementor</code></em> :</span></p></td>
1018
 
<td>The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> instance which should implement <span class="type">AtkImplementorIface</span>
 
1018
<td>The <span class="type">GObject</span> instance which should implement <span class="type">AtkImplementorIface</span>
1019
1019
if a non-null return value is required.</td>
1020
1020
</tr>
1021
1021
<tr>
1030
1030
<hr>
1031
1031
<div class="refsect2">
1032
1032
<a name="atk-object-get-name"></a><h3>atk_object_get_name ()</h3>
1033
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_object_get_name                 (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
 
1033
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_object_get_name                 (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
1034
1034
<p>
1035
1035
Gets the accessible name of the accessible.
1036
1036
</p>
1052
1052
<hr>
1053
1053
<div class="refsect2">
1054
1054
<a name="atk-object-get-description"></a><h3>atk_object_get_description ()</h3>
1055
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_object_get_description          (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
 
1055
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_object_get_description          (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
1056
1056
<p>
1057
1057
Gets the accessible description of the accessible.
1058
1058
</p>
1099
1099
<hr>
1100
1100
<div class="refsect2">
1101
1101
<a name="atk-object-get-n-accessible-children"></a><h3>atk_object_get_n_accessible_children ()</h3>
1102
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atk_object_get_n_accessible_children
 
1102
<pre class="programlisting"><span class="returnvalue">gint</span>                atk_object_get_n_accessible_children
1103
1103
                                                        (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
1104
1104
<p>
1105
1105
Gets the number of accessible children of the accessible.
1124
1124
<div class="refsect2">
1125
1125
<a name="atk-object-ref-accessible-child"></a><h3>atk_object_ref_accessible_child ()</h3>
1126
1126
<pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *         atk_object_ref_accessible_child     (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
1127
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
 
1127
                                                         <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
1128
1128
<p>
1129
1129
Gets a reference to the specified accessible child of the object.
1130
1130
The accessible children are 0-based so the first accessible child is
1204
1204
<hr>
1205
1205
<div class="refsect2">
1206
1206
<a name="atk-object-get-mdi-zorder"></a><h3>atk_object_get_mdi_zorder ()</h3>
1207
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atk_object_get_mdi_zorder           (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
 
1207
<pre class="programlisting"><span class="returnvalue">gint</span>                atk_object_get_mdi_zorder           (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
1208
1208
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1209
1209
<h3 class="title">Warning</h3>
1210
1210
<p><code class="literal">atk_object_get_mdi_zorder</code> is deprecated and should not be used in newly-written code. Use atk_component_get_mdi_zorder instead.</p>
1280
1280
<hr>
1281
1281
<div class="refsect2">
1282
1282
<a name="atk-object-get-index-in-parent"></a><h3>atk_object_get_index_in_parent ()</h3>
1283
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                atk_object_get_index_in_parent      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
 
1283
<pre class="programlisting"><span class="returnvalue">gint</span>                atk_object_get_index_in_parent      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>);</pre>
1284
1284
<p>
1285
1285
Gets the 0-based index of this accessible in its parent; returns -1 if the
1286
1286
accessible does not have an accessible parent.
1304
1304
<div class="refsect2">
1305
1305
<a name="atk-object-set-name"></a><h3>atk_object_set_name ()</h3>
1306
1306
<pre class="programlisting"><span class="returnvalue">void</span>                atk_object_set_name                 (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
1307
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 
1307
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
1308
1308
<p>
1309
1309
Sets the accessible name of the accessible. You can't set the name
1310
1310
to NULL. This is reserved for the initial value. In this aspect
1330
1330
<div class="refsect2">
1331
1331
<a name="atk-object-set-description"></a><h3>atk_object_set_description ()</h3>
1332
1332
<pre class="programlisting"><span class="returnvalue">void</span>                atk_object_set_description          (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
1333
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>);</pre>
 
1333
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *description</code></em>);</pre>
1334
1334
<p>
1335
1335
Sets the accessible description of the accessible. You can't set
1336
1336
the description to NULL. This is reserved for the initial value. In
1401
1401
<hr>
1402
1402
<div class="refsect2">
1403
1403
<a name="atk-object-connect-property-change-handler"></a><h3>atk_object_connect_property_change_handler ()</h3>
1404
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               atk_object_connect_property_change_handler
 
1404
<pre class="programlisting"><span class="returnvalue">guint</span>               atk_object_connect_property_change_handler
1405
1405
                                                        (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
1406
1406
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html#AtkPropertyChangeHandler" title="AtkPropertyChangeHandler ()"><span class="type">AtkPropertyChangeHandler</span></a> *handler</code></em>);</pre>
1407
1407
<p>
1421
1421
</tr>
1422
1422
<tr>
1423
1423
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1424
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> which is the handler id used in
 
1424
<td>a <span class="type">guint</span> which is the handler id used in
1425
1425
<a class="link" href="AtkObject.html#atk-object-remove-property-change-handler" title="atk_object_remove_property_change_handler ()"><code class="function">atk_object_remove_property_change_handler()</code></a>
1426
1426
</td>
1427
1427
</tr>
1433
1433
<a name="atk-object-remove-property-change-handler"></a><h3>atk_object_remove_property_change_handler ()</h3>
1434
1434
<pre class="programlisting"><span class="returnvalue">void</span>                atk_object_remove_property_change_handler
1435
1435
                                                        (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
1436
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> handler_id</code></em>);</pre>
 
1436
                                                         <em class="parameter"><code><span class="type">guint</span> handler_id</code></em>);</pre>
1437
1437
<p>
1438
1438
Removes a property change handler.
1439
1439
</p>
1457
1457
<a name="atk-object-notify-state-change"></a><h3>atk_object_notify_state_change ()</h3>
1458
1458
<pre class="programlisting"><span class="returnvalue">void</span>                atk_object_notify_state_change      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
1459
1459
                                                         <em class="parameter"><code><a class="link" href="atk-AtkState.html#AtkState" title="AtkState"><span class="type">AtkState</span></a> state</code></em>,
1460
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
 
1460
                                                         <em class="parameter"><code><span class="type">gboolean</span> value</code></em>);</pre>
1461
1461
<p>
1462
1462
Emits a state-change signal for the specified state.
1463
1463
</p>
1484
1484
<div class="refsect2">
1485
1485
<a name="atk-object-initialize"></a><h3>atk_object_initialize ()</h3>
1486
1486
<pre class="programlisting"><span class="returnvalue">void</span>                atk_object_initialize               (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *accessible</code></em>,
1487
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
1487
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1488
1488
<p>
1489
1489
This function is called when implementing subclasses of <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>.
1490
1490
It does initialization required for the new object. It is intended
1501
1501
</tr>
1502
1502
<tr>
1503
1503
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1504
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> which identifies the object for which the AtkObject was created.</td>
 
1504
<td>a <span class="type">gpointer</span> which identifies the object for which the AtkObject was created.</td>
1505
1505
</tr>
1506
1506
</tbody>
1507
1507
</table></div>
1509
1509
<hr>
1510
1510
<div class="refsect2">
1511
1511
<a name="atk-object-add-relationship"></a><h3>atk_object_add_relationship ()</h3>
1512
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atk_object_add_relationship         (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
 
1512
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atk_object_add_relationship         (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
1513
1513
                                                         <em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>,
1514
1514
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);</pre>
1515
1515
<p>
1540
1540
<hr>
1541
1541
<div class="refsect2">
1542
1542
<a name="atk-object-remove-relationship"></a><h3>atk_object_remove_relationship ()</h3>
1543
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atk_object_remove_relationship      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
 
1543
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atk_object_remove_relationship      (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *object</code></em>,
1544
1544
                                                         <em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>,
1545
1545
                                                         <em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);</pre>
1546
1546
<p>
1599
1599
<hr>
1600
1600
<div class="refsect2">
1601
1601
<a name="atk-role-get-name"></a><h3>atk_role_get_name ()</h3>
1602
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_role_get_name                   (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);</pre>
 
1602
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_role_get_name                   (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);</pre>
1603
1603
<p>
1604
1604
Gets the description string describing the <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> <em class="parameter"><code>role</code></em>.
1605
1605
</p>
1620
1620
<hr>
1621
1621
<div class="refsect2">
1622
1622
<a name="atk-role-get-localized-name"></a><h3>atk_role_get_localized_name ()</h3>
1623
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       atk_role_get_localized_name         (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);</pre>
 
1623
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       atk_role_get_localized_name         (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> role</code></em>);</pre>
1624
1624
<p>
1625
1625
Gets the localized description string describing the <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> <em class="parameter"><code>role</code></em>.
1626
1626
</p>
1641
1641
<hr>
1642
1642
<div class="refsect2">
1643
1643
<a name="atk-role-for-name"></a><h3>atk_role_for_name ()</h3>
1644
 
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             atk_role_for_name                   (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
 
1644
<pre class="programlisting"><a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="returnvalue">AtkRole</span></a>             atk_role_for_name                   (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
1645
1645
<p>
1646
1646
Get the <a class="link" href="AtkObject.html#AtkRole" title="enum AtkRole"><span class="type">AtkRole</span></a> type corresponding to a rolew name.
1647
1647
</p>
1666
1666
<a name="AtkObject.property-details"></a><h2>Property Details</h2>
1667
1667
<div class="refsect2">
1668
1668
<a name="AtkObject--accessible-component-layer"></a><h3>The <code class="literal">"accessible-component-layer"</code> property</h3>
1669
 
<pre class="programlisting">  "accessible-component-layer" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 
1669
<pre class="programlisting">  "accessible-component-layer" <span class="type">gint</span>                  : Read</pre>
1670
1670
<p>The accessible layer of this object.</p>
1671
1671
<p>Allowed values: &gt;= 0</p>
1672
1672
<p>Default value: 0</p>
1674
1674
<hr>
1675
1675
<div class="refsect2">
1676
1676
<a name="AtkObject--accessible-component-mdi-zorder"></a><h3>The <code class="literal">"accessible-component-mdi-zorder"</code> property</h3>
1677
 
<pre class="programlisting">  "accessible-component-mdi-zorder" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 
1677
<pre class="programlisting">  "accessible-component-mdi-zorder" <span class="type">gint</span>                  : Read</pre>
1678
1678
<p>The accessible MDI value of this object.</p>
1679
1679
<p>Default value: -2147483648</p>
1680
1680
</div>
1681
1681
<hr>
1682
1682
<div class="refsect2">
1683
1683
<a name="AtkObject--accessible-description"></a><h3>The <code class="literal">"accessible-description"</code> property</h3>
1684
 
<pre class="programlisting">  "accessible-description"   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
1684
<pre class="programlisting">  "accessible-description"   <span class="type">gchar</span>*                : Read / Write</pre>
1685
1685
<p>Description of an object, formatted for assistive technology access.</p>
1686
1686
<p>Default value: NULL</p>
1687
1687
</div>
1688
1688
<hr>
1689
1689
<div class="refsect2">
1690
1690
<a name="AtkObject--accessible-hypertext-nlinks"></a><h3>The <code class="literal">"accessible-hypertext-nlinks"</code> property</h3>
1691
 
<pre class="programlisting">  "accessible-hypertext-nlinks" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read</pre>
 
1691
<pre class="programlisting">  "accessible-hypertext-nlinks" <span class="type">gint</span>                  : Read</pre>
1692
1692
<p>The number of links which the current AtkHypertext has.</p>
1693
1693
<p>Allowed values: &gt;= 0</p>
1694
1694
<p>Default value: 0</p>
1696
1696
<hr>
1697
1697
<div class="refsect2">
1698
1698
<a name="AtkObject--accessible-name"></a><h3>The <code class="literal">"accessible-name"</code> property</h3>
1699
 
<pre class="programlisting">  "accessible-name"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
1699
<pre class="programlisting">  "accessible-name"          <span class="type">gchar</span>*                : Read / Write</pre>
1700
1700
<p>Object instance's name formatted for assistive technology access.</p>
1701
1701
<p>Default value: NULL</p>
1702
1702
</div>
1709
1709
<hr>
1710
1710
<div class="refsect2">
1711
1711
<a name="AtkObject--accessible-role"></a><h3>The <code class="literal">"accessible-role"</code> property</h3>
1712
 
<pre class="programlisting">  "accessible-role"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
1712
<pre class="programlisting">  "accessible-role"          <span class="type">gint</span>                  : Read / Write</pre>
1713
1713
<p>The accessible role of this object.</p>
1714
1714
<p>Allowed values: &gt;= 0</p>
1715
1715
<p>Default value: 0</p>
1717
1717
<hr>
1718
1718
<div class="refsect2">
1719
1719
<a name="AtkObject--accessible-table-caption"></a><h3>The <code class="literal">"accessible-table-caption"</code> property</h3>
1720
 
<pre class="programlisting">  "accessible-table-caption" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
1720
<pre class="programlisting">  "accessible-table-caption" <span class="type">gchar</span>*                : Read / Write</pre>
1721
1721
<p>Is used to notify that the table caption has changed; this property should not be used. accessible-table-caption-object should be used instead.</p>
1722
1722
<p>Default value: NULL</p>
1723
1723
</div>
1730
1730
<hr>
1731
1731
<div class="refsect2">
1732
1732
<a name="AtkObject--accessible-table-column-description"></a><h3>The <code class="literal">"accessible-table-column-description"</code> property</h3>
1733
 
<pre class="programlisting">  "accessible-table-column-description" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
1733
<pre class="programlisting">  "accessible-table-column-description" <span class="type">gchar</span>*                : Read / Write</pre>
1734
1734
<p>Is used to notify that the table column description has changed.</p>
1735
1735
<p>Default value: NULL</p>
1736
1736
</div>
1743
1743
<hr>
1744
1744
<div class="refsect2">
1745
1745
<a name="AtkObject--accessible-table-row-description"></a><h3>The <code class="literal">"accessible-table-row-description"</code> property</h3>
1746
 
<pre class="programlisting">  "accessible-table-row-description" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
1746
<pre class="programlisting">  "accessible-table-row-description" <span class="type">gchar</span>*                : Read / Write</pre>
1747
1747
<p>Is used to notify that the table row description has changed.</p>
1748
1748
<p>Default value: NULL</p>
1749
1749
</div>
1762
1762
<hr>
1763
1763
<div class="refsect2">
1764
1764
<a name="AtkObject--accessible-value"></a><h3>The <code class="literal">"accessible-value"</code> property</h3>
1765
 
<pre class="programlisting">  "accessible-value"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 
1765
<pre class="programlisting">  "accessible-value"         <span class="type">gdouble</span>               : Read / Write</pre>
1766
1766
<p>Is used to notify that the value has changed.</p>
1767
1767
<p>Allowed values: &gt;= 0</p>
1768
1768
<p>Default value: 0</p>
1773
1773
<div class="refsect2">
1774
1774
<a name="AtkObject-active-descendant-changed"></a><h3>The <code class="literal">"active-descendant-changed"</code> signal</h3>
1775
1775
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
1776
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   arg1,
1777
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
 
1776
                                                        <span class="type">gpointer</span>   arg1,
 
1777
                                                        <span class="type">gpointer</span>   user_data)      : <code class="literal">Has Details</code></pre>
1778
1778
<p>
1779
1779
The "active-descendant-changed" signal is emitted by an object which has
1780
1780
the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the
1803
1803
<div class="refsect2">
1804
1804
<a name="AtkObject-children-changed"></a><h3>The <code class="literal">"children-changed"</code> signal</h3>
1805
1805
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
1806
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>      arg1,
1807
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   arg2,
1808
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
 
1806
                                                        <span class="type">guint</span>      arg1,
 
1807
                                                        <span class="type">gpointer</span>   arg2,
 
1808
                                                        <span class="type">gpointer</span>   user_data)      : <code class="literal">Has Details</code></pre>
1809
1809
<p>
1810
1810
The signal "children-changed" is emitted when a child is added or
1811
1811
removed form an object. It supports two details: "add" and "remove"
1836
1836
<div class="refsect2">
1837
1837
<a name="AtkObject-focus-event"></a><h3>The <code class="literal">"focus-event"</code> signal</h3>
1838
1838
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
1839
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>   arg1,
1840
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1839
                                                        <span class="type">gboolean</span>   arg1,
 
1840
                                                        <span class="type">gpointer</span>   user_data)      : <code class="literal">Run Last</code></pre>
1841
1841
<p>
1842
1842
The signal "focus-event" is emitted when an object gains or loses focus.
1843
1843
</p>
1863
1863
<div class="refsect2">
1864
1864
<a name="AtkObject-property-change"></a><h3>The <code class="literal">"property-change"</code> signal</h3>
1865
1865
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
1866
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   arg1,
1867
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
 
1866
                                                        <span class="type">gpointer</span>   arg1,
 
1867
                                                        <span class="type">gpointer</span>   user_data)      : <code class="literal">Has Details</code></pre>
1868
1868
<p>
1869
1869
The signal "property-change" is emitted when an object's property
1870
1870
value changes. The detail identifies the name of the property whose
1892
1892
<div class="refsect2">
1893
1893
<a name="AtkObject-state-change"></a><h3>The <code class="literal">"state-change"</code> signal</h3>
1894
1894
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
1895
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>     *arg1,
1896
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>   arg2,
1897
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
 
1895
                                                        <span class="type">gchar</span>     *arg1,
 
1896
                                                        <span class="type">gboolean</span>   arg2,
 
1897
                                                        <span class="type">gpointer</span>   user_data)      : <code class="literal">Has Details</code></pre>
1898
1898
<p>
1899
1899
The "state-change" signal is emitted  when an object's state changes.
1900
1900
The detail value identifies the state type which has changed.
1925
1925
<div class="refsect2">
1926
1926
<a name="AtkObject-visible-data-changed"></a><h3>The <code class="literal">"visible-data-changed"</code> signal</h3>
1927
1927
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *atkobject,
1928
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1928
                                                        <span class="type">gpointer</span>   user_data)      : <code class="literal">Run Last</code></pre>
1929
1929
<p>
1930
1930
The "visible-data-changed" signal is emitted when the visual appearance of
1931
1931
the object changed.
1949
1949
<a name="AtkObject.see-also"></a><h2>See Also</h2>
1950
1950
<p>
1951
1951
See also: <a class="link" href="AtkObjectFactory.html" title="AtkObjectFactory"><span class="type">AtkObjectFactory</span></a>, <a class="link" href="AtkRegistry.html" title="AtkRegistry"><span class="type">AtkRegistry</span></a>.
1952
 
( GTK+ users see also <a href="http://library.gnome.org/devel/gtk/GtkAccessible.html"><span class="type">GtkAccessible</span></a>).
 
1952
( GTK+ users see also <span class="type">GtkAccessible</span>).
1953
1953
</p>
1954
1954
</div>
1955
1955
</div>
1956
1956
<div class="footer">
1957
1957
<hr>
1958
 
          Generated by GTK-Doc V1.18</div>
 
1958
          Generated by GTK-Doc V1.18.1</div>
1959
1959
</body>
1960
1960
</html>
 
 
b'\\ No newline at end of file'