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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_awt_AccessibleTextField_idl__
  21 #define __com_sun_star_awt_AccessibleTextField_idl__
  22
  23 #include <com/sun/star/accessibility/AccessibleContext.idl>
  24
  25
  26 module com { module sun { module star { module accessibility {
  27
  28  interface XAccessibleExtendedComponent;
  29  interface XAccessibleComponent;
  30  interface XAccessibleText;
  31
  32 }; }; }; };
  33
  34 module com { module sun { module star { module awt {
  35
  36
  37 /** Text fields are like edit fields as described by the
  38     AccessibleEdit service but without the ability to edit the
  39     text.
  40     @see com::sun::star::accessibility::AccessibleContext
  41     @see com::sun::star::accessibility::XAccessibleComponent
  42     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  43     @see com::sun::star::accessibility::XAccessibleText
  44
  45     @since OOo 1.1.2
  46 */
  47 service AccessibleTextField
  48 {
  49     /** This interface gives access to the structural information of a text filed:
  50
  51        <ul>
  52        <li>Role: The role of a text filed is
  53        com::sun::star::accessibility::AccessibleRole::TEXT.</li>
  54        <li>Name: The name of a text filed is its localized label.</li>
  55        <li>Description: The description of a text filed is its localized
  56            help text.</li>
  57        <li>Children: There exists no children.</li>
  58        <li>Parent: The parent is the window that contains the text filed.</li>
  59        <li>Relations: There are no relations.</li>
  60        <li>States: The states supported by this service are
  61            <ul>
  62            <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  63                is set if the object has already been disposed
  64                and subsequent calls to this object result in
  65                com::sun::star::lang::DisposedException
  66                exceptions.</li>
  67            <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  68                is set if the object is enabled.</li>
  69            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  70                is always set.</li>
  71            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  72                is set if the object currently has the keyboard focus.</li>
  73            <li>com::sun::star::accessibility::AccessibleStateType::ACTIVE
  74                is set if a child has currently the focus.</li>
  75            <li>com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  76                is set if the object can be resized.</li>
  77            <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  78                is set if the object is displayed on the screen.</li>
  79            <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  80                is always set.</li>
  81            </ul>
  82            </li>
  83        </ul>
  84     */
  85
  86     service   com::sun::star::accessibility::AccessibleContext;
  87
  88     /** This interface gives read-only access to the text representation
  89         of a text field.
  90      */
  91     interface com::sun::star::accessibility::XAccessibleText;
  92     interface com::sun::star::accessibility::XAccessibleComponent;
  93     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
  94
  95 };
  96
  97 }; }; }; };
  98
  99 #endif
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */