2011-01-07 Adam Barth <abarth@webkit.org>
[WebKit-https.git] / WebCore / accessibility / gtk / AccessibilityObjectAtk.cpp
1 /*
2  * Copyright (C) 2008 Apple Ltd.
3  * Copyright (C) 2008 Alp Toker <alp@atoker.com>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #include "config.h"
22 #include "AccessibilityObject.h"
23 #include "RenderObject.h"
24 #include "RenderText.h"
25
26 #include <glib-object.h>
27
28 #if HAVE(ACCESSIBILITY)
29
30 namespace WebCore {
31
32 bool AccessibilityObject::accessibilityIgnoreAttachment() const
33 {
34     return false;
35 }
36
37 AccessibilityObjectInclusion AccessibilityObject::accessibilityPlatformIncludesObject() const
38 {
39     AccessibilityObject* parent = parentObject();
40     if (!parent)
41         return DefaultBehavior;
42
43     if (roleValue() == SplitterRole)
44         return IncludeObject;
45
46     if (isGroup()) {
47         // When a list item is made up entirely of children (e.g. paragraphs)
48         // the list item gets ignored. We need it.
49         if (parent->isList())
50             return IncludeObject;
51
52         // We expect the parent of a table cell to be a table.
53         AccessibilityObject* child = firstChild();
54         if (child && child->roleValue() == CellRole)
55             return IgnoreObject;
56     }
57
58     // Entries and password fields have extraneous children which we want to ignore.
59     if (parent->isPasswordField() || parent->isTextControl())
60         return IgnoreObject;
61
62     AccessibilityRole role = roleValue();
63
64     // Include all tables, even layout tables. The AT can decide what to do with each.
65     if (role == CellRole || role == TableRole)
66         return IncludeObject;
67
68     // We at some point might have a need to expose a table row; but it's not standard Gtk+.
69     if (role == RowRole)
70         return IgnoreObject;
71
72     // The object containing the text should implement AtkText itself.
73     if (role == StaticTextRole)
74         return IgnoreObject;
75
76     // Include all list items, regardless they have or not inline children
77     if (role == ListItemRole)
78         return IncludeObject;
79
80     // Bullets/numbers for list items shouldn't be exposed as AtkObjects.
81     if (role == ListMarkerRole)
82         return IgnoreObject;
83
84     return DefaultBehavior;
85 }
86
87 AccessibilityObjectWrapper* AccessibilityObject::wrapper() const
88 {
89     return m_wrapper;
90 }
91
92 void AccessibilityObject::setWrapper(AccessibilityObjectWrapper* wrapper)
93 {
94     if (wrapper == m_wrapper)
95         return;
96
97     if (m_wrapper)
98         g_object_unref(m_wrapper);
99
100     m_wrapper = wrapper;
101
102     if (m_wrapper)
103         g_object_ref(m_wrapper);
104 }
105
106 bool AccessibilityObject::allowsTextRanges() const
107 {
108     return isTextControl() || isWebArea() || isGroup() || isLink() || isHeading();
109 }
110
111 unsigned AccessibilityObject::getLengthForTextRange() const
112 {
113     unsigned textLength = text().length();
114
115     if (textLength)
116         return textLength;
117
118     // Gtk ATs need this for all text objects; not just text controls.
119     Node* node = this->node();
120     RenderObject* renderer = node ? node->renderer() : 0;
121     if (renderer && renderer->isText()) {
122         RenderText* renderText = toRenderText(renderer);
123         textLength = renderText ? renderText->textLength() : 0;
124     }
125
126     // Get the text length from the elements under the
127     // accessibility object if the value is still zero.
128     if (!textLength && allowsTextRanges())
129         textLength = textUnderElement().length();
130
131     return textLength;
132 }
133
134 } // namespace WebCore
135
136 #endif // HAVE(ACCESSIBILITY)