/************************************************************** * * 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 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __com_sun_star_chart_AccessibleChartElement_idl__ #define __com_sun_star_chart_AccessibleChartElement_idl__ #ifndef __com_sun_star_accessibility_XAccessible_idl__ #include #endif #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ #include #endif #ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__ #include #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.

The list of objects that implement this service is ChartTitle, ChartLegend, Diagram, ChartAxis, ChartDataRowProperties, ChartDataPointProperties.

The XAccessibleExtendedComponent is suported by all chart elements.

@since OOo 1.1.2 */ published service AccessibleChartElement { /** Base interface for being accessible. It gives access to the XAccessibleContext interface. */ interface ::com::sun::star::accessibility::XAccessible; /** Give access to the structural information of a chart element.

You can access the following information for the shapes of the above listed types:

Role

All chart elements have the role AccessibleRole::SHAPE.

Name

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.

Description

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.

Children

The Diagram and the ChartLegend contain children, all other objects in a chart do not, i.e., are leaves in the document representation tree.

Parent

Because the setParent method from the JAA has been removed, the reference to the parent has to be provided in an implementation specific way.

Relations

They are not used at the moment.

States

The states supported by this service are:

AccessibleStateType::DEFUNC 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.
AccessibleStateType::EDITABLE
AccessibleStateType::ENABLED is always set.^†
AccessibleStateType::MULTILINE is set for all titles.
AccessibleStateType::OPAQUE is set for all elements that do have a transparency attributes set to 0% and no transparency gradient.
AccessibleStateType::RESIZABLE Is set for the diagram object only. All other chart elements may not be resized.
AccessibleStateType::SELECTABLE
AccessibleStateType::SELECTED
AccessibleStateType::SHOWING is always set.^†
AccessibleStateType::VISIBLE is always set.^†

^†always, except if the state AccessibleStateType::DEFUNC is set.

Locale

is supported.

Property change listeners

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.

*/ interface ::com::sun::star::accessibility::XAccessibleContext; /** Give access to the graphical representation of a chart element.

The coordinate oriented methods contains, getAccessibleAt, getBounds, getLocation, getLocationOnScreen, and getSize 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).

Focus handling depends on support of the XAccessibleText and XAccessibleEditableText interfaces.

Key bindings are not supported at the moment

*/ interface ::com::sun::star::accessibility::XAccessibleComponent; /** Give extended access to the graphical representation of a chart element.

This interface is used primarily to provide the predominant foreground and background colors and—if applicable, i.e. the XAccessibleText interface is supported—information about the font used to display text.

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.

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.

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.

*/ [optional] interface ::com::sun::star::accessibility::XAccessibleExtendedComponent; }; }; }; }; }; #endif