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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XAccessibleTextAttributes.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_accessibility_XAccessibleTextAttributes_idl__
  32 #define __com_sun_star_accessibility_XAccessibleTextAttributes_idl__
  33
  34 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  35 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 module com { module sun { module star { module accessibility {
  42
  43 /** Implement this interface to give access to the attributes of a text.
  44
  45     @since OOo 2.0.4
  46 */
  47 published interface XAccessibleTextAttributes
  48 {
  49     /** Get the default attribute set for the text.
  50
  51         <p>Returns a set of all default paragraph and default character
  52         attributes that are associated for the text. To prevent the method
  53         from returning possibly large sets of attributes that the caller
  54         is not interested in the caller can provide a list of attributes
  55         that he wants to be returned.</p>
  56
  57         @param RequestedAttributes
  58             This string sequence defines the set of attributes that the
  59             caller is interested in. When there are requested attributes
  60             that are not defined for the text then they are ignored.
  61
  62             <p>When the sequence is empty all attributes are returned.</p>
  63
  64         @return
  65             Returns the requested attributes of the text. Each attribute
  66             is represented by a <type scope="::com::sun::star::beans">PropertyValue</type>
  67             object.
  68     */
  69     sequence<::com::sun::star::beans::PropertyValue>
  70         getDefaultAttributes ( [in] sequence<string> RequestedAttributes );
  71
  72     /** Get the run attribute set for the specified position.
  73
  74         <p>Returns a set of character attributes that are associated for
  75         the character at the given index and are directly set or are set
  76         via a character style. To prevent the method from returning all of
  77         these attributes the caller can provide a list of attributes
  78         that he wants to be returned.</p>
  79
  80         @param Index
  81             The index of the character for which to return its attributes.
  82             The valid range is 0..length of text-1.
  83
  84         @param RequestedAttributes
  85             This string sequence defines the set of attributes that the
  86             caller is interested in. When there are requested attributes
  87             that are not defined for the text then they are ignored.
  88
  89             <p>When the sequence is empty all attributes are returned.</p>
  90
  91         @return
  92             Returns the requested attributes of the specified character.
  93             Each attribute is represented by a
  94             <type scope="::com::sun::star::beans">PropertyValue</type> object.
  95
  96         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  97             if the index is invalid
  98     */
  99     sequence<::com::sun::star::beans::PropertyValue>
 100         getRunAttributes ( [in] long Index,
 101                            [in] sequence<string> RequestedAttributes )
 102         raises (::com::sun::star::lang::IndexOutOfBoundsException);
 103
 104 };
 105
 106 }; }; }; };
 107
 108 #endif