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
|
/*************************************************************************
*
* 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: XAccessibleHypertext.idl,v $
* $Revision: 1.9 $
*
* 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_XAccessibleHypertext_idl__
#define __com_sun_star_accessibility_XAccessibleHypertext_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif
#ifndef __com_sun_star_accessibility_XAccessibleText_idl__
#include <com/sun/star/accessibility/XAccessibleText.idl>
#endif
module com { module sun { module star { module accessibility {
published interface XAccessibleHyperlink;
/** Implement this interface to expose the hypertext structure of a document.
<p>The <type>XAccessibleHypertext</type> interface is the main interface
to expose hyperlinks in a document, typically a text document, that are
used to reference other (parts of) documents. For supporting the
<member>XAccessibleHypertext::getLinkIndex</member> method of this
interface and other character related methods of the
<type>XAccessibleHyperlink</type> interface, it is necessary to also
support the <type>XAccessibleText</type> interface.</p>
@see XAccessibleHyperlink, XAccessibleText
@since OOo 1.1.2
*/
published interface XAccessibleHypertext
: ::com::sun::star::accessibility::XAccessibleText
{
/** Returns the number of links and link groups contained within this
hypertext document.
@return
The number of links and link groups within this hypertext
document. Returns 0 if there is no link.
*/
long getHyperLinkCount ();
/** Return the specified link.
<p>The returned <type>XAccessibleHyperlink</type> object
encapsulates the hyperlink and provides several kinds of information
describing it.</p>
@param nLinkIndex
This index specifies the hyperlink to return.
@return
If the given index is valid, i.e. lies in the intervall from 0
to the number of links minus one, a reference to the specified
hyperlink object is returned. If the index is invalid then an
empty reference is returned.
*/
XAccessibleHyperlink getHyperLink ([in] long nLinkIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the index of the hyperlink that is associated with this
character index.
<p>In a HTML document this is the case when a <a href> tag
spans (includes) the given character index.</p>
@param nCharIndex
Index of the character for which to return the link index. If
the <type>XAccessibleText</type> interface is used to represent
the text containting the link, then the character index is only
valid if it is greater than or equal to zero and lower then the
number of characters in the text. See that interface's
documentation for more details.
@return
Returns the index of the hyperlink that is associated with this
character index, or throws an exception if there is no hyperlink
associated with this index.
@see XAccessibleText.
*/
long getHyperLinkIndex ([in] long nCharIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
};
}; }; }; };
#endif
|
