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