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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef ACCESSIBILITY_EXT_ACCESSIBLEBROWSEBOXHEADERBAR_HXX
#define ACCESSIBILITY_EXT_ACCESSIBLEBROWSEBOXHEADERBAR_HXX
#include "accessibility/extended/AccessibleBrowseBoxTableBase.hxx"
#include <cppuhelper/implbase1.hxx>
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
// ============================================================================
namespace accessibility {
// ============================================================================
typedef ::cppu::ImplHelper1<
::com::sun::star::accessibility::XAccessibleSelection >
AccessibleBrowseBoxHeaderBarImplHelper;
/** This class represents the accessible object of a header bar of a BrowseBox
control (row or column header bar). This object supports the
XAccessibleSelection interface. Selecting a child of this object selects
complete rows or columns of the data table. */
class AccessibleBrowseBoxHeaderBar :
public AccessibleBrowseBoxTableBase,
public AccessibleBrowseBoxHeaderBarImplHelper
{
public:
/** @param eObjType One of the two allowed types BBTYPE_ROWHEADERBAR or
BBTYPE_COLUMNHEADERBAR. */
AccessibleBrowseBoxHeaderBar(
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox,
::svt::AccessibleBrowseBoxObjType eObjType );
protected:
virtual ~AccessibleBrowseBoxHeaderBar();
public:
// XAccessibleContext -----------------------------------------------------
/** @return
The XAccessible interface of the specified child.
*/
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible > SAL_CALL
getAccessibleChild( sal_Int32 nChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** @return The index of this object among the parent's children. */
virtual sal_Int32 SAL_CALL getAccessibleIndexInParent()
throw ( ::com::sun::star::uno::RuntimeException );
// XAccessibleComponent ---------------------------------------------------
/** @return The accessible child rendered under the given point. */
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible > SAL_CALL
getAccessibleAtPoint( const ::com::sun::star::awt::Point& rPoint )
throw ( ::com::sun::star::uno::RuntimeException );
/** Grabs the focus to (the current cell of) the data table. */
virtual void SAL_CALL grabFocus()
throw ( ::com::sun::star::uno::RuntimeException );
/** @return The key bindings associated with this object. */
virtual ::com::sun::star::uno::Any SAL_CALL getAccessibleKeyBinding()
throw ( ::com::sun::star::uno::RuntimeException );
// XAccessibleTable -------------------------------------------------------
/** @return The description text of the specified row. */
virtual ::rtl::OUString SAL_CALL
getAccessibleRowDescription( sal_Int32 nRow )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** @return The description text of the specified column. */
virtual ::rtl::OUString SAL_CALL
getAccessibleColumnDescription( sal_Int32 nColumn )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** @return The XAccessibleTable interface of the row header bar. */
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleTable > SAL_CALL
getAccessibleRowHeaders()
throw ( ::com::sun::star::uno::RuntimeException );
/** @return The XAccessibleTable interface of the column header bar. */
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleTable > SAL_CALL
getAccessibleColumnHeaders()
throw ( ::com::sun::star::uno::RuntimeException );
/** @return An index list of completely selected rows. */
virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL
getSelectedAccessibleRows()
throw ( ::com::sun::star::uno::RuntimeException );
/** @return An index list of completely selected columns. */
virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL
getSelectedAccessibleColumns()
throw ( ::com::sun::star::uno::RuntimeException );
/** @return <TRUE/>, if the specified row is completely selected. */
virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** @return <TRUE/>, if the specified column is completely selected. */
virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** @return The XAccessible interface of the cell object at the specified
cell position. */
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible > SAL_CALL
getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** @return <TRUE/>, if the specified cell is selected. */
virtual sal_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
// XAccessibleSelection ---------------------------------------------------
/** Selects the specified child (row or column of the table). */
virtual void SAL_CALL selectAccessibleChild( sal_Int32 nChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** @return <TRUE/>, if the specified child (row/column) is selected. */
virtual sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int32 nChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** Clears the complete selection. */
virtual void SAL_CALL clearAccessibleSelection()
throw ( ::com::sun::star::uno::RuntimeException );
/** Selects all children or first, if multiselection is not supported. */
virtual void SAL_CALL selectAllAccessibleChildren()
throw ( ::com::sun::star::uno::RuntimeException );
/** @return The number of selected rows/columns. */
virtual sal_Int32 SAL_CALL getSelectedAccessibleChildCount()
throw ( ::com::sun::star::uno::RuntimeException );
/** @return The specified selected row/column. */
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible > SAL_CALL
getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
/** Removes the specified row/column from the selection. */
virtual void SAL_CALL deselectAccessibleChild( sal_Int32 nSelectedChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
// XInterface -------------------------------------------------------------
/** Queries for a new interface. */
::com::sun::star::uno::Any SAL_CALL queryInterface(
const ::com::sun::star::uno::Type& rType )
throw ( ::com::sun::star::uno::RuntimeException );
/** Aquires the object (calls acquire() on base class). */
virtual void SAL_CALL acquire() throw ();
/** Releases the object (calls release() on base class). */
virtual void SAL_CALL release() throw ();
// XServiceInfo -----------------------------------------------------------
/** @return The name of this class. */
virtual ::rtl::OUString SAL_CALL getImplementationName()
throw ( ::com::sun::star::uno::RuntimeException );
/** @return An unique implementation ID. */
virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId()
throw ( ::com::sun::star::uno::RuntimeException );
protected:
// internal virtual methods -----------------------------------------------
/** @attention This method requires locked mutex's and a living object.
@return The bounding box (VCL rect.) relative to the parent window. */
virtual Rectangle implGetBoundingBox();
/** @attention This method requires locked mutex's and a living object.
@return The bounding box (VCL rect.) in screen coordinates. */
virtual Rectangle implGetBoundingBoxOnScreen();
/** @attention This method requires locked mutex's and a living object.
@return The count of used rows. */
virtual sal_Int32 implGetRowCount() const;
/** @attention This method requires locked mutex's and a living object.
@return The count of used columns. */
virtual sal_Int32 implGetColumnCount() const;
// internal helper methods ------------------------------------------------
/** @return <TRUE/>, if the objects is a header bar for rows. */
inline sal_Bool isRowBar() const;
/** @return <TRUE/>, if the objects is a header bar for columns. */
inline sal_Bool isColumnBar() const;
/** Returns the specified row or column. Uses one of the parameters,
depending on object type.
@attention This method requires locked mutex's and a living object.
@return The XAccessible interface of the specified column/row. */
::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible >
implGetChild( sal_Int32 nRow, sal_uInt16 nColumnPos );
/** @attention This method requires locked mutex's and a living object.
@return The absolute child index from the index of selected children.
@throws <type>IndexOutOfBoundsException</type>
If the specified index is invalid. */
sal_Int32 implGetChildIndexFromSelectedIndex( sal_Int32 nSelectedChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException );
/** @attention This method requires locked mutex's and a living object.
@throws <type>IndexOutOfBoundsException</type>
If the specified row/column index (depending on type) is invalid. */
void ensureIsValidHeaderIndex( sal_Int32 nIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException );
};
// inlines --------------------------------------------------------------------
inline sal_Bool AccessibleBrowseBoxHeaderBar::isRowBar() const
{
return getType() == ::svt::BBTYPE_ROWHEADERBAR;
}
inline sal_Bool AccessibleBrowseBoxHeaderBar::isColumnBar() const
{
return getType() == ::svt::BBTYPE_COLUMNHEADERBAR;
}
// ============================================================================
} // namespace accessibility
// ============================================================================
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
