diff options
Diffstat (limited to 'offapi/com/sun/star/chart/AccessibleChartElement.idl')
| -rw-r--r-- | offapi/com/sun/star/chart/AccessibleChartElement.idl | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/offapi/com/sun/star/chart/AccessibleChartElement.idl b/offapi/com/sun/star/chart/AccessibleChartElement.idl new file mode 100644 index 000000000000..3ea8cc050a10 --- /dev/null +++ b/offapi/com/sun/star/chart/AccessibleChartElement.idl @@ -0,0 +1,195 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_chart_AccessibleChartElement_idl__ +#define __com_sun_star_chart_AccessibleChartElement_idl__ + +#ifndef __com_sun_star_accessibility_XAccessible_idl__ +#include <com/sun/star/accessibility/XAccessible.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__ +#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl> +#endif + + +module com { module sun { module star { module chart { + +/** This service is supported by all components that are contained in + the view of a chart document that are controlled by the chart. + Shapes added by a user via the clipboard are not treated as chart + elements. + + <p>The list of objects that implement this service is + <type scope="::com::sun::star::chart">ChartTitle</type>, + <type scope="::com::sun::star::chart">ChartLegend</type>, + <type scope="::com::sun::star::chart">Diagram</type>, + <type scope="::com::sun::star::chart">ChartAxis</type>, + <type scope="::com::sun::star::chart">ChartDataRowProperties</type>, + <type scope="::com::sun::star::chart">ChartDataPointProperties</type>. + </p> + + <p>The + <type scope="::com::sun::star::accessibility">XAccessibleExtendedComponent</type> + is suported by all chart elements.</p> + + @since OOo 1.1.2 +*/ +published service AccessibleChartElement +{ + /** Base interface for being accessible. It gives access to the + <type scope="::com::sun::star::accessibility">XAccessibleContext</type> + interface. + */ + interface ::com::sun::star::accessibility::XAccessible; + + /** Give access to the structural information of a chart element. + + <p>You can access the following information for the shapes of the above listed types: + <dl> + <dt>Role</dt> + <dd>All chart elements have the role + <const scope="::com::sun::star::accessibility">AccessibleRole::SHAPE</const>. + </dd> + <dt>Name</dt> + <dd>For unique elements you get fixed names. The unique + elements are the titles, legend, diagram and axes. The + names you get for them are "main-title", "sub-title", + "(x|y|z)-axis-title", "legend", "diagram", "(x|y|z)-axis" + and "second-(x|y)-axis", respectively.</dd> + <dt>Description</dt> + <dd>Descriptions contain a list of selected + attributes. These attributes are, if applicable: + foreground and background color, line width, font name and + size. The purpose of these attributes is to give a rough + description of the more simple geometric shapes. The list + is very restricted in order to avoid overwhelming or + confusing the user.</dd> + <dt>Children</dt> + <dd>The <type scope="::com::sun::star::chart">Diagram</type> and + the <type scope="::com::sun::star::chart">ChartLegend</type> + contain children, all other objects in a chart do not, i.e., are + leaves in the document representation tree.</dd> + <dt>Parent</dt> + <dd>Because the <code>setParent</code> method from the JAA has + been removed, the reference to the parent has to be provided in an + implementation specific way.</dd> + <dt>Relations</dt> + <dd>They are not used at the moment.</dd> + + <dt>States</dt> + <dd>The states supported by this service are: + <ul> + + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::DEFUNC</const> + is set if an object was removed. This indicates that the user + should release all references to the accessible object. If + this state is set then no other of the states below is set. + </li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::EDITABLE</const></li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::ENABLED</const> + is always set.<sup>†</sup></li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::MULTILINE</const> + is set for all titles.</li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::OPAQUE</const> + is set for all elements that do have a transparency + attributes set to 0% and no transparency gradient.</li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::RESIZABLE</const> + Is set for the diagram object only. All other chart elements may not be resized.</li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::SELECTABLE</const></li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::SELECTED</const></li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::SHOWING</const> + is always set.<sup>†</sup></li> + <li><const scope="::com::sun::star::accessibility">AccessibleStateType::VISIBLE</const> + is always set.<sup>†</sup></li> + </ul> + <sup>†</sup>always, except if the state + <const scope="::com::sun::star::accessibility">AccessibleStateType::DEFUNC</const> + is set.</dd> + <dt>Locale</dt> + <dd>is supported.</dd> + <dt>Property change listeners</dt> + <dd>Property change listeners that are registered with a chart + element are informed if the size or position or an attribute + changed. The last point needs a short explanation: An attribute + change is signaled even if that attribute is not part of the + shape's description and is therefore not explicitly represented by + the UAA.</dd> + </dl> + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + /** Give access to the graphical representation of a chart element. + + <p>The coordinate oriented methods <code>contains</code>, + <code>getAccessibleAt</code>, <code>getBounds</code>, + <code>getLocation</code>, <code>getLocationOnScreen</code>, and + <code>getSize</code> work on pixel coordinates. (To transform between + the internal 100th of mm and pixels a chart element has to have access + to information that allows it to do so. These information are the + enclosing window's size in pixel, 100th of mm, and its own relative + position in one or the other coordinate system).</p> + + <p>Focus handling depends on support of the + <type scope="::com::sun::star::accessibility">XAccessibleText</type> and + <type scope="::com::sun::star::accessibility">XAccessibleEditableText</type> + interfaces.</p> + + <p>Key bindings are not supported at the moment</p> + */ + interface ::com::sun::star::accessibility::XAccessibleComponent; + + /** Give extended access to the graphical representation of a chart element. + + <p>This interface is used primarily to provide the predominant + foreground and background colors and—if applicable, i.e. the + <type scope="::com::sun::star::accessibility">XAccessibleText</type> + interface is supported—information about the font used to display + text.</p> + + <p>The foreground and background colors may in some cases be directly + taken from the object. In other cases, for example when a gradient or a + texture is used, they have to be interpolated. The color returned may + not be appropriate in all cases.</p> + + <p>Specifying the font used for displaying text depends on the + transformation of UNO API font information into the Java™ format. + However, if the UAA is used directly, this is of course not an + issue.</p> + + <p>The support of this interface is optional to reduce overhead in case + that no text is displayed and color information can not be determined + with an acceptable cost.</p> + */ + [optional] interface ::com::sun::star::accessibility::XAccessibleExtendedComponent; +}; + +}; }; }; }; + +#endif |