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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
/* -*- 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 .
*/
#pragma once
#include <extended/AccessibleBrowseBoxBase.hxx>
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/accessibility/XAccessibleTable.hpp>
namespace accessibility {
typedef ::cppu::ImplHelper1< css::accessibility::XAccessibleTable >
AccessibleBrowseBoxTableImplHelper;
/** The BrowseBox accessible table objects inherit from this base class. It
implements basic functionality for the XAccessibleTable interface.
BrowseBox table objects are: the data table, the column header bar and the
row header bar. */
class AccessibleBrowseBoxTableBase :
public BrowseBoxAccessibleElement,
public AccessibleBrowseBoxTableImplHelper
{
public:
/** Constructor sets specified name and description. If the constant of a
text is BBTEXT_NONE, the derived class has to set the text via
implSetName() and implSetDescription() (in Ctor) or later via
setAccessibleName() and setAccessibleDescription() (these methods
notify the listeners about the change).
@param rxParent XAccessible interface of the parent object.
@param rBrowseBox The BrowseBox control.
@param eObjType Type of BrowseBox object. */
AccessibleBrowseBoxTableBase(
const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
::vcl::IAccessibleTableProvider& rBrowseBox,
AccessibleBrowseBoxObjType eObjType );
protected:
virtual ~AccessibleBrowseBoxTableBase() override = default;
public:
// XAccessibleContext
/** @return The count of visible children. */
virtual sal_Int32 SAL_CALL getAccessibleChildCount() override;
/** @return The role of this object (a table). */
virtual sal_Int16 SAL_CALL getAccessibleRole() override;
/* Derived classes have to implement:
- getAccessibleChild,
- getAccessibleIndexInParent. */
// XAccessibleComponent
/* Derived classes have to implement:
- getAccessibleAt,
- grabFocus. */
// XAccessibleTable
/** @return The number of used rows in the table (0 = empty table). */
virtual sal_Int32 SAL_CALL getAccessibleRowCount() override;
/** @return The number of used columns in the table (0 = empty table). */
virtual sal_Int32 SAL_CALL getAccessibleColumnCount() override;
/** @return The row extent of the specified cell (always 1). */
virtual sal_Int32 SAL_CALL
getAccessibleRowExtentAt( sal_Int32 nRow, sal_Int32 nColumn ) override;
/** @return The column extent of the specified cell (always 1). */
virtual sal_Int32 SAL_CALL
getAccessibleColumnExtentAt( sal_Int32 nRow, sal_Int32 nColumn ) override;
/** @return The caption cell of the table (not supported). */
virtual css::uno::Reference<
css::accessibility::XAccessible > SAL_CALL
getAccessibleCaption() override;
/** @return The summary object of the table (not supported). */
virtual css::uno::Reference<
css::accessibility::XAccessible > SAL_CALL
getAccessibleSummary() override;
/** @return The child index of the specified cell. */
virtual sal_Int32 SAL_CALL getAccessibleIndex( sal_Int32 nRow, sal_Int32 nColumn ) override;
/** @return The row index of the specified child cell. */
virtual sal_Int32 SAL_CALL getAccessibleRow( sal_Int32 nChildIndex ) override;
/** @return The column index of the specified child cell. */
virtual sal_Int32 SAL_CALL getAccessibleColumn( sal_Int32 nChildIndex ) override;
/* Derived classes have to implement:
- getAccessibleRowDescription,
- getAccessibleColumnDescription,
- getAccessibleRowHeaders,
- getAccessibleColumnHeaders,
- getSelectedAccessibleRows,
- getSelectedAccessibleColumns,
- isAccessibleRowSelected,
- isAccessibleColumnSelected,
- getAccessibleCellAt,
- isAccessibleSelected. */
// XInterface
/** Queries for a new interface. */
css::uno::Any SAL_CALL queryInterface( const css::uno::Type& rType ) override;
/** Acquires the object (calls acquire() on base class). */
virtual void SAL_CALL acquire() noexcept override;
/** Releases the object (calls release() on base class). */
virtual void SAL_CALL release() noexcept override;
// XTypeProvider
/** @return a sequence of possible types (received from base classes). */
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
/** @return a unique implementation ID. */
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
// XServiceInfo
/* Derived classes have to implement:
- getImplementationName */
protected:
// internal virtual methods
/** @attention This method requires locked mutex's and a living object.
@return The count of data rows without header bar. */
virtual sal_Int32 implGetRowCount() const;
/** @attention This method requires locked mutex's and a living object.
@return The count of data columns without "handle column". */
virtual sal_Int32 implGetColumnCount() const;
// internal helper methods
/** @return TRUE, if first BrowseBox column is the "handle column". */
bool implHasHandleColumn() const;
/** @attention This method requires locked mutex's and a living object.
@param nColumn
the position of the column in the Accessible world
@return
the position of the column in VCL the Accessible world
*/
sal_uInt16 implToVCLColumnPos( sal_Int32 nColumn ) const;
/** @attention This method requires locked mutex's and a living object.
@return The number of cells of the table. */
sal_Int32 implGetChildCount() const;
/** @attention This method requires locked mutex's and a living object.
@return The row index of the specified cell index. */
sal_Int32 implGetRow( sal_Int32 nChildIndex ) const;
/** @attention This method requires locked mutex's and a living object.
@return The column index of the specified cell index. */
sal_Int32 implGetColumn( sal_Int32 nChildIndex ) const;
/** @attention This method requires locked mutex's and a living object.
@return TRUE, if the specified row is selected. */
bool implIsRowSelected( sal_Int32 nRow ) const;
/** @attention This method requires locked mutex's and a living object.
@return TRUE, if the specified column is selected. */
bool implIsColumnSelected( sal_Int32 nColumn ) const;
/** Selects/deselects a row (tries to expand selection).
@attention This method requires locked mutex's and a living object.
@param nRow Row to select
@param bSelect TRUE = select, FALSE = deselect */
void implSelectRow( sal_Int32 nRow, bool bSelect );
/** Selects/deselects a column (tries to expand selection).
@attention This method requires locked mutex's and a living object.
@param nColumnPos column number to select
@param bSelect TRUE = select, FALSE = deselect */
void implSelectColumn( sal_Int32 nColumnPos, bool bSelect );
/** @attention This method requires locked mutex's and a living object.
@return The count of selected rows. */
sal_Int32 implGetSelectedRowCount() const;
/** @attention This method requires locked mutex's and a living object.
@return The count of selected columns. */
sal_Int32 implGetSelectedColumnCount() const;
/** Fills a sequence with sorted indexes of completely selected rows.
@attention This method requires locked mutex's and a living object.
@param rSeq Out-parameter that takes the sorted row index list. */
void implGetSelectedRows( css::uno::Sequence< sal_Int32 >& rSeq );
/** Fills a sequence with sorted indexes of completely selected columns.
@attention This method requires locked mutex's and a living object.
@param rSeq Out-parameter that takes the sorted column index list. */
void implGetSelectedColumns( css::uno::Sequence< sal_Int32 >& rSeq );
/** @attention This method requires locked mutex's and a living object.
@throws <type>IndexOutOfBoundsException</type>
If the specified row index is invalid. */
void ensureIsValidRow( sal_Int32 nRow );
/** @attention This method requires locked mutex's and a living object.
@throws <type>IndexOutOfBoundsException</type>
If the specified column index is invalid. */
void ensureIsValidColumn( sal_Int32 nColumn );
/** @attention This method requires locked mutex's and a living object.
@throws <type>IndexOutOfBoundsException</type>
If the specified cell address is invalid. */
void ensureIsValidAddress( sal_Int32 nRow, sal_Int32 nColumn );
/** @attention This method requires locked mutex's and a living object.
@throws <type>IndexOutOfBoundsException</type>
If the specified child index is invalid. */
void ensureIsValidIndex( sal_Int32 nChildIndex );
};
} // namespace accessibility
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
