summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/accessibility/XAccessibleTextAttributes.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/accessibility/XAccessibleTextAttributes.idl98
1 files changed, 98 insertions, 0 deletions
diff --git a/offapi/com/sun/star/accessibility/XAccessibleTextAttributes.idl b/offapi/com/sun/star/accessibility/XAccessibleTextAttributes.idl
new file mode 100644
index 000000000..f8d459be6
--- /dev/null
+++ b/offapi/com/sun/star/accessibility/XAccessibleTextAttributes.idl
@@ -0,0 +1,98 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_accessibility_XAccessibleTextAttributes_idl__
+#define __com_sun_star_accessibility_XAccessibleTextAttributes_idl__
+
+#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
+#include <com/sun/star/beans/PropertyValue.idl>
+#include <com/sun/star/beans/UnknownPropertyException.idl>
+
+module com { module sun { module star { module accessibility {
+
+/** Implement this interface to give access to the attributes of a text.
+
+ @since OOo 2.0.4
+*/
+interface XAccessibleTextAttributes
+{
+ /** Get the default attribute set for the text.
+
+ <p>Returns a set of all default paragraph and default character
+ attributes that are associated for the text. To prevent the method
+ from returning possibly large sets of attributes that the caller
+ is not interested in the caller can provide a list of attributes
+ that he wants to be returned.</p>
+
+ @param RequestedAttributes
+ This string sequence defines the set of attributes that the
+ caller is interested in. When there are requested attributes
+ that are not defined for the text then they are ignored.
+
+ <p>When the sequence is empty all attributes are returned.</p>
+
+ @return
+ Returns the requested attributes of the text. Each attribute
+ is represented by a ::com::sun::star::beans::PropertyValue
+ object.
+ */
+ sequence<::com::sun::star::beans::PropertyValue>
+ getDefaultAttributes ( [in] sequence<string> RequestedAttributes )
+ raises ( ::com::sun::star::beans::UnknownPropertyException );
+
+ /** Get the run attribute set for the specified position.
+
+ <p>Returns a set of character attributes that are associated for
+ the character at the given index and are directly set or are set
+ via a character style. To prevent the method from returning all of
+ these attributes the caller can provide a list of attributes
+ that he wants to be returned.</p>
+
+ @param Index
+ The index of the character for which to return its attributes.
+ The valid range is 0..length of text-1.
+
+ @param RequestedAttributes
+ This string sequence defines the set of attributes that the
+ caller is interested in. When there are requested attributes
+ that are not defined for the text then they are ignored.
+
+ <p>When the sequence is empty all attributes are returned.</p>
+
+ @return
+ Returns the requested attributes of the specified character.
+ Each attribute is represented by a
+ ::com::sun::star::beans::PropertyValue object.
+
+ @throws ::com::sun::star::lang::IndexOutOfBoundsException
+ if the index is invalid
+ */
+ sequence<::com::sun::star::beans::PropertyValue>
+ getRunAttributes ( [in] long Index,
+ [in] sequence<string> RequestedAttributes )
+ raises (::com::sun::star::beans::UnknownPropertyException,
+ ::com::sun::star::lang::IndexOutOfBoundsException);
+
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */