9f28f4122326b1d5217933ec63b92484730857cc
[WebKit-https.git] / Source / WebCore / accessibility / AccessibilityTable.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 AccessibilityTable_h
30 #define AccessibilityTable_h
31
32 #include "AccessibilityRenderObject.h"
33 #include <wtf/Forward.h>
34
35 #if PLATFORM(MAC) && !PLATFORM(IOS) && __MAC_OS_X_VERSION_MIN_REQUIRED == 1050
36 #define ACCESSIBILITY_TABLES 0
37 #else
38 #define ACCESSIBILITY_TABLES 1
39 #endif
40
41 namespace WebCore {
42
43 class AccessibilityTableCell;
44     
45 class AccessibilityTable : public AccessibilityRenderObject {
46
47 protected:
48     explicit AccessibilityTable(RenderObject*);
49 public:
50     static PassRefPtr<AccessibilityTable> create(RenderObject*);
51     virtual ~AccessibilityTable();
52
53     virtual void init();
54
55     virtual bool isAccessibilityTable() const;
56     virtual bool isDataTable() const;
57
58     virtual AccessibilityRole roleValue() const;
59     virtual bool isAriaTable() const { return false; }
60     
61     virtual bool accessibilityIsIgnored() const;
62     
63     virtual void addChildren();
64     virtual void clearChildren();
65     
66     AccessibilityChildrenVector& columns();
67     AccessibilityChildrenVector& rows();
68     
69     virtual bool supportsSelectedRows() { return false; }
70     unsigned columnCount();
71     unsigned rowCount();
72     virtual int tableLevel() const;
73     
74     virtual String title() const;
75     
76     // all the cells in the table
77     void cells(AccessibilityChildrenVector&);
78     virtual AccessibilityTableCell* cellForColumnAndRow(unsigned column, unsigned row);
79     
80     void columnHeaders(AccessibilityChildrenVector&);
81     void rowHeaders(AccessibilityChildrenVector&);
82
83     // an object that contains, as children, all the objects that act as headers
84     AccessibilityObject* headerContainer();
85
86 protected:
87     AccessibilityChildrenVector m_rows;
88     AccessibilityChildrenVector m_columns;
89
90     RefPtr<AccessibilityObject> m_headerContainer;
91     mutable bool m_isAccessibilityTable;
92
93     bool hasARIARole() const;
94     bool isTableExposableThroughAccessibility() const;
95 };
96     
97 inline AccessibilityTable* toAccessibilityTable(AccessibilityObject* object)
98 {
99     ASSERT(!object || object->isAccessibilityTable());
100     return static_cast<AccessibilityTable*>(object);
101 }
102     
103 } // namespace WebCore 
104
105 #endif // AccessibilityTable_h