offapi/com/sun/star/awt/AccessibleWindow.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 a window.
  23
  24     @since OOo 1.1.2
  25  */
  26 service AccessibleWindow
  27 {
  28     /** This interface gives access to the structural information of a window:
  29
  30         <ul>
  31         <li>Role: The role of a window is not fixed. A window may have
  32             one of the following roles:
  33             <ul>
  34             <li>com::sun::star::accessibility::AccessibleRole::DIALOG</li>
  35             <li>com::sun::star::accessibility::AccessibleRole::FRAME</li>
  36             <li>com::sun::star::accessibility::AccessibleRole::LAYERED_PANE</li>
  37             <li>com::sun::star::accessibility::AccessibleRole::PANEL</li>
  38             <li>com::sun::star::accessibility::AccessibleRole::ROOT_PANE</li>
  39             <li>com::sun::star::accessibility::AccessibleRole::SCROLL_PANE</li>
  40             <li>com::sun::star::accessibility::AccessibleRole::SPLIT_PANE</li>
  41             <li>com::sun::star::accessibility::AccessibleRole::WINDOW</li>
  42             <li>...</li>
  43             </ul>
  44             </li>
  45         <li>Name: The name of a window is its localized title.</li>
  46         <li>Description: The description of a window is its localized
  47             help text.</li>
  48         <li>Children: The children of a window are the child windows.</li>
  49         <li>Parent: The parent of a window is the parent window.</li>
  50         <li>Relations: There are no relations.</li>
  51         <li>States: The states supported by this service are
  52             <ul>
  53             <li>com::sun::star::accessibility::AccessibleStateType::ACTIVE
  54                 is set if the object is currently the active object.</li>
  55             <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  56                 is set if the object has already been disposed
  57                 and subsequent calls to this object result in
  58                 com::sun::star::lang::DisposedException
  59                 exceptions.</li>
  60             <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  61                 is set if the object is enabled.</li>
  62             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  63                 is always set.</li>
  64             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  65                 is set if the object currently has the keyboard focus.</li>
  66             <li>com::sun::star::accessibility::AccessibleStateType::MODAL
  67                 is set if the object is modal.</li>
  68             <li>com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  69                 is set if the size of the object is not fixed.</li>
  70             <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  71                 is set if the object is displayed on the screen.</li>
  72             <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  73                 is always set.</li>
  74             </ul>
  75             </li>
  76         </ul>
  77      */
  78     interface ::com::sun::star::accessibility::XAccessibleContext;
  79     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  80     interface ::com::sun::star::accessibility::XAccessibleComponent;
  81     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  82 };
  83
  84 }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */