blob: ba853381329ff7abaa3c7523f9767e88f4e2c893 (
plain)
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
|
/*************************************************************************
*
* 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 _UTL_ACCESSIBLERELATIONSETHELPER_HXX_
#define _UTL_ACCESSIBLERELATIONSETHELPER_HXX_
#include "unotools/unotoolsdllapi.h"
#ifndef _COM_SUN_STAR_ACCESSIBILITY_XACCESSIBLESSTATESET_HPP_
#include <com/sun/star/accessibility/XAccessibleRelationSet.hpp>
#endif
#include <com/sun/star/uno/Reference.hxx>
#include <cppuhelper/weak.hxx>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/lang/XServiceName.hpp>
#include <vos/mutex.hxx>
#include <cppuhelper/implbase1.hxx>
#include <comphelper/servicehelper.hxx>
class AccessibleRelationSetHelperImpl;
//=========================================================================
//= XAccessibleRelationSet helper classes
//=========================================================================
//... namespace utl .......................................................
namespace utl
{
//.........................................................................
/** @descr
This base class provides an implementation of the
<code>AccessibleRelationSet</code> service.
*/
class UNOTOOLS_DLLPUBLIC AccessibleRelationSetHelper
: public cppu::WeakImplHelper1<
::com::sun::star::accessibility::XAccessibleRelationSet
>
{
public:
//===== internal ========================================================
AccessibleRelationSetHelper ();
AccessibleRelationSetHelper (const AccessibleRelationSetHelper& rHelper);
protected:
virtual ~AccessibleRelationSetHelper (void);
public:
//===== XAccessibleRelationSet ==========================================
/** Returns the number of relations in this relation set.
@return
Returns the number of relations or zero if there are none.
*/
virtual sal_Int32 SAL_CALL getRelationCount( )
throw (::com::sun::star::uno::RuntimeException);
/** Returns the relation of this relation set that is specified by
the given index.
@param nIndex
This index specifies the relatio to return.
@return
For a valid index, i.e. inside the range 0 to the number of
relations minus one, the returned value is the requested
relation. If the index is invalid then the returned relation
has the type INVALID.
*/
virtual ::com::sun::star::accessibility::AccessibleRelation SAL_CALL
getRelation( sal_Int32 nIndex )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
/** Tests whether the relation set contains a relation matching the
specified key.
@param aRelationType
The type of relation to look for in this set of relations. This
has to be one of the constants of
<type>AccessibleRelationType</type>.
@return
Returns <TRUE/> if there is a (at least one) relation of the
given type and <FALSE/> if there is no such relation in the set.
*/
virtual sal_Bool SAL_CALL containsRelation( sal_Int16 aRelationType )
throw (::com::sun::star::uno::RuntimeException);
/** Retrieve and return the relation with the given relation type.
@param aRelationType
The type of the relation to return. This has to be one of the
constants of <type>AccessibleRelationType</type>.
@return
If a relation with the given type could be found than (a copy
of) this relation is returned. Otherwise a relation with the
type INVALID is returned.
*/
virtual ::com::sun::star::accessibility::AccessibleRelation SAL_CALL
getRelationByType( sal_Int16 aRelationType )
throw (::com::sun::star::uno::RuntimeException);
void AddRelation(
const ::com::sun::star::accessibility::AccessibleRelation& rRelation)
throw (::com::sun::star::uno::RuntimeException);
//===== XTypeProvider ===================================================
/** Returns a sequence of all supported interfaces.
*/
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> SAL_CALL
getTypes (void)
throw (::com::sun::star::uno::RuntimeException);
/** Returns a implementation id.
*/
virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL
getImplementationId (void)
throw (::com::sun::star::uno::RuntimeException);
protected:
/// Mutex guarding this object.
::vos::OMutex maMutex;
private:
/// The implementation of this helper interface.
AccessibleRelationSetHelperImpl* mpHelperImpl;
};
//.........................................................................
}
//... namespace utl .......................................................
#endif
|