/platform/external/webkit/WebCore/accessibility/AccessibilityRenderObject.h

https://github.com/aharish/totoro-gb-opensource-update2 · C Header · 307 lines · 236 code · 44 blank · 27 comment · 0 complexity · 5be468627cf8d4b982eff83d6c073a47 MD5 · raw file

  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. #ifndef AccessibilityRenderObject_h
  29. #define AccessibilityRenderObject_h
  30. #include "AccessibilityObject.h"
  31. namespace WebCore {
  32. class AXObjectCache;
  33. class Element;
  34. class Frame;
  35. class FrameView;
  36. class HitTestResult;
  37. class HTMLAnchorElement;
  38. class HTMLAreaElement;
  39. class HTMLElement;
  40. class HTMLLabelElement;
  41. class HTMLMapElement;
  42. class HTMLSelectElement;
  43. class IntPoint;
  44. class IntSize;
  45. class Node;
  46. class RenderObject;
  47. class RenderListBox;
  48. class RenderTextControl;
  49. class RenderView;
  50. class VisibleSelection;
  51. class String;
  52. class Widget;
  53. class AccessibilityRenderObject : public AccessibilityObject {
  54. protected:
  55. AccessibilityRenderObject(RenderObject*);
  56. public:
  57. static PassRefPtr<AccessibilityRenderObject> create(RenderObject*);
  58. virtual ~AccessibilityRenderObject();
  59. bool isAccessibilityRenderObject() const { return true; }
  60. virtual bool isAnchor() const;
  61. virtual bool isAttachment() const;
  62. virtual bool isHeading() const;
  63. virtual bool isLink() const;
  64. virtual bool isImageButton() const;
  65. virtual bool isImage() const;
  66. virtual bool isNativeImage() const;
  67. virtual bool isPasswordField() const;
  68. virtual bool isTextControl() const;
  69. virtual bool isNativeTextControl() const;
  70. virtual bool isWebArea() const;
  71. virtual bool isCheckboxOrRadio() const;
  72. virtual bool isFileUploadButton() const;
  73. virtual bool isInputImage() const;
  74. virtual bool isProgressIndicator() const;
  75. virtual bool isSlider() const;
  76. virtual bool isMenuRelated() const;
  77. virtual bool isMenu() const;
  78. virtual bool isMenuBar() const;
  79. virtual bool isMenuButton() const;
  80. virtual bool isMenuItem() const;
  81. virtual bool isControl() const;
  82. virtual bool isFieldset() const;
  83. virtual bool isGroup() const;
  84. virtual bool isEnabled() const;
  85. virtual bool isSelected() const;
  86. virtual bool isFocused() const;
  87. virtual bool isChecked() const;
  88. virtual bool isHovered() const;
  89. virtual bool isIndeterminate() const;
  90. virtual bool isLoaded() const;
  91. virtual bool isMultiSelectable() const;
  92. virtual bool isOffScreen() const;
  93. virtual bool isPressed() const;
  94. virtual bool isReadOnly() const;
  95. virtual bool isVisited() const;
  96. virtual bool isRequired() const;
  97. virtual bool isLinked() const;
  98. virtual bool isExpanded() const;
  99. virtual void setIsExpanded(bool);
  100. const AtomicString& getAttribute(const QualifiedName&) const;
  101. virtual bool canSetFocusAttribute() const;
  102. virtual bool canSetTextRangeAttributes() const;
  103. virtual bool canSetValueAttribute() const;
  104. virtual bool canSetExpandedAttribute() const;
  105. virtual bool hasIntValue() const;
  106. virtual bool accessibilityIsIgnored() const;
  107. virtual int headingLevel() const;
  108. virtual int intValue() const;
  109. virtual String valueDescription() const;
  110. virtual float valueForRange() const;
  111. virtual float maxValueForRange() const;
  112. virtual float minValueForRange() const;
  113. virtual AccessibilityObject* selectedRadioButton();
  114. virtual AccessibilityObject* selectedTabItem();
  115. virtual int layoutCount() const;
  116. virtual double estimatedLoadingProgress() const;
  117. virtual AccessibilityObject* doAccessibilityHitTest(const IntPoint&) const;
  118. virtual AccessibilityObject* focusedUIElement() const;
  119. virtual AccessibilityObject* firstChild() const;
  120. virtual AccessibilityObject* lastChild() const;
  121. virtual AccessibilityObject* previousSibling() const;
  122. virtual AccessibilityObject* nextSibling() const;
  123. virtual AccessibilityObject* parentObject() const;
  124. virtual AccessibilityObject* parentObjectIfExists() const;
  125. virtual AccessibilityObject* observableObject() const;
  126. virtual void linkedUIElements(AccessibilityChildrenVector&) const;
  127. virtual bool exposesTitleUIElement() const;
  128. virtual AccessibilityObject* titleUIElement() const;
  129. virtual AccessibilityObject* correspondingControlForLabelElement() const;
  130. virtual AccessibilityObject* correspondingLabelForControlElement() const;
  131. virtual void ariaOwnsElements(AccessibilityChildrenVector&) const;
  132. virtual bool supportsARIAOwns() const;
  133. virtual AccessibilityRole ariaRoleAttribute() const;
  134. virtual bool isPresentationalChildOfAriaRole() const;
  135. virtual bool ariaRoleHasPresentationalChildren() const;
  136. void updateAccessibilityRole();
  137. virtual AXObjectCache* axObjectCache() const;
  138. virtual Element* actionElement() const;
  139. Element* mouseButtonListener() const;
  140. FrameView* frameViewIfRenderView() const;
  141. virtual Element* anchorElement() const;
  142. AccessibilityObject* menuForMenuButton() const;
  143. AccessibilityObject* menuButtonForMenu() const;
  144. virtual IntRect boundingBoxRect() const;
  145. virtual IntRect elementRect() const;
  146. virtual IntSize size() const;
  147. virtual IntPoint clickPoint() const;
  148. void setRenderer(RenderObject* renderer) { m_renderer = renderer; }
  149. RenderObject* renderer() const { return m_renderer; }
  150. RenderView* topRenderer() const;
  151. RenderTextControl* textControl() const;
  152. Document* document() const;
  153. FrameView* topDocumentFrameView() const;
  154. HTMLLabelElement* labelElementContainer() const;
  155. virtual KURL url() const;
  156. virtual PlainTextRange selectedTextRange() const;
  157. virtual VisibleSelection selection() const;
  158. virtual String stringValue() const;
  159. virtual String ariaLabeledByAttribute() const;
  160. virtual String title() const;
  161. virtual String ariaDescribedByAttribute() const;
  162. virtual String accessibilityDescription() const;
  163. virtual String helpText() const;
  164. virtual String textUnderElement() const;
  165. virtual String text() const;
  166. virtual int textLength() const;
  167. virtual PassRefPtr<Range> ariaSelectedTextDOMRange() const;
  168. virtual String selectedText() const;
  169. virtual const AtomicString& accessKey() const;
  170. virtual const String& actionVerb() const;
  171. virtual Widget* widget() const;
  172. virtual Widget* widgetForAttachmentView() const;
  173. virtual void getDocumentLinks(AccessibilityChildrenVector&);
  174. virtual FrameView* documentFrameView() const;
  175. virtual String language() const;
  176. virtual unsigned hierarchicalLevel() const;
  177. virtual const AccessibilityChildrenVector& children();
  178. virtual void setFocused(bool);
  179. virtual void setSelectedTextRange(const PlainTextRange&);
  180. virtual void setValue(const String&);
  181. virtual void setSelected(bool);
  182. virtual void setSelectedRows(AccessibilityChildrenVector&);
  183. virtual void changeValueByPercent(float percentChange);
  184. virtual AccessibilityOrientation orientation() const;
  185. virtual void increment();
  186. virtual void decrement();
  187. virtual void detach();
  188. virtual void childrenChanged();
  189. virtual void contentChanged();
  190. virtual void addChildren();
  191. virtual bool canHaveChildren() const;
  192. virtual void selectedChildren(AccessibilityChildrenVector&);
  193. virtual void visibleChildren(AccessibilityChildrenVector&);
  194. virtual void tabChildren(AccessibilityChildrenVector&);
  195. virtual bool shouldFocusActiveDescendant() const;
  196. virtual AccessibilityObject* activeDescendant() const;
  197. virtual void handleActiveDescendantChanged();
  198. virtual VisiblePositionRange visiblePositionRange() const;
  199. virtual VisiblePositionRange visiblePositionRangeForLine(unsigned) const;
  200. virtual IntRect boundsForVisiblePositionRange(const VisiblePositionRange&) const;
  201. virtual void setSelectedVisiblePositionRange(const VisiblePositionRange&) const;
  202. virtual bool supportsARIAFlowTo() const;
  203. virtual void ariaFlowToElements(AccessibilityChildrenVector&) const;
  204. virtual bool supportsARIADropping();
  205. virtual bool supportsARIADragging();
  206. virtual bool isARIAGrabbed();
  207. virtual void setARIAGrabbed(bool);
  208. virtual void determineARIADropEffects(Vector<String>&);
  209. virtual VisiblePosition visiblePositionForPoint(const IntPoint&) const;
  210. virtual VisiblePosition visiblePositionForIndex(unsigned indexValue, bool lastIndexOK) const;
  211. virtual int index(const VisiblePosition&) const;
  212. virtual VisiblePosition visiblePositionForIndex(int) const;
  213. virtual int indexForVisiblePosition(const VisiblePosition&) const;
  214. virtual PlainTextRange doAXRangeForLine(unsigned) const;
  215. virtual PlainTextRange doAXRangeForIndex(unsigned) const;
  216. virtual String doAXStringForRange(const PlainTextRange&) const;
  217. virtual IntRect doAXBoundsForRange(const PlainTextRange&) const;
  218. virtual void updateBackingStore();
  219. virtual String stringValueForMSAA() const;
  220. virtual String stringRoleForMSAA() const;
  221. virtual String nameForMSAA() const;
  222. virtual String descriptionForMSAA() const;
  223. virtual AccessibilityRole roleValueForMSAA() const;
  224. protected:
  225. RenderObject* m_renderer;
  226. AccessibilityRole m_ariaRole;
  227. mutable bool m_childrenDirty;
  228. void setRenderObject(RenderObject* renderer) { m_renderer = renderer; }
  229. void ariaLabeledByElements(Vector<Element*>& elements) const;
  230. virtual bool isDetached() const { return !m_renderer; }
  231. private:
  232. void ariaListboxSelectedChildren(AccessibilityChildrenVector&);
  233. void ariaListboxVisibleChildren(AccessibilityChildrenVector&);
  234. bool ariaIsHidden() const;
  235. bool isDescendantOfBarrenParent() const;
  236. bool isAllowedChildOfTree() const;
  237. bool hasTextAlternative() const;
  238. String positionalDescriptionForMSAA() const;
  239. Element* menuElementForMenuButton() const;
  240. Element* menuItemElementForMenu() const;
  241. AccessibilityRole determineAccessibilityRole();
  242. AccessibilityRole determineAriaRoleAttribute() const;
  243. bool isTabItemSelected() const;
  244. IntRect checkboxOrRadioRect() const;
  245. void addRadioButtonGroupMembers(AccessibilityChildrenVector& linkedUIElements) const;
  246. AccessibilityObject* internalLinkElement() const;
  247. AccessibilityObject* accessibilityImageMapHitTest(HTMLAreaElement*, const IntPoint&) const;
  248. AccessibilityObject* accessibilityParentForImageMap(HTMLMapElement* map) const;
  249. void ariaSelectedRows(AccessibilityChildrenVector&);
  250. bool elementAttributeValue(const QualifiedName&) const;
  251. void setElementAttributeValue(const QualifiedName&, bool);
  252. String accessibilityDescriptionForElements(Vector<Element*> &elements) const;
  253. void elementsFromAttribute(Vector<Element*>& elements, const QualifiedName& name) const;
  254. virtual const AtomicString& ariaLiveRegionStatus() const;
  255. virtual const AtomicString& ariaLiveRegionRelevant() const;
  256. virtual bool ariaLiveRegionAtomic() const;
  257. virtual bool ariaLiveRegionBusy() const;
  258. void setNeedsToUpdateChildren() const { m_childrenDirty = true; }
  259. bool needsToUpdateChildren() const { return m_childrenDirty; }
  260. mutable AccessibilityRole m_roleForMSAA;
  261. };
  262. } // namespace WebCore
  263. #endif // AccessibilityRenderObject_h