offapi/com/sun/star/awt/AccessibleEdit.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleEdit.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_awt_AccessibleEdit_idl__
  32 #define __com_sun_star_awt_AccessibleEdit_idl__
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  35 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  36 #endif
  37 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  38 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  39 #endif
  40 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  41 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  42 #endif
  43 #ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
  44 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  45 #endif
  46 #ifndef __com_sun_star_accessibility_XAccessibleText_idl__
  47 #include <com/sun/star/accessibility/XAccessibleText.idl>
  48 #endif
  49 #ifndef __com_sun_star_accessibility_XAccessibleEditableText_idl__
  50 #include <com/sun/star/accessibility/XAccessibleEditableText.idl>
  51 #endif
  52
  53 module com { module sun { module star { module awt {
  54
  55 /** specifies accessibility support for an edit.
  56
  57     @since OOo 1.1.2
  58  */
  59 published service AccessibleEdit
  60 {
  61     /** This interface gives access to the structural information of an edit:
  62
  63         <ul>
  64         <li>Role: The role of an edit is <const
  65             scope="com::sun::star::accessibility"
  66             >AccessibleRole::TEXT</const>.
  67             If the text content of the edit is password protected
  68             the role is <const scope="com::sun::star::accessibility"
  69             >AccessibleRole::PASSWORD_TEXT</const>.</li>
  70         <li>Name: If the relation of type <const
  71             scope="com::sun::star::accessibility"
  72             >AccessibleRelationType::LABELED_BY</const> is set,
  73             the name of the edit is the localized label of the target
  74             object, otherwise there is no name.</li>
  75         <li>Description: The description of an edit is its localized
  76             help text.</li>
  77         <li>Children: There are no children.</li>
  78         <li>Parent: The parent is the window that contains the edit.</li>
  79         <li>Relations: The relations supported by this service are
  80             <ul>
  81             <li><const scope="com::sun::star::accessibility"
  82                 >AccessibleRelationType::LABELED_BY</const> is set
  83                 if the object is labeled by one or more target
  84                 objects.</li>
  85             </ul>
  86             </li>
  87         <li>States: The states supported by this service are
  88             <ul>
  89             <li><const scope="com::sun::star::accessibility"
  90                 >AccessibleStateType::DEFUNC</const>
  91                 is set if the object has already been disposed
  92                 and subsequent calls to this object result in
  93                 <type scope="com::sun::star::lang">DisposedException</type>
  94                 exceptions.</li>
  95             <li><const scope="com::sun::star::accessibility"
  96                 >AccessibleStateType::EDITABLE</const> is set
  97                 if the content of the object can be changed by the user.</li>
  98             <li><const scope="com::sun::star::accessibility"
  99                 >AccessibleStateType::ENABLED</const> is set
 100                 if the object is enabled.</li>
 101             <li><const scope="com::sun::star::accessibility"
 102                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
 103             <li><const scope="com::sun::star::accessibility"
 104                 >AccessibleStateType::FOCUSED</const> is set
 105                 if the object currently has the keyboard focus.</li>
 106             <li><const scope="com::sun::star::accessibility"
 107                 >AccessibleStateType::SHOWING</const> is set
 108                 if the object is displayed on the screen.</li>
 109             <li><const scope="com::sun::star::accessibility"
 110                 >AccessibleStateType::VISIBLE</const> is always set.</li>
 111             </ul>
 112             </li>
 113         </ul>
 114      */
 115     interface ::com::sun::star::accessibility::XAccessibleContext;
 116
 117     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 118
 119     interface ::com::sun::star::accessibility::XAccessibleComponent;
 120
 121     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 122
 123     /** This interface gives read-only access to the text representation
 124         of an edit.
 125      */
 126     interface ::com::sun::star::accessibility::XAccessibleText;
 127
 128     /** This interface extends the
 129         <type scope="com::sun::star::accessibility">XAccessibleText</type>
 130         interface and gives read and write access to the text representation
 131         of an edit.
 132      */
 133     interface ::com::sun::star::accessibility::XAccessibleEditableText;
 134 };
 135
 136 }; }; }; };
 137
 138 #endif