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
28
29
30
31
32
33
34
35
36
37
38
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SVTOOLS_ACCESSIBLETABLE_HXX
#define INCLUDED_SVTOOLS_ACCESSIBLETABLE_HXX
#include <vcl/window.hxx>
#include <unotools/accessiblestatesethelper.hxx>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
namespace svt{ namespace table
{
typedef sal_Int32 RowPos;
enum AccessibleTableType
{
/** Child index of the column header bar (first row). */
TCINDEX_COLUMNHEADERBAR = 0,
/** Child index of the row header bar ("handle column"). */
TCINDEX_ROWHEADERBAR = 1,
/** Child index of the data table. */
TCINDEX_TABLE = 2
};
enum AccessibleTableControlObjType
{
TCTYPE_GRIDCONTROL, /// The GridControl itself.
TCTYPE_TABLE, /// The data table.
TCTYPE_ROWHEADERBAR, /// The row header bar.
TCTYPE_COLUMNHEADERBAR, /// The horizontal column header bar.
TCTYPE_TABLECELL, /// A cell of the data table.
TCTYPE_ROWHEADERCELL, /// A cell of the row header bar.
TCTYPE_COLUMNHEADERCELL, /// A cell of the column header bar.
};
/** This abstract class provides methods to implement an accessible table object.
*/
class IAccessibleTable
{
public:
/** @return The position of the current row. */
virtual sal_Int32 GetCurrentRow() const = 0;
/** @return The position of the current column. */
virtual sal_Int32 GetCurrentColumn() const = 0;
/** Creates and returns the accessible object of the whole GridControl. */
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible()= 0;
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessibleControl( sal_Int32 _nIndex )= 0;
virtual OUString GetAccessibleObjectName(AccessibleTableControlObjType eObjType, sal_Int32 _nRow, sal_Int32 _nCol) const= 0;
virtual sal_Bool GoToCell( sal_Int32 _nColumnPos, sal_Int32 _nRow )= 0;
virtual sal_Bool HasColHeader() = 0;
virtual sal_Bool HasRowHeader() = 0;
/** return the description of the specified object.
@param eObjType
The type to ask for
@param _nPosition
The position of a tablecell (index position), header bar column/row cell
@return
The description of the specified object.
*/
virtual OUString GetAccessibleObjectDescription(AccessibleTableControlObjType eObjType, sal_Int32 _nPosition = -1) const= 0;
/** Fills the StateSet with all states (except DEFUNC and SHOWING, done by
the accessible object), depending on the specified object type. */
virtual void FillAccessibleStateSet( ::utl::AccessibleStateSetHelper& rStateSet,
AccessibleTableControlObjType eObjType ) const= 0;
// Window
virtual Rectangle GetWindowExtentsRelative( Window *pRelativeWindow ) const = 0;
virtual void GrabFocus()= 0;
virtual css::uno::Reference< css::accessibility::XAccessible > GetAccessible( sal_Bool bCreate = sal_True )= 0;
virtual Window* GetAccessibleParentWindow() const= 0;
virtual Window* GetWindowInstance()= 0;
virtual sal_Int32 GetAccessibleControlCount() const = 0;
virtual sal_Bool ConvertPointToControlIndex( sal_Int32& _rnIndex, const Point& _rPoint )= 0;
virtual long GetRowCount() const= 0;
virtual long GetColumnCount() const= 0;
virtual sal_Bool HasRowHeader() const= 0;
virtual sal_Bool ConvertPointToCellAddress( sal_Int32& _rnRow, sal_Int32& _rnColPos, const Point& _rPoint )= 0;
virtual Rectangle calcHeaderRect( sal_Bool _bIsColumnBar, sal_Bool _bOnScreen = sal_True ) = 0;
virtual Rectangle calcHeaderCellRect( sal_Bool _bColHeader, sal_Int32 _nPos ) = 0;
virtual Rectangle calcTableRect( sal_Bool _bOnScreen = sal_True ) = 0;
virtual Rectangle calcCellRect( sal_Int32 _nRowPos, sal_Int32 _nColPos ) = 0;
virtual Rectangle GetFieldCharacterBounds(sal_Int32 _nRow,sal_Int32 _nColumnPos,sal_Int32 nIndex)= 0;
virtual sal_Int32 GetFieldIndexAtPoint(sal_Int32 _nRow,sal_Int32 _nColumnPos,const Point& _rPoint)= 0;
virtual void FillAccessibleStateSetForCell( ::utl::AccessibleStateSetHelper& _rStateSet, sal_Int32 _nRow, sal_uInt16 _nColumnPos ) const= 0;
virtual OUString GetRowDescription( sal_Int32 _nRow ) const = 0;
virtual OUString GetRowName(sal_Int32 _nIndex) const = 0;
virtual OUString GetColumnDescription( sal_uInt16 _nColumnPos ) const = 0;
virtual OUString GetColumnName( sal_Int32 _nIndex ) const = 0;
virtual css::uno::Any GetCellContent( sal_Int32 _nRowPos, sal_Int32 _nColPos) const = 0;
virtual OUString GetAccessibleCellText(sal_Int32 _nRowPos, sal_Int32 _nColPos) const = 0;
virtual sal_Int32 GetSelectedRowCount() const = 0;
virtual sal_Int32 GetSelectedRowIndex( sal_Int32 const i_selectionIndex ) const = 0;
virtual bool IsRowSelected( sal_Int32 const i_rowIndex ) const = 0;
virtual void SelectRow( sal_Int32 const i_rowIndex, bool const i_select ) = 0;
virtual void SelectAllRows( bool const i_select ) = 0;
protected:
~IAccessibleTable() {}
};
/** interface for an implementation of a table control's Accesible component
*/
class IAccessibleTableControl
{
public:
/** returns the XAccessible object itself
The reference returned here can be used to control the life time of the
IAccessibleTableImplementation object.
The returned reference is guaranteed to not be <NULL/>.
*/
virtual css::uno::Reference< css::accessibility::XAccessible >
getMyself() = 0;
/** disposes the accessible implementation, so that it becomes defunc
*/
virtual void DisposeAccessImpl() = 0;
/** checks whether the accessible implementation, and its context, are still alive
@return <TRUE/>, if the object is not disposed or disposing.
*/
virtual sal_Bool isAlive() const = 0;
/** returns the accessible object for the row or the column header bar
*/
virtual css::uno::Reference< css::accessibility::XAccessible >
getTableHeader( ::svt::table::AccessibleTableControlObjType _eObjType ) = 0;
/** returns the accessible object for the table representation
*/
virtual css::uno::Reference< css::accessibility::XAccessible >
getTable() = 0;
/** commits the event at all listeners of the cell
@param nEventId
the event id
@param rNewValue
the new value
@param rOldValue
the old value
*/
virtual void commitCellEvent(
sal_Int16 nEventId,
const css::uno::Any& rNewValue,
const css::uno::Any& rOldValue
) = 0;
/** commits the event at all listeners of the table
@param nEventId
the event id
@param rNewValue
the new value
@param rOldValue
the old value
*/
virtual void commitTableEvent(
sal_Int16 nEventId,
const css::uno::Any& rNewValue,
const css::uno::Any& rOldValue
) = 0;
///** Commits an event to all listeners. */
virtual void commitEvent(
sal_Int16 nEventId,
const css::uno::Any& rNewValue,
const css::uno::Any& rOldValue
) = 0;
protected:
~IAccessibleTableControl() {}
};
} // namespace table
} // namespace svt
#endif // INCLUDED_SVTOOLS_ACCESSIBLETABLE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
