e2ba6b455583b4eda67c715194c5c3d984c2c35f
[WebKit-https.git] / Source / 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     AccessibilityRole role = roleValue();
44     if (role == SplitterRole)
45         return IncludeObject;
46
47     // We expose the slider as a whole but not its value indicator.
48     if (role == SliderThumbRole)
49         return IgnoreObject;
50
51     // When a list item is made up entirely of children (e.g. paragraphs)
52     // the list item gets ignored. We need it.
53     if (isGroup() && parent->isList())
54         return IncludeObject;
55
56     // Entries and password fields have extraneous children which we want to ignore.
57     if (parent->isPasswordField() || parent->isTextControl())
58         return IgnoreObject;
59
60     // Include all tables, even layout tables. The AT can decide what to do with each.
61     if (role == CellRole || role == TableRole)
62         return IncludeObject;
63
64     // The object containing the text should implement AtkText itself.
65     if (role == StaticTextRole)
66         return IgnoreObject;
67
68     // Include all list items, regardless they have or not inline children
69     if (role == ListItemRole)
70         return IncludeObject;
71
72     // Bullets/numbers for list items shouldn't be exposed as AtkObjects.
73     if (role == ListMarkerRole)
74         return IgnoreObject;
75
76     // Never expose an unknown object, since AT's won't know what to
77     // do with them. This is what is done on the Mac as well.
78     if (role == UnknownRole)
79         return IgnoreObject;
80
81     return DefaultBehavior;
82 }
83
84 AccessibilityObjectWrapper* AccessibilityObject::wrapper() const
85 {
86     return m_wrapper;
87 }
88
89 void AccessibilityObject::setWrapper(AccessibilityObjectWrapper* wrapper)
90 {
91     if (wrapper == m_wrapper)
92         return;
93
94     if (m_wrapper)
95         g_object_unref(m_wrapper);
96
97     m_wrapper = wrapper;
98
99     if (m_wrapper)
100         g_object_ref(m_wrapper);
101 }
102
103 bool AccessibilityObject::allowsTextRanges() const
104 {
105     // Check type for the AccessibilityObject.
106     if (isTextControl() || isWebArea() || isGroup() || isLink() || isHeading() || isListItem())
107         return true;
108
109     // Check roles as the last fallback mechanism.
110     AccessibilityRole role = roleValue();
111     return role == ParagraphRole || role == LabelRole || role == DivRole || role == FormRole;
112 }
113
114 unsigned AccessibilityObject::getLengthForTextRange() const
115 {
116     unsigned textLength = text().length();
117
118     if (textLength)
119         return textLength;
120
121     // Gtk ATs need this for all text objects; not just text controls.
122     Node* node = this->node();
123     RenderObject* renderer = node ? node->renderer() : 0;
124     if (renderer && renderer->isText()) {
125         RenderText* renderText = toRenderText(renderer);
126         textLength = renderText ? renderText->textLength() : 0;
127     }
128
129     // Get the text length from the elements under the
130     // accessibility object if the value is still zero.
131     if (!textLength && allowsTextRanges())
132         textLength = textUnderElement().length();
133
134     return textLength;
135 }
136
137 } // namespace WebCore
138
139 #endif // HAVE(ACCESSIBILITY)