AccessibilityObject.h 10.7 KB
Newer Older
alice.liu@apple.com's avatar
alice.liu@apple.com committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/*
 * Copyright (C) 2008 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
28

alice.liu@apple.com's avatar
alice.liu@apple.com committed
29 30 31 32 33 34
#ifndef AccessibilityObject_h
#define AccessibilityObject_h

#include "VisiblePosition.h"
#include <wtf/RefPtr.h>
#include <wtf/Vector.h>
35

hausmann@webkit.org's avatar
hausmann@webkit.org committed
36
#if PLATFORM(MAC)
alice.liu@apple.com's avatar
alice.liu@apple.com committed
37
#include <wtf/RetainPtr.h>
hausmann@webkit.org's avatar
hausmann@webkit.org committed
38
#endif
alice.liu@apple.com's avatar
alice.liu@apple.com committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130

typedef struct _NSRange NSRange;

#ifdef __OBJC__
@class AccessibilityObjectWrapper;
@class NSArray;
@class NSAttributedString;
@class NSData;
@class NSMutableAttributedString;
@class NSString;
@class NSValue;
@class NSView;
@class WebCoreTextMarker;
@class WebCoreTextMarkerRange;
#else
class AccessibilityObjectWrapper;
class NSArray;
class NSAttributedString;
class NSData;
class NSMutableAttributedString;
class NSString;
class NSValue;
class NSView;
class WebCoreTextMarker;
class WebCoreTextMarkerRange;
#endif

namespace WebCore {

class AXObjectCache;
class Element;
class Frame;
class FrameView;
class HTMLAnchorElement;
class HTMLAreaElement;
class IntPoint;
class IntSize;
class Node;
class RenderObject;
class RenderTextControl;
class Selection;
class String;
class Widget;

enum AccessibilityRole {
    UnknownRole = 1,
    ButtonRole,
    RadioButtonRole,
    CheckBoxRole,
    SliderRole,
    TabGroupRole,
    TextFieldRole,
    StaticTextRole,
    TextAreaRole,
    ScrollAreaRole,
    PopUpButtonRole,
    MenuButtonRole,
    TableRole,
    ApplicationRole,
    GroupRole,
    RadioGroupRole,
    ListRole,
    ScrollBarRole,
    ValueIndicatorRole,
    ImageRole,
    MenuBarRole,
    MenuRole,
    MenuItemRole,
    ColumnRole,
    RowRole,
    ToolbarRole,
    BusyIndicatorRole,
    ProgressIndicatorRole,
    WindowRole,
    DrawerRole,
    SystemWideRole,
    OutlineRole,
    IncrementorRole,
    BrowserRole,
    ComboBoxRole,
    SplitGroupRole,
    SplitterRole,
    ColorWellRole,
    GrowAreaRole,
    SheetRole,
    HelpTagRole,
    MatteRole,
    RulerRole,
    RulerMarkerRole,
    LinkRole,
    DisclosureTriangleRole,
    GridRole,
131 132 133

    // AppKit includes SortButtonRole but it is misnamed and really a subrole of ButtonRole so we do not include it here.

alice.liu@apple.com's avatar
alice.liu@apple.com committed
134 135 136 137 138 139 140 141 142
    // WebCore-specific roles
    WebCoreLinkRole,
    ImageMapRole,
    ListMarkerRole,
    WebAreaRole,
    HeadingRole
};

struct VisiblePositionRange {
143

alice.liu@apple.com's avatar
alice.liu@apple.com committed
144 145 146 147 148 149 150
    VisiblePosition start;
    VisiblePosition end;

    VisiblePositionRange() {}

    VisiblePositionRange(const VisiblePosition& s, const VisiblePosition& e)
        : start(s)
151
        , end(e)
alice.liu@apple.com's avatar
alice.liu@apple.com committed
152
    { }
153

alice.liu@apple.com's avatar
alice.liu@apple.com committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    bool isNull() const { return start.isNull() || end.isNull(); }
};

class AccessibilityObject : public RefCounted<AccessibilityObject> {
private:
    AccessibilityObject(RenderObject*);
public:
    static PassRefPtr<AccessibilityObject> create(RenderObject*);
    ~AccessibilityObject();

    struct PlainTextRange {

        unsigned start;
        unsigned length;

        PlainTextRange()
            : start(0)
171
            , length(0)
alice.liu@apple.com's avatar
alice.liu@apple.com committed
172
        { }
173

alice.liu@apple.com's avatar
alice.liu@apple.com committed
174 175 176 177
        PlainTextRange(unsigned s, unsigned l)
            : start(s)
            , length(l)
        { }
178

alice.liu@apple.com's avatar
alice.liu@apple.com committed
179
        bool isNull() const { return start == 0 && length == 0; }
180

alice.liu@apple.com's avatar
alice.liu@apple.com committed
181 182 183 184
    };

    bool isAnchor() const;
    bool isAttachment() const;
185 186
    bool isEnabled() const;
    bool isFocused() const;
alice.liu@apple.com's avatar
alice.liu@apple.com committed
187
    bool isHeading() const;
188 189 190 191 192 193 194
    bool isImageButton() const;
    bool isImage() const;
    bool isLoaded() const;
    bool isPasswordField() const;
    bool isTextControl() const;
    bool isVisited() const;
    bool isWebArea() const;
alice.liu@apple.com's avatar
alice.liu@apple.com committed
195

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
    bool canSetFocusAttribute() const;
    bool canSetTextRangeAttributes() const;
    bool canSetValueAttribute() const;

    bool hasIntValue() const;
    bool hasChildren() const;

    bool accessibilityShouldUseUniqueId() const;
    bool accessibilityIsIgnored() const;

    static int headingLevel(Node*);
    int intValue() const;
    int layoutCount() const;
    int textLength() const;
    unsigned axObjectID() const;
    AccessibilityObject* doAccessibilityHitTest(const IntPoint&) const;
    AccessibilityObject* focusedUIElement() const;
    AccessibilityObject* firstChild() const;
    AccessibilityObject* lastChild() const;
    AccessibilityObject* previousSibling() const;
    AccessibilityObject* nextSibling() const;
    AccessibilityObject* parentObject() const;
    AccessibilityObject* parentObjectUnignored() const;
    AccessibilityObject* observableObject() const;
    AccessibilityObject* linkedUIElement() const;
    AccessibilityRole roleValue() const;
    AXObjectCache* axObjectCache() const;
    Element* actionElement() const;
    Element* mouseButtonListener() const;
    FrameView* frameViewIfRenderView() const;
    FrameView* documentFrameView() const;
    HTMLAnchorElement* anchorElement() const;
    HTMLAreaElement* areaElement() const { return m_areaElement.get(); }
    IntRect boundingBoxRect() const;
    IntSize size() const;
    KURL url() const;
    PlainTextRange selectedTextRange() const;
    RenderObject* renderer() const { return m_renderer; }
    RenderObject* topRenderer() const;
    RenderTextControl* textControl() const;
    Selection selection() const;
    String stringValue() const;
    String title() const;
    String accessibilityDescription() const;
    String helpText() const;
    String textUnderElement() const;
    String selectedText() const;
    Widget* widget() const;
    Widget* widgetForAttachmentView() const;
    void getDocumentLinks(Vector< RefPtr<AccessibilityObject> >&) const;
    const Vector<RefPtr<AccessibilityObject> >& children() const { return m_children; }
alice.liu@apple.com's avatar
alice.liu@apple.com committed
247

248 249 250 251 252
    void setAXObjectID(unsigned);
    void setFocused(bool);
    void setSelectedText(const String&);
    void setSelectedTextRange(const PlainTextRange&);
    void setValue(const String&);
alice.liu@apple.com's avatar
alice.liu@apple.com committed
253

254 255 256 257
    void detach();
    void makeRangeVisible(const PlainTextRange&);
    void press();
    void childrenChanged();
alice.liu@apple.com's avatar
alice.liu@apple.com committed
258
    void addChildren();
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303

    VisiblePositionRange visiblePositionRange() const;
    VisiblePositionRange doAXTextMarkerRangeForLine(unsigned) const;
    VisiblePositionRange doAXTextMarkerRangeForUnorderedTextMarkers(const VisiblePosition&, const VisiblePosition&) const;
    VisiblePositionRange doAXLeftWordTextMarkerRangeForTextMarker(const VisiblePosition&) const;
    VisiblePositionRange doAXRightWordTextMarkerRangeForTextMarker(const VisiblePosition&) const;
    VisiblePositionRange doAXLeftLineTextMarkerRangeForTextMarker(const VisiblePosition&) const;
    VisiblePositionRange doAXRightLineTextMarkerRangeForTextMarker(const VisiblePosition&) const;
    VisiblePositionRange doAXSentenceTextMarkerRangeForTextMarker(const VisiblePosition&) const;
    VisiblePositionRange doAXParagraphTextMarkerRangeForTextMarker(const VisiblePosition&) const;
    VisiblePositionRange doAXStyleTextMarkerRangeForTextMarker(const VisiblePosition&) const;
    VisiblePositionRange textMarkerRangeForRange(const PlainTextRange&, RenderTextControl*) const;

    String doAXStringForTextMarkerRange(const VisiblePositionRange&) const;
    IntRect doAXBoundsForTextMarkerRange(const VisiblePositionRange&) const;
    int doAXLengthForTextMarkerRange(const VisiblePositionRange&) const;
    void doSetAXSelectedTextMarkerRange(const VisiblePositionRange&) const;
    PlainTextRange rangeForTextMarkerRange(const VisiblePositionRange&) const;

    VisiblePosition doAXTextMarkerForPosition(const IntPoint&) const;
    VisiblePosition doAXNextTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXPreviousTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXNextWordEndTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXPreviousWordStartTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXNextLineEndTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXPreviousLineStartTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXNextSentenceEndTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXPreviousSentenceStartTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXNextParagraphEndTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition doAXPreviousParagraphStartTextMarkerForTextMarker(const VisiblePosition&) const;
    VisiblePosition textMarkerForIndex(unsigned indexValue, bool lastIndexOK) const;

    AccessibilityObject* doAXUIElementForTextMarker(const VisiblePosition&) const;
    unsigned doAXLineForTextMarker(const VisiblePosition&) const;
    int indexForTextMarker(const VisiblePosition&) const;

    PlainTextRange doAXRangeForLine(unsigned) const;
    PlainTextRange doAXRangeForPosition(const IntPoint&) const;
    PlainTextRange doAXRangeForIndex(unsigned) const;
    PlainTextRange doAXStyleRangeForIndex(unsigned) const;

    String doAXStringForRange(const PlainTextRange&) const;
    IntRect doAXBoundsForRange(const PlainTextRange&) const;

    unsigned doAXLineForIndex(unsigned);
alice.liu@apple.com's avatar
alice.liu@apple.com committed
304 305

#if PLATFORM(MAC)
306
    AccessibilityObjectWrapper* wrapper() const { return m_wrapper.get(); }
alice.liu@apple.com's avatar
alice.liu@apple.com committed
307 308
    void setWrapper(AccessibilityObjectWrapper* wrapper) { m_wrapper = wrapper; }
#endif
309

alice.liu@apple.com's avatar
alice.liu@apple.com committed
310 311 312
private:
    RenderObject* m_renderer;
    RefPtr<HTMLAreaElement> m_areaElement;
313 314 315 316 317
    Vector<RefPtr<AccessibilityObject> > m_children;
    unsigned m_id;

    void clearChildren();
    void removeAXObjectID();
318

319
    bool isDetached() const { return !m_renderer; }
320

alice.liu@apple.com's avatar
alice.liu@apple.com committed
321 322 323 324 325 326 327 328
#if PLATFORM(MAC)
    RetainPtr<AccessibilityObjectWrapper> m_wrapper;
#endif
};

} // namespace WebCore

#endif // AccessibilityObject_h