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