/************************************************************** * * 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_accessibility_XAccessibleComponent_idl__ #define __com_sun_star_accessibility_XAccessibleComponent_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_awt_XFocusListener_idl__ #include #endif #ifndef __com_sun_star_awt_XFont_idl__ #include #endif #ifndef __com_sun_star_awt_FontDescriptor_idl__ #include #endif #ifndef __com_sun_star_awt_Point_idl__ #include #endif #ifndef __com_sun_star_awt_Rectangle_idl__ #include #endif #ifndef __com_sun_star_awt_Size_idl__ #include #endif #ifndef __com_sun_star_util_Color_idl__ #include #endif module com { module sun { module star { module accessibility { published interface XAccessible; /** The XAccessibleComponent interface should be supported by any class that can be rendered on the screen.

This interface provides the standard mechanism for an assistive technology to retrieve information concerning the graphical representation of an object. This interface combines methods from the Java interfaces javax.accessibility.AccessibleComponent and javax.accessibility.AccessibleExtendedComponent.

Further information about the graphical appearance of an object can be expressed with the XAccessibleExtendedComponent interface.

Coordinates used by the functions of this interface are specified in different coordinate systems. Their scale is the same and is equal to that of the screen coordiante system. In other words all coordinates are measured in pixel. They differ in their respective origin:

  • The screen coordinate system has its origin in the upper left corner of the current screen. Used by the getLocationOnScreen function.
  • The origin of the parent coordinate system is the upper left corner of the parent's bounding box. With no parent the screen coordinate system is used instead. Used by the getLocation function.
  • The object coordinate system is relative to the upper left corner of an object's bounding box. It is relative to itself so to speak. Used by the containsPoint and getAccessibleAtPoint functions.

Key bindings which are associated with an accessible component can be retrieved at the component's action. The reason for this is that key bindings are associated with actions and directly with a component. This distinction becomes important when there are more than one action. To get access to the key bindings you have to get the XAccessibleAction interface of a component, provided that it is supported, and use the getAccessibleKeyBinding().

@see XAccessibleExtendedComponent @since OpenOffice 1.1.2 */ published interface XAccessibleComponent : ::com::sun::star::uno::XInterface { /** Tests whether the specified point lies within this object's bounds.

The test point's coordinates are defined relative to the coordinate system of the object. That means that when the object is an opaque rectangle then both the points (0,0) and (with-1,height-1) would yield a value.

@param point Coordinates of the point to test. The origin of the coordinate system is the upper left corner of the object's bounding box as returned by the getBounds. The scale of the coordinate system is identical to that of the screen coordiante system. @return Returns if the point lies within or on the object's bounding box and otherwise. */ boolean containsPoint ([in] ::com::sun::star::awt::Point aPoint); /** Returns the Accessible child that is rendered under the given point.

The test point's coordinates are defined relative to the coordinate system of the object. That means that when the object is an opaque rectangle then both the points (0,0) and (with-1,height-1) would yield a value.

@param aPoint Coordinates of the test point for which to find the Accessible child. The origin of the coordinate system is the upper left corner of the object's bounding box as returned by the getBounds. The scale of the coordinate system is identical to that of the screen coordiante system. @return If there is one child which is rendered so that its bounding box contains the test point then a reference to that object is returned. If there is more than one child which satisfies that condition then a reference to that one is returned that is painted on top of the others. If no there is no child which is rendered at the test point an empty reference is returned. */ XAccessible getAccessibleAtPoint ([in] ::com::sun::star::awt::Point aPoint); /** Returns the bounding box of this object.

The returned bounding box has the form of a rectangle. Its coordinates are relative to the object's parent coordinate system. Note that the two methods getLocation and getSize return the same information. With method getLocationOnScreen you can get the bound box position in screen coordinates.

@return The coordinates of the returned rectangle are relative to this object's parent or relative to the screen on which this object is rendered if it has no parent. If the object is not on any screen the returnred rectangle is empty and located at position (0,0). */ ::com::sun::star::awt::Rectangle getBounds (); /** Returns the location of the upper left corner of the object's bounding box relative to the parent.

The coordinates of the bounding box are given relative to the parent's coordinate system.

@return The coordinates of the returned position are relative to this object's parent or relative to the screen on which this object is rendered if it has no parent. If the object is not on any screen the returnred position is (0,0). */ ::com::sun::star::awt::Point getLocation (); /** Returns the location of the upper left corner of the object's bounding box in screen coordinates.

This method returns the same point as does the method getLocation. The difference is that the coordinates are absolute screen coordinates of the screen to which the object is rendered instead of being relative to the object's parent.

@return The coordinates of the returned position are relative to the screen on which this object is rendered. If the object is not on any screen the returnred position is (0,0). */ ::com::sun::star::awt::Point getLocationOnScreen (); /** Returns the size of this object's bounding box. @return The returned size is the size of this object or empty if it is not rendered on any screen. */ ::com::sun::star::awt::Size getSize(); /** Grabs the focus to this object.

If this object can not accept the focus, i.e. isFocusTraversable returns for this object then nothing happens. Otherwise the object will attempt to take the focus. Nothing happens if that fails, otherwise the object has the focus. This method is called requestFocus in the Java Accessibility API 1.4.

*/ [oneway] void grabFocus (); /** Returns the foreground color of this object. @return The returned color is the foreground color of this object or, if that is not supported, the default foreground color. */ ::com::sun::star::util::Color getForeground (); /** Returns the background color of this object. @return The returned color is the background color of this object or, if that is not supported, the default background color. */ ::com::sun::star::util::Color getBackground (); }; }; }; }; }; #endif