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