1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_accessibility_XAccessibleHypertext_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_accessibility_XAccessibleHypertext_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_accessibility_XAccessibleText_idl__ 34*b1cdbd2cSJim Jagielski#include <com/sun/star/accessibility/XAccessibleText.idl> 35*b1cdbd2cSJim Jagielski#endif 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module accessibility { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski published interface XAccessibleHyperlink; 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski/** Implement this interface to expose the hypertext structure of a document. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski <p>The <type>XAccessibleHypertext</type> interface is the main interface 45*b1cdbd2cSJim Jagielski to expose hyperlinks in a document, typically a text document, that are 46*b1cdbd2cSJim Jagielski used to reference other (parts of) documents. For supporting the 47*b1cdbd2cSJim Jagielski <member>XAccessibleHypertext::getLinkIndex</member> method of this 48*b1cdbd2cSJim Jagielski interface and other character related methods of the 49*b1cdbd2cSJim Jagielski <type>XAccessibleHyperlink</type> interface, it is necessary to also 50*b1cdbd2cSJim Jagielski support the <type>XAccessibleText</type> interface.</p> 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski @see XAccessibleHyperlink, XAccessibleText 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski @since OpenOffice 1.1.2 55*b1cdbd2cSJim Jagielski*/ 56*b1cdbd2cSJim Jagielskipublished interface XAccessibleHypertext 57*b1cdbd2cSJim Jagielski : ::com::sun::star::accessibility::XAccessibleText 58*b1cdbd2cSJim Jagielski{ 59*b1cdbd2cSJim Jagielski /** Returns the number of links and link groups contained within this 60*b1cdbd2cSJim Jagielski hypertext document. 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski @return 63*b1cdbd2cSJim Jagielski The number of links and link groups within this hypertext 64*b1cdbd2cSJim Jagielski document. Returns 0 if there is no link. 65*b1cdbd2cSJim Jagielski */ 66*b1cdbd2cSJim Jagielski long getHyperLinkCount (); 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski /** Return the specified link. 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski <p>The returned <type>XAccessibleHyperlink</type> object 71*b1cdbd2cSJim Jagielski encapsulates the hyperlink and provides several kinds of information 72*b1cdbd2cSJim Jagielski describing it.</p> 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @param nLinkIndex 75*b1cdbd2cSJim Jagielski This index specifies the hyperlink to return. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski @return 78*b1cdbd2cSJim Jagielski If the given index is valid, i.e. lies in the intervall from 0 79*b1cdbd2cSJim Jagielski to the number of links minus one, a reference to the specified 80*b1cdbd2cSJim Jagielski hyperlink object is returned. If the index is invalid then an 81*b1cdbd2cSJim Jagielski empty reference is returned. 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski XAccessibleHyperlink getHyperLink ([in] long nLinkIndex) 84*b1cdbd2cSJim Jagielski raises (::com::sun::star::lang::IndexOutOfBoundsException); 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski /** Returns the index of the hyperlink that is associated with this 88*b1cdbd2cSJim Jagielski character index. 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski <p>In a HTML document this is the case when a <a href> tag 91*b1cdbd2cSJim Jagielski spans (includes) the given character index.</p> 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski @param nCharIndex 94*b1cdbd2cSJim Jagielski Index of the character for which to return the link index. If 95*b1cdbd2cSJim Jagielski the <type>XAccessibleText</type> interface is used to represent 96*b1cdbd2cSJim Jagielski the text containting the link, then the character index is only 97*b1cdbd2cSJim Jagielski valid if it is greater than or equal to zero and lower then the 98*b1cdbd2cSJim Jagielski number of characters in the text. See that interface's 99*b1cdbd2cSJim Jagielski documentation for more details. 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @return 102*b1cdbd2cSJim Jagielski Returns the index of the hyperlink that is associated with this 103*b1cdbd2cSJim Jagielski character index, or throws an exception if there is no hyperlink 104*b1cdbd2cSJim Jagielski associated with this index. 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski @see XAccessibleText. 107*b1cdbd2cSJim Jagielski */ 108*b1cdbd2cSJim Jagielski long getHyperLinkIndex ([in] long nCharIndex) 109*b1cdbd2cSJim Jagielski raises (::com::sun::star::lang::IndexOutOfBoundsException); 110*b1cdbd2cSJim Jagielski}; 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski}; }; }; }; 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski#endif 115