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

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