blob: 95db6b1e5b41f00c8b071bfc06f0bd8896b3efff (
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
|
/* -*- 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 __com_sun_star_accessibility_XAccessibleRelationSet_idl__
#define __com_sun_star_accessibility_XAccessibleRelationSet_idl__
#include <com/sun/star/accessibility/AccessibleRelation.idl>
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
module com { module sun { module star { module accessibility {
/** Implement this interface to give access to an object's set of relations.
<p>Such relation are modeled with the AccessibleRelation
structure. This interface is used for representing sets of relations
between Accessible objects. Most of the convenience
methods of the corresponding AccessibleRelationSet interface of the Java
Accessibility API have been removed from this interface in order to
clean it up. These methods are add(),
addAll(), clear(), and
remove(). The other methods have been renamed to achieve
a greater conformance with the other accessibility interfaces.</p>
@since OOo 1.1.2
*/
interface XAccessibleRelationSet : ::com::sun::star::uno::XInterface
{
/** Returns the number of relations in this relation set.
@return
Returns the number of relations or zero if there are none.
*/
long getRelationCount ();
/** Returns the relation of this relation set that is specified by
the given index.
@param nIndex
This index specifies the relation 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.
*/
AccessibleRelation getRelation ([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** 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.
*/
boolean containsRelation ([in] short aRelationType);
/** 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.
*/
AccessibleRelation getRelationByType ([in] short aRelationType);
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
