INTEGRATION: CWS uaa02 (1.1.2); FILE ADDED

2003/03/14 10:40:50 af 1.1.2.2: #108113# Removed references to the drafts directory.
2003/03/11 15:00:35 af 1.1.2.1: #108113# Moved from drafts/com/sun/star/accessibility.

1 files changed, 176 insertions, 0 deletions

diff --git a/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl
new file mode 100644
index 000000000..96e48f486
--- /dev/null
+++ b/offapi/com/sun/star/accessibility/XAccessibleHyperlink.idl
@@ -0,0 +1,176 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XAccessibleHyperlink.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2003-04-24 17:34:58 $
+ *
+ *  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_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 &lt;a href&gt; 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>
+*/
+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 &lt&a href&gt; 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 &lt&a href&gt; 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 of the <type>AccessibleHypertext</type> service 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 of the <type>AccessibleHypertext</type> service 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