blob: 05d169230adc6ce2ffa573d2d484e8dda9906fd0 (
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
|
/* -*- 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_UNOTOOLS_ACCESSIBLERELATIONSETHELPER_HXX
#define INCLUDED_UNOTOOLS_ACCESSIBLERELATIONSETHELPER_HXX
#include <unotools/unotoolsdllapi.h>
#include <com/sun/star/accessibility/XAccessibleRelationSet.hpp>
#include <osl/mutex.hxx>
#include <cppuhelper/implbase.hxx>
#include <memory>
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::WeakImplHelper< css::accessibility::XAccessibleRelationSet >
{
public:
//===== internal ========================================================
AccessibleRelationSetHelper ();
AccessibleRelationSetHelper (const AccessibleRelationSetHelper& rHelper);
private:
virtual ~AccessibleRelationSetHelper() override;
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( ) override;
/** 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 css::accessibility::AccessibleRelation SAL_CALL
getRelation( sal_Int32 nIndex ) override;
/** 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
AccessibleRelationType.
@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 ) override;
/** 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 AccessibleRelationType.
@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 css::accessibility::AccessibleRelation SAL_CALL
getRelationByType( sal_Int16 aRelationType ) override;
/// @throws uno::RuntimeException
void AddRelation(
const css::accessibility::AccessibleRelation& rRelation);
//===== XTypeProvider ===================================================
/** Returns a sequence of all supported interfaces.
*/
virtual css::uno::Sequence< css::uno::Type> SAL_CALL
getTypes() override;
/** Returns an implementation id.
*/
virtual css::uno::Sequence<sal_Int8> SAL_CALL
getImplementationId() override;
private:
/// Mutex guarding this object.
::osl::Mutex maMutex;
/// The implementation of this helper interface.
std::unique_ptr<AccessibleRelationSetHelperImpl> mpHelperImpl;
};
}
//... namespace utl .......................................................
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
