INTEGRATION: CWS uaa03 (1.2.18); FILE MERGED

2003/05/21 15:19:17 mt 1.2.18.1: #i14623# UAA finalization

offapi/com/sun/star/accessibility/XAccessibleText.idl

@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XAccessibleText.idl,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: vg $ $Date: 2003-04-24 17:36:13 $
+ *  last change: $Author: vg $ $Date: 2003-05-22 13:06:09 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -84,6 +84,9 @@
 #ifndef __com_sun_star_beans_PropertyValue_idl__
 #include <com/sun/star/beans/PropertyValue.idl>
 #endif
+#ifndef __com_sun_star_accessibility_TextSegment_idl__
+#include <com/sun/star/accessibility/TextSegment.idl>
+#endif
 
 module com { module sun { module star { module accessibility {
 
@@ -369,7 +372,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
         (inclusive) and up to the character at nEndIndex (exclusive),
         if nStartIndex is less or equal nEndIndex.  If nEndIndex is
         lower than nStartIndex, the result is the same as a call with
-        the two arguments being exchanged.  </p>
+        the two arguments being exchanged.</p>
 
         <p>The whole text can be requested by passing the indices zero and
         <code>getCharacterCount()</code>.  If both indices have the same
@@ -386,9 +389,7 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
         @return
             Returns the substring starting with the character at nStartIndex
             (inclusive) and up to the character at nEndIndex (exclusive), if
-            nStartIndex is less or equal nEndIndex.
-            If nEndIndex is lower than nStartIndex, the result is the same
-            that a call with the two arguments being exchanges.
+            nStartIndex is less than or equal to nEndIndex.
 
         @throws ::com::sun::star::lang::IndexOutOfBoundsException
             if the indices are invalid
@@ -398,32 +399,32 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
 
     /** Get a text portion around the given position.
 
-        <p>Returns the substring of the specified text type that
-        contains the character at the given index, if any.  For
-        example, given the text type word, the word which contains the
-        character at position nIndex is returned, or an empty string
-        if no word is found at the that position.</p>
+        <p>Returns the substring of the specified text type that contains
+        the character at the given index, if any.  For example, given the
+        text type <const scope="AccessibleTextType">WORD</type>, the word
+        which contains the character at position nIndex is returned, or an
+        empty string if no word is found at the that position.</p>
 
         @param nIndex
             Index of the character whose containing text portion is to be
             returned.
             The valid range is 0..length.
 
-        @param aTextType
+        @param nTextType
             The type of the text portion to return.  See
             <type>AccessibleTextType</type> for the complete list.
 
         @return
-            Returns the requested text portion or an empty string if the text
-            type is invalid, or if no text portion of the given is found at
-            the given position.
+            Returns the requested text portion.  This portion may be empty
+            or invalid when no appropriate text portion is found or text
+            type is invalid.
 
         @throws ::com::sun::star::lang::IndexOutOfBoundsException
             if the index is invalid
         @throws ::com::sun::star::lang::InvalidArgumentException
             if the given text type is not valid.
     */
-    string getTextAtIndex ([in] long nIndex, [in] short aTextType)
+    TextSegment getTextAtIndex([in] long nIndex, [in] short nTextType)
         raises (::com::sun::star::lang::IndexOutOfBoundsException,
             ::com::sun::star::lang::IllegalArgumentException);
 
@@ -435,11 +436,12 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
         <member>XAccessibleText::getTextAtIndex</member> with a
         suitably decreased index value.</p>
 
-        <p>For example, if text type is word, then the complete word
+        <p>For example, if text type is <const
+        scope="AccessibleTextType">WORD</type>, then the complete word
         that is closest to and located before nIndex is returned.</p>
 
         <p>If the index is valid, but no suitable word (or other text
-        type) is found, an empty string is returned.</p>
+        type) is found, an empty text segment is returned.</p>
 
         @param nIndex
             Index of the character for which to return the text part before
@@ -447,20 +449,21 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
             string.
             The valid range is 0..length.
 
-        @param aTextType
+        @param nTextType
             The type of the text portion to return.  See
             <type>AccessibleTextType</type> for the complete list.
 
         @return
-            Returns the requested text portion or an empty string if the
-            text type is invalid or no appropriate text portion is found.
+            Returns the requested text portion.  This portion may be empty
+            or invalid when no appropriate text portion is found or text
+            type is invalid.
 
         @throws ::com::sun::star::lang::IndexOutOfBoundsException
             if the index is invalid.
         @throws ::com::sun::star::lang::InvalidArgumentException
             if the given text type is not valid.
     */
-    string  getTextBeforeIndex  ([in] long nIndex, [in] short aTextType)
+    TextSegment getTextBeforeIndex([in] long nIndex, [in] short nTextType)
         raises (::com::sun::star::lang::IndexOutOfBoundsException,
             ::com::sun::star::lang::IllegalArgumentException);
 
@@ -472,7 +475,8 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
         <member>XAccessibleText::getTextAtIndex</member> with a
         suitably increased index value.</p>
 
-        <p>For example, if text type is word, then the complete word
+        <p>For example, if text type is <const
+        scope="AccessibleTextType">WORD</type>, then the complete word
         that is closest to and located behind nIndex is returned.</p>
 
         <p>If the index is valid, but no suitable word (or other text
@@ -483,20 +487,21 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
             it.  The index character will be part of the returned string.
             The valid range is 0..length.
 
-        @param aTextType
+        @param nTextType
             The type of the text portion to return.  See
             <type>AccessibleTextType</type> for the complete list.
 
         @return
-            Returns the requested text portion or an empty string if the
-            text type is invalid or no appropriate text portion is found.
+            Returns the requested text portion.  This portion may be empty
+            or invalid when no appropriate text portion is found or text
+            type is invalid.
 
         @throws ::com::sun::star::lang::IndexOutOfBoundsException
             if the index is invalid
         @throws ::com::sun::star::lang::InvalidArgumentException
             if the given text type is not valid.
     */
-    string  getTextBehindIndex  ([in] long nIndex, [in] short aTextType)
+    TextSegment getTextBehindIndex([in] long nIndex, [in] short nTextType)
         raises (::com::sun::star::lang::IndexOutOfBoundsException,
             ::com::sun::star::lang::IllegalArgumentException);