1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_accessibility_XAccessibleTextAttributes_idl__ 25cdf0e10cSrcweir#define __com_sun_star_accessibility_XAccessibleTextAttributes_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 28cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValue_idl__ 31cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValue.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweirmodule com { module sun { module star { module accessibility { 35cdf0e10cSrcweir 36cdf0e10cSrcweir/** Implement this interface to give access to the attributes of a text. 37cdf0e10cSrcweir 38*0d3a54ffSJürgen Schmidt @since OpenOffice 2.0.4 39cdf0e10cSrcweir*/ 40cdf0e10cSrcweirpublished interface XAccessibleTextAttributes 41cdf0e10cSrcweir{ 42cdf0e10cSrcweir /** Get the default attribute set for the text. 43cdf0e10cSrcweir 44cdf0e10cSrcweir <p>Returns a set of all default paragraph and default character 45cdf0e10cSrcweir attributes that are associated for the text. To prevent the method 46cdf0e10cSrcweir from returning possibly large sets of attributes that the caller 47cdf0e10cSrcweir is not interested in the caller can provide a list of attributes 48cdf0e10cSrcweir that he wants to be returned.</p> 49cdf0e10cSrcweir 50cdf0e10cSrcweir @param RequestedAttributes 51cdf0e10cSrcweir This string sequence defines the set of attributes that the 52cdf0e10cSrcweir caller is interested in. When there are requested attributes 53cdf0e10cSrcweir that are not defined for the text then they are ignored. 54cdf0e10cSrcweir 55cdf0e10cSrcweir <p>When the sequence is empty all attributes are returned.</p> 56cdf0e10cSrcweir 57cdf0e10cSrcweir @return 58cdf0e10cSrcweir Returns the requested attributes of the text. Each attribute 59cdf0e10cSrcweir is represented by a <type scope="::com::sun::star::beans">PropertyValue</type> 60cdf0e10cSrcweir object. 61cdf0e10cSrcweir */ 62cdf0e10cSrcweir sequence<::com::sun::star::beans::PropertyValue> 63cdf0e10cSrcweir getDefaultAttributes ( [in] sequence<string> RequestedAttributes ); 64cdf0e10cSrcweir 65cdf0e10cSrcweir /** Get the run attribute set for the specified position. 66cdf0e10cSrcweir 67cdf0e10cSrcweir <p>Returns a set of character attributes that are associated for 68cdf0e10cSrcweir the character at the given index and are directly set or are set 69cdf0e10cSrcweir via a character style. To prevent the method from returning all of 70cdf0e10cSrcweir these attributes the caller can provide a list of attributes 71cdf0e10cSrcweir that he wants to be returned.</p> 72cdf0e10cSrcweir 73cdf0e10cSrcweir @param Index 74cdf0e10cSrcweir The index of the character for which to return its attributes. 75cdf0e10cSrcweir The valid range is 0..length of text-1. 76cdf0e10cSrcweir 77cdf0e10cSrcweir @param RequestedAttributes 78cdf0e10cSrcweir This string sequence defines the set of attributes that the 79cdf0e10cSrcweir caller is interested in. When there are requested attributes 80cdf0e10cSrcweir that are not defined for the text then they are ignored. 81cdf0e10cSrcweir 82cdf0e10cSrcweir <p>When the sequence is empty all attributes are returned.</p> 83cdf0e10cSrcweir 84cdf0e10cSrcweir @return 85cdf0e10cSrcweir Returns the requested attributes of the specified character. 86cdf0e10cSrcweir Each attribute is represented by a 87cdf0e10cSrcweir <type scope="::com::sun::star::beans">PropertyValue</type> object. 88cdf0e10cSrcweir 89cdf0e10cSrcweir @throws ::com::sun::star::lang::IndexOutOfBoundsException 90cdf0e10cSrcweir if the index is invalid 91cdf0e10cSrcweir */ 92cdf0e10cSrcweir sequence<::com::sun::star::beans::PropertyValue> 93cdf0e10cSrcweir getRunAttributes ( [in] long Index, 94cdf0e10cSrcweir [in] sequence<string> RequestedAttributes ) 95cdf0e10cSrcweir raises (::com::sun::star::lang::IndexOutOfBoundsException); 96cdf0e10cSrcweir 97cdf0e10cSrcweir}; 98cdf0e10cSrcweir 99cdf0e10cSrcweir}; }; }; }; 100cdf0e10cSrcweir 101cdf0e10cSrcweir#endif 102