offapi/com/sun/star/awt/AccessibleEdit.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 module com { module sun { module star { module awt {
  21
  22 /** specifies accessibility support for an edit.
  23
  24     @since OOo 1.1.2
  25  */
  26 service AccessibleEdit
  27 {
  28     /** This interface gives access to the structural information of an edit:
  29
  30         <ul>
  31         <li>Role: The role of an edit is
  32             com::sun::star::accessibility::AccessibleRole::TEXT.
  33             If the text content of the edit is password protected
  34             the role is
  35             com::sun::star::accessibility::AccessibleRole::PASSWORD_TEXT.</li>
  36         <li>Name: If the relation of type
  37             com::sun::star::accessibility::AccessibleRelationType::LABELED_BY
  38             is set, the name of the edit is the localized label of the target
  39             object, otherwise there is no name.</li>
  40         <li>Description: The description of an edit is its localized
  41             help text.</li>
  42         <li>Children: There are no children.</li>
  43         <li>Parent: The parent is the window that contains the edit.</li>
  44         <li>Relations: The relations supported by this service are
  45             <ul>
  46             <li>com::sun::star::accessibility::AccessibleRelationType::LABELED_BY
  47                 is set if the object is labeled by one or more target
  48                 objects.</li>
  49             </ul>
  50             </li>
  51         <li>States: The states supported by this service are
  52             <ul>
  53             <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  54                 is set if the object has already been disposed
  55                 and subsequent calls to this object result in
  56                 com::sun::star::lang::DisposedException
  57                 exceptions.</li>
  58             <li>com::sun::star::accessibility::AccessibleStateType::EDITABLE
  59                 is set
  60                 if the content of the object can be changed by the user.</li>
  61             <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  62                 is set if the object is enabled.</li>
  63             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  64                 is always set.</li>
  65             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  66                 is set if the object currently has the keyboard focus.</li>
  67             <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  68                 is set if the object is displayed on the screen.</li>
  69             <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  70                 is always set.</li>
  71             </ul>
  72             </li>
  73         </ul>
  74      */
  75     interface ::com::sun::star::accessibility::XAccessibleContext;
  76
  77     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  78
  79     interface ::com::sun::star::accessibility::XAccessibleComponent;
  80
  81     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  82
  83     /** This interface gives read-only access to the text representation
  84         of an edit.
  85      */
  86     interface ::com::sun::star::accessibility::XAccessibleText;
  87
  88     /** This interface extends the
  89         com::sun::star::accessibility::XAccessibleText
  90         interface and gives read and write access to the text representation
  91         of an edit.
  92      */
  93     interface ::com::sun::star::accessibility::XAccessibleEditableText;
  94 };
  95
  96 }; }; }; };
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */