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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XAccessibleHyperlink.idl,v $
* $Revision: 1.8 $
*
* 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 __com_sun_star_accessibility_XAccessibleHyperlink_idl__
#define __com_sun_star_accessibility_XAccessibleHyperlink_idl__
#ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
#include <com/sun/star/accessibility/XAccessibleAction.idl>
#endif
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif
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
<type>XAccessibleAction</type> interface. Especially that interface's
<member>XAccessibleAction::getActionCount</member> method is needed to
obtain a maximum value for the indices passed to the
<member>XAccessibleHyperlink::getAccessibleActionAnchor</member> and
<member>XAccessibleHyperlink::getAccessibleActionObject</member>
methods.</p>
<p>Furhtermore, the object that implements this interface has to be
connected implicitely or explicitely with an object that implements the
the <type>XAccessibleText</type> interface. The
<member>XAccessibleHyperlink::getStartIndex</member> and
<member>XAccessibleHyperlink::getEndIndex</member> methods return
indices with respect to the text exposed by that interface.</p>
@since OOo 1.1.2
*/
published 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 determinded by calling
the <member>XAccessibleAction::getActionCount</member> 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 determinded by calling
the <member>XAccessibleAction::getActionCount</member> 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 <type>XAccessibleText</type>
interface that ownes this hyperlink.</p>
@return
The index relates to the text exposed by the
<type>XAccessibleHypertext</type> interface.
*/
long getStartIndex ();
/** Returns the index at which the textual rerpesentation of the
hyperlink (group) ends.
<p>The returned value relates to the <type>XAccessibleText</type>
interface that ownes this hyperlink.</p>
@return
The index relates to the text exposed by the
<type>XAccessibleText</type> 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
|
