blob: 0f568c17878b89524f1e8f6d614c6269fcf6600e [file] [log] [blame]
/*
* 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``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 INC. OR
* 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.
*/
#ifndef AccessibilityUIElement_h
#define AccessibilityUIElement_h
#include <JavaScriptCore/JSObjectRef.h>
#include <wtf/Vector.h>
#if PLATFORM(MAC)
#ifdef __OBJC__
typedef id PlatformUIElement;
#else
typedef struct objc_object* PlatformUIElement;
#endif
#elif PLATFORM(WIN)
#undef _WINSOCKAPI_
#define _WINSOCKAPI_ // Prevent inclusion of winsock.h in windows.h
#include <oleacc.h>
#include <WebCore/COMPtr.h>
typedef COMPtr<IAccessible> PlatformUIElement;
#else
typedef void* PlatformUIElement;
#endif
class AccessibilityUIElement {
public:
AccessibilityUIElement(PlatformUIElement);
AccessibilityUIElement(const AccessibilityUIElement&);
~AccessibilityUIElement();
PlatformUIElement platformUIElement() { return m_element; }
static JSObjectRef makeJSAccessibilityUIElement(JSContextRef, const AccessibilityUIElement&);
void getLinkedUIElements(Vector<AccessibilityUIElement>&);
void getDocumentLinks(Vector<AccessibilityUIElement>&);
void getChildren(Vector<AccessibilityUIElement>&);
void getChildrenWithRange(Vector<AccessibilityUIElement>&, unsigned location, unsigned length);
AccessibilityUIElement elementAtPoint(int x, int y);
AccessibilityUIElement getChildAtIndex(unsigned);
int childrenCount();
AccessibilityUIElement titleUIElement();
AccessibilityUIElement parentElement();
void takeFocus();
void takeSelection();
void addSelection();
void removeSelection();
// Methods - platform-independent implementations
JSStringRef allAttributes();
JSStringRef attributesOfLinkedUIElements();
JSStringRef attributesOfDocumentLinks();
JSStringRef attributesOfChildren();
JSStringRef parameterizedAttributeNames();
// Attributes - platform-independent implementations
JSStringRef attributeValue(JSStringRef attribute);
bool isAttributeSettable(JSStringRef attribute);
JSStringRef role();
JSStringRef title();
JSStringRef description();
JSStringRef language();
JSStringRef accessibilityValue() const;
double x();
double y();
double width();
double height();
double intValue();
double minValue();
double maxValue();
int insertionPointLineNumber();
JSStringRef selectedTextRange();
bool supportsPressAction();
bool isEnabled();
bool isSelected() const;
double clickPointX();
double clickPointY();
bool isVisible() const;
bool isOffScreen() const;
bool isCollapsed() const;
bool hasPopup() const;
// Table-specific attributes
JSStringRef attributesOfColumnHeaders();
JSStringRef attributesOfRowHeaders();
JSStringRef attributesOfColumns();
JSStringRef attributesOfRows();
JSStringRef attributesOfVisibleCells();
JSStringRef attributesOfHeader();
int indexInTable();
JSStringRef rowIndexRange();
JSStringRef columnIndexRange();
// Parameterized attributes
int lineForIndex(int);
JSStringRef boundsForRange(unsigned location, unsigned length);
void setSelectedTextRange(unsigned location, unsigned length);
bool isSelectable() const;
bool isMultiSelectable() const;
// Table-specific
AccessibilityUIElement cellForColumnAndRow(unsigned column, unsigned row);
private:
static JSClassRef getJSClass();
PlatformUIElement m_element;
};
#endif // AccessibilityUIElement_h