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
146
147
148
149
150
151
152
|
/*************************************************************************
*
* $RCSfile: XAccessibleHypertext.idl,v $
*
* $Revision: 1.6 $
*
* last change: $Author: obo $ $Date: 2004-06-03 16:48:55 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#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 #107627#
*/
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
|