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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_accessibility_XAccessibleTextAttributes_idl__
  21 #define __com_sun_star_accessibility_XAccessibleTextAttributes_idl__
  22
  23 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25 #include <com/sun/star/beans/UnknownPropertyException.idl>
  26
  27 module com { module sun { module star { module accessibility {
  28
  29 /** Implement this interface to give access to the attributes of a text.
  30
  31     @since OOo 2.0.4
  32 */
  33 interface XAccessibleTextAttributes
  34 {
  35     /** Get the default attribute set for the text.
  36
  37         <p>Returns a set of all default paragraph and default character
  38         attributes that are associated for the text. To prevent the method
  39         from returning possibly large sets of attributes that the caller
  40         is not interested in the caller can provide a list of attributes
  41         that he wants to be returned.</p>
  42
  43         @param RequestedAttributes
  44             This string sequence defines the set of attributes that the
  45             caller is interested in. When there are requested attributes
  46             that are not defined for the text then they are ignored.
  47
  48             <p>When the sequence is empty all attributes are returned.</p>
  49
  50         @return
  51             Returns the requested attributes of the text. Each attribute
  52             is represented by a ::com::sun::star::beans::PropertyValue
  53             object.
  54     */
  55     sequence<::com::sun::star::beans::PropertyValue>
  56         getDefaultAttributes ( [in] sequence<string> RequestedAttributes )
  57         raises ( ::com::sun::star::beans::UnknownPropertyException );
  58
  59     /** Get the run attribute set for the specified position.
  60
  61         <p>Returns a set of character attributes that are associated for
  62         the character at the given index and are directly set or are set
  63         via a character style. To prevent the method from returning all of
  64         these attributes the caller can provide a list of attributes
  65         that he wants to be returned.</p>
  66
  67         @param Index
  68             The index of the character for which to return its attributes.
  69             The valid range is 0..length of text-1.
  70
  71         @param RequestedAttributes
  72             This string sequence defines the set of attributes that the
  73             caller is interested in. When there are requested attributes
  74             that are not defined for the text then they are ignored.
  75
  76             <p>When the sequence is empty all attributes are returned.</p>
  77
  78         @return
  79             Returns the requested attributes of the specified character.
  80             Each attribute is represented by a
  81             ::com::sun::star::beans::PropertyValue object.
  82
  83         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  84             if the index is invalid
  85     */
  86     sequence<::com::sun::star::beans::PropertyValue>
  87         getRunAttributes ( [in] long Index,
  88                            [in] sequence<string> RequestedAttributes )
  89         raises (::com::sun::star::beans::UnknownPropertyException,
  90                 ::com::sun::star::lang::IndexOutOfBoundsException);
  91
  92 };
  93
  94 }; }; }; };
  95
  96 #endif
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */