Move WebKit into Source
[WebKit-https.git] / Source / WebKit / chromium / public / WebAccessibilityObject.h
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebAccessibilityObject_h
32 #define WebAccessibilityObject_h
33
34 #include "WebAccessibilityRole.h"
35 #include "WebCommon.h"
36
37 #if WEBKIT_IMPLEMENTATION
38 namespace WebCore { class AccessibilityObject; }
39 namespace WTF { template <typename T> class PassRefPtr; }
40 #endif
41
42 namespace WebKit {
43
44 class WebAccessibilityObjectPrivate;
45 class WebNode;
46 class WebDocument;
47 class WebString;
48 class WebURL;
49 struct WebPoint;
50 struct WebRect;
51
52 // A container for passing around a reference to AccessibilityObject.
53 class WebAccessibilityObject {
54 public:
55     ~WebAccessibilityObject() { reset(); }
56
57     WebAccessibilityObject() : m_private(0) { }
58     WebAccessibilityObject(const WebAccessibilityObject& o) : m_private(0) { assign(o); }
59     WebAccessibilityObject& operator=(const WebAccessibilityObject& o)
60     {
61         assign(o);
62         return *this;
63     }
64
65     WEBKIT_API void reset();
66     WEBKIT_API void assign(const WebAccessibilityObject&);
67
68     bool isNull() const { return !m_private; }
69
70     WEBKIT_API WebString accessibilityDescription() const;
71     WEBKIT_API WebString actionVerb() const;
72     WEBKIT_API bool canSetFocusAttribute() const;
73     WEBKIT_API bool canSetValueAttribute() const;
74     WEBKIT_API bool isValid() const;
75
76     WEBKIT_API unsigned childCount() const;
77
78     WEBKIT_API WebAccessibilityObject childAt(unsigned) const;
79     WEBKIT_API WebAccessibilityObject firstChild() const;
80     WEBKIT_API WebAccessibilityObject focusedChild() const;
81     WEBKIT_API WebAccessibilityObject lastChild() const;
82     WEBKIT_API WebAccessibilityObject nextSibling() const;
83     WEBKIT_API WebAccessibilityObject parentObject() const;
84     WEBKIT_API WebAccessibilityObject previousSibling() const;
85
86     WEBKIT_API bool canSetSelectedAttribute() const;
87     WEBKIT_API bool isAnchor() const;
88     WEBKIT_API bool isChecked() const;
89     WEBKIT_API bool isCollapsed() const;
90     WEBKIT_API bool isFocused() const;
91     WEBKIT_API bool isEnabled() const;
92     WEBKIT_API bool isHovered() const;
93     WEBKIT_API bool isIndeterminate() const;
94     WEBKIT_API bool isLinked() const;
95     WEBKIT_API bool isMultiSelectable() const;
96     WEBKIT_API bool isOffScreen() const;
97     WEBKIT_API bool isPasswordField() const;
98     WEBKIT_API bool isPressed() const;
99     WEBKIT_API bool isReadOnly() const;
100     WEBKIT_API bool isSelected() const;
101     WEBKIT_API bool isVisible() const;
102     WEBKIT_API bool isVisited() const;
103
104     WEBKIT_API WebRect boundingBoxRect() const;
105     WEBKIT_API WebString helpText() const;
106     WEBKIT_API int headingLevel() const;
107     WEBKIT_API WebAccessibilityObject hitTest(const WebPoint&) const;
108     WEBKIT_API WebString keyboardShortcut() const;
109     WEBKIT_API bool performDefaultAction() const;
110     WEBKIT_API WebAccessibilityRole roleValue() const;
111     WEBKIT_API void setFocused(bool) const;
112     WEBKIT_API WebString stringValue() const;
113     WEBKIT_API WebString title() const;
114     WEBKIT_API WebURL url() const;
115
116     WEBKIT_API WebNode node() const;
117     WEBKIT_API WebDocument document() const;
118     WEBKIT_API bool hasComputedStyle() const;
119     WEBKIT_API WebString computedStyleDisplay() const;
120
121 #if WEBKIT_IMPLEMENTATION
122     WebAccessibilityObject(const WTF::PassRefPtr<WebCore::AccessibilityObject>&);
123     WebAccessibilityObject& operator=(const WTF::PassRefPtr<WebCore::AccessibilityObject>&);
124     operator WTF::PassRefPtr<WebCore::AccessibilityObject>() const;
125 #endif
126
127 private:
128     void assign(WebAccessibilityObjectPrivate*);
129     WebAccessibilityObjectPrivate* m_private;
130 };
131
132 } // namespace WebKit
133
134 #endif