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
|
/* -*- 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_XAccessibleHyperlink_idl__
#define __com_sun_star_accessibility_XAccessibleHyperlink_idl__
#include <com/sun/star/accessibility/XAccessibleAction.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
module com { module sun { module star { module accessibility {
/** Implement this interface to represent a hyperlink or a group of
hyperlinks.
<p>Single hyperlinks correspond to simple <a href> tags. Groups
of hyperlinks are contained in client side image maps. Linked objects
and anchors are implementation dependent. This interface inherits the
XAccessibleAction interface. Especially that interface's
XAccessibleAction::getActionCount() method is needed to
obtain a maximum value for the indices passed to the
XAccessibleHyperlink::getAccessibleActionAnchor() and
XAccessibleHyperlink::getAccessibleActionObject()
methods.</p>
<p>Furthermore, the object that implements this interface has to be
connected implicitly or explicitly with an object that implements the
XAccessibleText interface. The XAccessibleHyperlink::getStartIndex() and
XAccessibleHyperlink::getEndIndex() methods return
indices with respect to the text exposed by that interface.</p>
@since OOo 1.1.2
*/
interface XAccessibleHyperlink :
::com::sun::star::accessibility::XAccessibleAction
{
/** Returns an object that represents the link anchor, as appropriate
for that link.
<p>For an HTML link for example, this method would return the string
enclosed by the <&a href> tag.</p>
@param nIndex
This index identifies the anchor when, as in the case of an
image map, there is more than one link represented by this
object. The valid maximal index can be determined by calling
the XAccessibleAction::getActionCount() method.
@return
If the index is not valid then an exception is thrown.
Otherwise it returns an implementation dependent value.
*/
any getAccessibleActionAnchor ([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns an object that represents the link anchor, as appropriate
for that link.
<p>For an HTML link for example, this method would return the URL of
the <&a href> tag.</p>
@param nIndex
This index identifies the action object when, as in the case of
an image map, there is more than one link represented by this
object. The valid maximal index can be determined by calling
the XAccessibleAction::getActionCount() method.
@return
If the index is not valid then an exception is thrown.
Otherwise it returns an implementation dependent value.
*/
any getAccessibleActionObject ([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the index at which the textual representation of the
hyperlink (group) starts.
<p>The returned value relates to the XAccessibleText
interface that owns this hyperlink.</p>
@return
The index relates to the text exposed by the
XAccessibleHypertext interface.
*/
long getStartIndex ();
/** Returns the index at which the textual representation of the
hyperlink (group) ends.
<p>The returned value relates to the XAccessibleText
interface that owns this hyperlink.</p>
@return
The index relates to the text exposed by the
XAccessibleText interface.
*/
long getEndIndex ();
/** Returns whether the document referenced by this links is
still valid.
<p>This is a volatile state that may change without further warning
like e.g. sending an appropriate event.</p>
@return
Returns `TRUE` if the referenced document is still valid and
`FALSE` otherwise.
*/
boolean isValid ();
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
