offapi/com/sun/star/awt/AccessibleTextField.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: AccessibleTextField.idl,v $
  10  * $Revision: 1.8 $
  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_accessibility_AccessibleTextField_idl__
  32 #define __com_sun_star_accessibility_AccessibleTextField_idl__
  33
  34 #ifndef __com_sun_star_accessibility_AccessibleContext_idl__
  35 #include <com/sun/star/accessibility/AccessibleContext.idl>
  36 #endif
  37
  38
  39 module com { module sun { module star { module accessibility {
  40
  41  published interface XAccessibleExtendedComponent;
  42  published interface XAccessibleComponent;
  43  published interface XAccessibleText;
  44
  45 }; }; }; };
  46
  47 module com { module sun { module star { module awt {
  48
  49
  50 /** Text fields are like edit fields as described by the
  51     <type>AccessibleEdit</type> service but without the ability to edit the
  52     text.
  53     @see com::sun::star::accessibility::AccessibleContext
  54     @see com::sun::star::accessibility::XAccessibleComponent
  55     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  56     @see com::sun::star::accessibility::XAccessibleText
  57
  58     @since OOo 1.1.2
  59 */
  60 published service AccessibleTextField
  61 {
  62     /** This interface gives access to the structural information of a text filed:
  63
  64        <ul>
  65        <li>Role: The role of a text filed is <const
  66            scope="com::sun::star::accessibility"
  67            >AccessibleRole::TEXT</const>.</li>
  68        <li>Name: The name of a text filed is its localized label.</li>
  69        <li>Description: The description of a text filed is its localized
  70            help text.</li>
  71        <li>Children: There exists no children.</li>
  72        <li>Parent: The parent is the window that contains the text filed.</li>
  73        <li>Relations: There are no relations.</li>
  74        <li>States: The states supported by this service are
  75            <ul>
  76            <li><const scope="com::sun::star::accessibility"
  77                >AccessibleStateType::DEFUNC</const>
  78                is set if the object has already been disposed
  79                and subsequent calls to this object result in
  80                <type scope="com::sun::star::lang">DisposedException</type>
  81                exceptions.</li>
  82            <li><const scope="com::sun::star::accessibility"
  83                >AccessibleStateType::ENABLED</const> is set
  84                if the object is enabled.</li>
  85            <li><const scope="com::sun::star::accessibility"
  86                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  87            <li><const scope="com::sun::star::accessibility"
  88                >AccessibleStateType::FOCUSED</const> is set
  89                if the object currently has the keyboard focus.</li>
  90            <li><const scope="com::sun::star::accessibility"
  91                >AccessibleStateType::ACTIVE</const> is set
  92                if a child has currently the focus.</li>
  93            <li><const scope="com::sun::star::accessibility"
  94                >AccessibleStateType::RESIZABLE</const> is set
  95                if the object can be resized.</li>
  96            <li><const scope="com::sun::star::accessibility"
  97                >AccessibleStateType::SHOWING</const> is set
  98                if the object is displayed on the screen.</li>
  99            <li><const scope="com::sun::star::accessibility"
 100                >AccessibleStateType::VISIBLE</const> is always set.</li>
 101            </ul>
 102            </li>
 103        </ul>
 104     */
 105
 106     service   com::sun::star::accessibility::AccessibleContext;
 107
 108     /** This interface gives read-only access to the text representation
 109         of a text field.
 110      */
 111     interface com::sun::star::accessibility::XAccessibleText;
 112     interface com::sun::star::accessibility::XAccessibleComponent;
 113     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
 114
 115 };
 116
 117 }; }; }; };
 118
 119 #endif