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

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