diff options
Diffstat (limited to 'offapi/com/sun/star/awt/AccessibleEdit.idl')
| -rw-r--r-- | offapi/com/sun/star/awt/AccessibleEdit.idl | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/AccessibleEdit.idl b/offapi/com/sun/star/awt/AccessibleEdit.idl new file mode 100644 index 000000000000..c3fa8d126eaa --- /dev/null +++ b/offapi/com/sun/star/awt/AccessibleEdit.idl @@ -0,0 +1,135 @@ +/************************************************************************* + * + * 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_awt_AccessibleEdit_idl__ +#define __com_sun_star_awt_AccessibleEdit_idl__ + +#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__ +#include <com/sun/star/accessibility/XAccessibleContext.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__ +#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__ +#include <com/sun/star/accessibility/XAccessibleComponent.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__ +#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleText_idl__ +#include <com/sun/star/accessibility/XAccessibleText.idl> +#endif +#ifndef __com_sun_star_accessibility_XAccessibleEditableText_idl__ +#include <com/sun/star/accessibility/XAccessibleEditableText.idl> +#endif + +module com { module sun { module star { module awt { + +/** specifies accessibility support for an edit. + + @since OOo 1.1.2 + */ +published service AccessibleEdit +{ + /** This interface gives access to the structural information of an edit: + + <ul> + <li>Role: The role of an edit is <const + scope="com::sun::star::accessibility" + >AccessibleRole::TEXT</const>. + If the text content of the edit is password protected + the role is <const scope="com::sun::star::accessibility" + >AccessibleRole::PASSWORD_TEXT</const>.</li> + <li>Name: If the relation of type <const + scope="com::sun::star::accessibility" + >AccessibleRelationType::LABELED_BY</const> is set, + the name of the edit is the localized label of the target + object, otherwise there is no name.</li> + <li>Description: The description of an edit is its localized + help text.</li> + <li>Children: There are no children.</li> + <li>Parent: The parent is the window that contains the edit.</li> + <li>Relations: The relations supported by this service are + <ul> + <li><const scope="com::sun::star::accessibility" + >AccessibleRelationType::LABELED_BY</const> is set + if the object is labeled by one or more target + objects.</li> + </ul> + </li> + <li>States: The states supported by this service are + <ul> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::DEFUNC</const> + is set if the object has already been disposed + and subsequent calls to this object result in + <type scope="com::sun::star::lang">DisposedException</type> + exceptions.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::EDITABLE</const> is set + if the content of the object can be changed by the user.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::ENABLED</const> is set + if the object is enabled.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::FOCUSABLE</const> is always set.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::FOCUSED</const> is set + if the object currently has the keyboard focus.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::SHOWING</const> is set + if the object is displayed on the screen.</li> + <li><const scope="com::sun::star::accessibility" + >AccessibleStateType::VISIBLE</const> is always set.</li> + </ul> + </li> + </ul> + */ + interface ::com::sun::star::accessibility::XAccessibleContext; + + interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster; + + interface ::com::sun::star::accessibility::XAccessibleComponent; + + interface ::com::sun::star::accessibility::XAccessibleExtendedComponent; + + /** This interface gives read-only access to the text representation + of an edit. + */ + interface ::com::sun::star::accessibility::XAccessibleText; + + /** This interface extends the + <type scope="com::sun::star::accessibility">XAccessibleText</type> + interface and gives read and write access to the text representation + of an edit. + */ + interface ::com::sun::star::accessibility::XAccessibleEditableText; +}; + +}; }; }; }; + +#endif |