Source/WebCore/accessibility/AccessibilityRenderObject.h

   1 /*
   2  * Copyright (C) 2008 Apple 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
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef AccessibilityRenderObject_h
  30 #define AccessibilityRenderObject_h
  31
  32 #include "AccessibilityNodeObject.h"
  33 #include "LayoutTypes.h"
  34 #include <wtf/Forward.h>
  35
  36 namespace WebCore {
  37
  38 class AXObjectCache;
  39 class Element;
  40 class Frame;
  41 class FrameView;
  42 class HitTestResult;
  43 class HTMLAnchorElement;
  44 class HTMLAreaElement;
  45 class HTMLElement;
  46 class HTMLLabelElement;
  47 class HTMLMapElement;
  48 class HTMLSelectElement;
  49 class IntPoint;
  50 class IntSize;
  51 class Node;
  52 class RenderListBox;
  53 class RenderTextControl;
  54 class RenderView;
  55 class VisibleSelection;
  56 class Widget;
  57
  58 class AccessibilityRenderObject : public AccessibilityNodeObject {
  59 protected:
  60     AccessibilityRenderObject(RenderObject*);
  61 public:
  62     static PassRefPtr<AccessibilityRenderObject> create(RenderObject*);
  63     virtual ~AccessibilityRenderObject();
  64
  65     virtual bool isAccessibilityRenderObject() const { return true; }
  66
  67     virtual void init();
  68
  69     virtual bool isAnchor() const;
  70     virtual bool isAttachment() const;
  71     virtual bool isHeading() const;
  72     virtual bool isLink() const;
  73     virtual bool isImageButton() const;
  74     virtual bool isImage() const;
  75     virtual bool isNativeImage() const;
  76     virtual bool isPasswordField() const;
  77     virtual bool isNativeTextControl() const;
  78     virtual bool isSearchField() const;
  79     virtual bool isWebArea() const;
  80     virtual bool isFileUploadButton() const;
  81     virtual bool isInputImage() const;
  82     virtual bool isProgressIndicator() const;
  83     virtual bool isSlider() const;
  84     virtual bool isMenuRelated() const;
  85     virtual bool isMenu() const;
  86     virtual bool isMenuBar() const;
  87     virtual bool isMenuButton() const;
  88     virtual bool isMenuItem() const;
  89     virtual bool isControl() const;
  90     virtual bool isFieldset() const;
  91     virtual bool isGroup() const;
  92
  93     virtual bool isEnabled() const;
  94     virtual bool isSelected() const;
  95     virtual bool isFocused() const;
  96     virtual bool isChecked() const;
  97     virtual bool isHovered() const;
  98     virtual bool isIndeterminate() const;
  99     virtual bool isLoaded() const;
 100     virtual bool isMultiSelectable() const;
 101     virtual bool isOffScreen() const;
 102     virtual bool isPressed() const;
 103     virtual bool isReadOnly() const;
 104     virtual bool isUnvisited() const;
 105     virtual bool isVisited() const;
 106     virtual bool isRequired() const;
 107     virtual bool isLinked() const;
 108     virtual bool hasBoldFont() const;
 109     virtual bool hasItalicFont() const;
 110     virtual bool hasPlainText() const;
 111     virtual bool hasSameFont(RenderObject*) const;
 112     virtual bool hasSameFontColor(RenderObject*) const;
 113     virtual bool hasSameStyle(RenderObject*) const;
 114     virtual bool hasUnderline() const;
 115
 116     virtual bool canSetTextRangeAttributes() const;
 117     virtual bool canSetValueAttribute() const;
 118     virtual bool canSetExpandedAttribute() const;
 119
 120     virtual void setAccessibleName(const AtomicString&);
 121
 122     // Provides common logic used by all elements when determining isIgnored.
 123     AccessibilityObjectInclusion accessibilityIsIgnoredBase() const;
 124     virtual bool accessibilityIsIgnored() const;
 125
 126     virtual int headingLevel() const;
 127     virtual AccessibilityButtonState checkboxOrRadioValue() const;
 128     virtual String valueDescription() const;
 129     virtual float valueForRange() const;
 130     virtual float maxValueForRange() const;
 131     virtual float minValueForRange() const;
 132     virtual float stepValueForRange() const;
 133     virtual AccessibilityObject* selectedRadioButton();
 134     virtual AccessibilityObject* selectedTabItem();
 135     virtual int layoutCount() const;
 136     virtual double estimatedLoadingProgress() const;
 137
 138     virtual AccessibilityObject* firstChild() const;
 139     virtual AccessibilityObject* lastChild() const;
 140     virtual AccessibilityObject* previousSibling() const;
 141     virtual AccessibilityObject* nextSibling() const;
 142     virtual AccessibilityObject* parentObject() const;
 143     virtual AccessibilityObject* parentObjectIfExists() const;
 144     virtual AccessibilityObject* observableObject() const;
 145     virtual void linkedUIElements(AccessibilityChildrenVector&) const;
 146     virtual bool exposesTitleUIElement() const;
 147     virtual AccessibilityObject* titleUIElement() const;
 148     virtual AccessibilityObject* correspondingControlForLabelElement() const;
 149     virtual AccessibilityObject* correspondingLabelForControlElement() const;
 150
 151     virtual void ariaOwnsElements(AccessibilityChildrenVector&) const;
 152     virtual bool supportsARIAOwns() const;
 153     virtual bool isPresentationalChildOfAriaRole() const;
 154     virtual bool ariaRoleHasPresentationalChildren() const;
 155
 156     // Should be called on the root accessibility object to kick off a hit test.
 157     virtual AccessibilityObject* accessibilityHitTest(const IntPoint&) const;
 158
 159     virtual Element* actionElement() const;
 160     Element* mouseButtonListener() const;
 161     FrameView* frameViewIfRenderView() const;
 162     virtual Element* anchorElement() const;
 163     AccessibilityObject* menuForMenuButton() const;
 164     AccessibilityObject* menuButtonForMenu() const;
 165
 166     virtual LayoutRect boundingBoxRect() const;
 167     virtual LayoutRect elementRect() const;
 168     virtual IntPoint clickPoint();
 169
 170     void setRenderer(RenderObject*);
 171     virtual RenderObject* renderer() const { return m_renderer; }
 172     RenderBoxModelObject* renderBoxModelObject() const;
 173     virtual Node* node() const;
 174
 175     virtual Document* document() const;
 176
 177     RenderView* topRenderer() const;
 178     RenderTextControl* textControl() const;
 179     FrameView* topDocumentFrameView() const;
 180     Document* topDocument() const;
 181     HTMLLabelElement* labelElementContainer() const;
 182
 183     virtual KURL url() const;
 184     virtual PlainTextRange selectedTextRange() const;
 185     virtual VisibleSelection selection() const;
 186     virtual String stringValue() const;
 187     virtual String ariaLabeledByAttribute() const;
 188     virtual String title() const;
 189     virtual String ariaDescribedByAttribute() const;
 190     virtual String accessibilityDescription() const;
 191     virtual String helpText() const;
 192     virtual String textUnderElement() const;
 193     virtual String text() const;
 194     virtual int textLength() const;
 195     virtual String selectedText() const;
 196     virtual const AtomicString& accessKey() const;
 197     virtual const String& actionVerb() const;
 198     virtual Widget* widget() const;
 199     virtual Widget* widgetForAttachmentView() const;
 200     virtual void getDocumentLinks(AccessibilityChildrenVector&);
 201     virtual FrameView* documentFrameView() const;
 202     virtual unsigned hierarchicalLevel() const;
 203
 204     virtual void clearChildren();
 205     virtual void updateChildrenIfNecessary();
 206
 207     virtual void setFocused(bool);
 208     virtual void setSelectedTextRange(const PlainTextRange&);
 209     virtual void setValue(const String&);
 210     virtual void setSelectedRows(AccessibilityChildrenVector&);
 211     virtual void changeValueByPercent(float percentChange);
 212     virtual AccessibilityOrientation orientation() const;
 213     virtual void increment();
 214     virtual void decrement();
 215
 216     virtual void detach();
 217     virtual void contentChanged();
 218     virtual void addChildren();
 219     virtual bool canHaveChildren() const;
 220     virtual void selectedChildren(AccessibilityChildrenVector&);
 221     virtual void visibleChildren(AccessibilityChildrenVector&);
 222     virtual void tabChildren(AccessibilityChildrenVector&);
 223     virtual bool shouldFocusActiveDescendant() const;
 224     virtual AccessibilityObject* activeDescendant() const;
 225     virtual void handleActiveDescendantChanged();
 226     virtual void handleAriaExpandedChanged();
 227
 228     virtual VisiblePositionRange visiblePositionRange() const;
 229     virtual VisiblePositionRange visiblePositionRangeForLine(unsigned) const;
 230     virtual IntRect boundsForVisiblePositionRange(const VisiblePositionRange&) const;
 231     virtual void setSelectedVisiblePositionRange(const VisiblePositionRange&) const;
 232     virtual bool supportsARIAFlowTo() const;
 233     virtual void ariaFlowToElements(AccessibilityChildrenVector&) const;
 234     virtual bool ariaHasPopup() const;
 235
 236     virtual bool supportsARIADropping() const;
 237     virtual bool supportsARIADragging() const;
 238     virtual bool isARIAGrabbed();
 239     virtual void determineARIADropEffects(Vector<String>&);
 240
 241     virtual VisiblePosition visiblePositionForPoint(const IntPoint&) const;
 242     virtual VisiblePosition visiblePositionForIndex(unsigned indexValue, bool lastIndexOK) const;
 243     virtual int index(const VisiblePosition&) const;
 244
 245     virtual VisiblePosition visiblePositionForIndex(int) const;
 246     virtual int indexForVisiblePosition(const VisiblePosition&) const;
 247
 248     virtual PlainTextRange doAXRangeForLine(unsigned) const;
 249     virtual PlainTextRange doAXRangeForIndex(unsigned) const;
 250
 251     virtual String doAXStringForRange(const PlainTextRange&) const;
 252     virtual IntRect doAXBoundsForRange(const PlainTextRange&) const;
 253
 254     virtual String stringValueForMSAA() const;
 255     virtual String stringRoleForMSAA() const;
 256     virtual String nameForMSAA() const;
 257     virtual String descriptionForMSAA() const;
 258     virtual AccessibilityRole roleValueForMSAA() const;
 259
 260 protected:
 261     RenderObject* m_renderer;
 262
 263     void setRenderObject(RenderObject* renderer) { m_renderer = renderer; }
 264     void ariaLabeledByElements(Vector<Element*>& elements) const;
 265     bool needsToUpdateChildren() const { return m_childrenDirty; }
 266     ScrollableArea* getScrollableAreaIfScrollable() const;
 267     void scrollTo(const IntPoint&) const;
 268
 269     virtual bool isDetached() const { return !m_renderer; }
 270
 271     virtual AccessibilityRole determineAccessibilityRole();
 272
 273 private:
 274     void ariaListboxSelectedChildren(AccessibilityChildrenVector&);
 275     void ariaListboxVisibleChildren(AccessibilityChildrenVector&);
 276     bool ariaIsHidden() const;
 277     bool isDescendantOfBarrenParent() const;
 278     bool isAllowedChildOfTree() const;
 279     bool hasTextAlternative() const;
 280     String positionalDescriptionForMSAA() const;
 281     PlainTextRange ariaSelectedTextRange() const;
 282     Element* rootEditableElementForPosition(const Position&) const;
 283     bool nodeIsTextControl(const Node*) const;
 284     virtual void setNeedsToUpdateChildren() { m_childrenDirty = true; }
 285
 286     Element* menuElementForMenuButton() const;
 287     Element* menuItemElementForMenu() const;
 288
 289     bool isTabItemSelected() const;
 290     void alterSliderValue(bool increase);
 291     void changeValueByStep(bool increase);
 292     bool isNativeCheckboxOrRadio() const;
 293     LayoutRect checkboxOrRadioRect() const;
 294     void addRadioButtonGroupMembers(AccessibilityChildrenVector& linkedUIElements) const;
 295     AccessibilityObject* internalLinkElement() const;
 296     AccessibilityObject* accessibilityImageMapHitTest(HTMLAreaElement*, const IntPoint&) const;
 297     AccessibilityObject* accessibilityParentForImageMap(HTMLMapElement*) const;
 298     bool renderObjectIsObservable(RenderObject*) const;
 299     RenderObject* renderParentObject() const;
 300     bool isDescendantOfElementType(const QualifiedName& tagName) const;
 301
 302     void addTextFieldChildren();
 303     void addImageMapChildren();
 304     void addCanvasChildren();
 305     void addAttachmentChildren();
 306 #if PLATFORM(MAC)
 307     void updateAttachmentViewParents();
 308 #endif
 309
 310     void ariaSelectedRows(AccessibilityChildrenVector&);
 311
 312     bool elementAttributeValue(const QualifiedName&) const;
 313     void setElementAttributeValue(const QualifiedName&, bool);
 314
 315     String accessibilityDescriptionForElements(Vector<Element*> &elements) const;
 316     void elementsFromAttribute(Vector<Element*>& elements, const QualifiedName&) const;
 317     String ariaAccessibilityDescription() const;
 318     String webAreaAccessibilityDescription() const;
 319
 320     virtual ESpeak speakProperty() const;
 321
 322     virtual const AtomicString& ariaLiveRegionStatus() const;
 323     virtual const AtomicString& ariaLiveRegionRelevant() const;
 324     virtual bool ariaLiveRegionAtomic() const;
 325     virtual bool ariaLiveRegionBusy() const;
 326
 327     bool inheritsPresentationalRole() const;
 328 };
 329
 330 inline AccessibilityRenderObject* toAccessibilityRenderObject(AccessibilityObject* object)
 331 {
 332     ASSERT(!object || object->isAccessibilityRenderObject());
 333     return static_cast<AccessibilityRenderObject*>(object);
 334 }
 335
 336 inline const AccessibilityRenderObject* toAccessibilityRenderObject(const AccessibilityObject* object)
 337 {
 338     ASSERT(!object || object->isAccessibilityRenderObject());
 339     return static_cast<const AccessibilityRenderObject*>(object);
 340 }
 341
 342 // This will catch anyone doing an unnecessary cast.
 343 void toAccessibilityRenderObject(const AccessibilityRenderObject*);
 344
 345 } // namespace WebCore
 346
 347 #endif // AccessibilityRenderObject_h