summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/accessibility
diff options
context:
space:
mode:
authorVladimir Glazounov <vg@openoffice.org>2003-06-20 08:50:17 +0000
committerVladimir Glazounov <vg@openoffice.org>2003-06-20 08:50:17 +0000
commit9ae551fbde95266df79bc6fb804343ce07a64cab (patch)
treec0908ac140f59a1073058b44d896fc1a6c59a3f4 /offapi/com/sun/star/accessibility
parent39fd920928f9d215808f2c63c4d7c246d49238cf (diff)
INTEGRATION: CWS uaa05 (1.3.16); FILE MERGED
2003/06/12 14:50:11 af 1.3.16.2: #109196# Fixed autodoc syntax. 2003/06/11 14:40:50 af 1.3.16.1: #110191# Update of the documentation of getCharacterAttributes().
Diffstat (limited to 'offapi/com/sun/star/accessibility')
-rw-r--r--offapi/com/sun/star/accessibility/XAccessibleText.idl27
1 files changed, 18 insertions, 9 deletions
diff --git a/offapi/com/sun/star/accessibility/XAccessibleText.idl b/offapi/com/sun/star/accessibility/XAccessibleText.idl
index 7bc84a2dfc58..234a0a329a81 100644
--- a/offapi/com/sun/star/accessibility/XAccessibleText.idl
+++ b/offapi/com/sun/star/accessibility/XAccessibleText.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XAccessibleText.idl,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: vg $ $Date: 2003-06-10 10:58:59 $
+ * last change: $Author: vg $ $Date: 2003-06-20 09:50:17 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -200,15 +200,24 @@ interface XAccessibleText : ::com::sun::star::uno::XInterface
caller is interested in. When there are attributes defined that
are not listed in the sequence then they are not returned. When
there are requested attributes that are not defined for the
- character then they are also ignored.
+ character then they are ignored, too.
+
+ <p>An empty sequence signals the callers interest in all the
+ attributes. This is usefull in two cases: a) Simply as a way to
+ avoid passing a potentially large array to the called object or
+ b) when the caller does not know what attributes the called
+ objects supports but is interested in all of them
+ nevertheless.</p>
@return
- Returns the requested attributes of the specified character.
- Each attribute is represented by a <type
- scope="::com::sun::star::beans::">PropertyValue</type> object.
- The returned list of attribute descriptions contains all
- attributes that are both members of the sequence of requested
- attributes and defined for the character.
+ Returns the explicitly or implicitly (empty
+ <arg>aRequestedAttributes</arg> argument) requested attributes
+ of the specified character. Each attribute is represented by a
+ <type scope="::com::sun::star::beans">PropertyValue</type>
+ object. The returned list of attribute descriptions contains
+ all attributes that are both members of the sequence of
+ requested attributes and are defined for the character at the
+ specified index.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if the index is invalid