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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleWindow.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_awt_AccessibleWindow_idl__
  32 #define __com_sun_star_awt_AccessibleWindow_idl__
  33
  34 #ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
  35 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  36 #endif
  37 #ifndef __com_sun_star_accessibility_XAccessibleEventBroadcaster_idl__
  38 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  39 #endif
  40 #ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
  41 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  42 #endif
  43 #ifndef __com_sun_star_accessibility_XAccessibleExtendedComponent_idl__
  44 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  45 #endif
  46
  47 module com { module sun { module star { module awt {
  48
  49 /** specifies accessibility support for a window.
  50
  51     @since OOo 1.1.2
  52  */
  53 published service AccessibleWindow
  54 {
  55     /** This interface gives access to the structural information of a window:
  56
  57         <ul>
  58         <li>Role: The role of a window is not fixed. A window may have
  59             one of the following roles:
  60             <ul>
  61             <li><const scope="com::sun::star::accessibility"
  62                 >AccessibleRole::DIALOG</const></li>
  63             <li><const scope="com::sun::star::accessibility"
  64                 >AccessibleRole::FRAME</const></li>
  65             <li><const scope="com::sun::star::accessibility"
  66                 >AccessibleRole::LAYERED_PANE</const></li>
  67             <li><const scope="com::sun::star::accessibility"
  68                 >AccessibleRole::PANEL</const></li>
  69             <li><const scope="com::sun::star::accessibility"
  70                 >AccessibleRole::ROOT_PANE</const></li>
  71             <li><const scope="com::sun::star::accessibility"
  72                 >AccessibleRole::SCROLL_PANE</const></li>
  73             <li><const scope="com::sun::star::accessibility"
  74                 >AccessibleRole::SPLIT_PANE</const></li>
  75             <li><const scope="com::sun::star::accessibility"
  76                 >AccessibleRole::WINDOW</const></li>
  77             <li>...</li>
  78             </ul>
  79             </li>
  80         <li>Name: The name of a window is its localized title.</li>
  81         <li>Description: The description of a window is its localized
  82             help text.</li>
  83         <li>Children: The children of a window are the child windows.</li>
  84         <li>Parent: The parent of a window is the parent window.</li>
  85         <li>Relations: There are no relations.</li>
  86         <li>States: The states supported by this service are
  87             <ul>
  88             <li><const scope="com::sun::star::accessibility"
  89                 >AccessibleStateType::ACTIVE</const> is set
  90                 if the object is currently the active object.</li>
  91             <li><const scope="com::sun::star::accessibility"
  92                 >AccessibleStateType::DEFUNC</const>
  93                 is set if the object has already been disposed
  94                 and subsequent calls to this object result in
  95                 <type scope="com::sun::star::lang">DisposedException</type>
  96                 exceptions.</li>
  97             <li><const scope="com::sun::star::accessibility"
  98                 >AccessibleStateType::ENABLED</const> is set
  99                 if the object is enabled.</li>
 100             <li><const scope="com::sun::star::accessibility"
 101                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
 102             <li><const scope="com::sun::star::accessibility"
 103                 >AccessibleStateType::FOCUSED</const> is set
 104                 if the object currently has the keyboard focus.</li>
 105             <li><const scope="com::sun::star::accessibility"
 106                 >AccessibleStateType::MODAL</const> is set
 107                 if the object is modal.</li>
 108             <li><const scope="com::sun::star::accessibility"
 109                 >AccessibleStateType::RESIZABLE</const> is set
 110                 if the size of the object is not fixed.</li>
 111             <li><const scope="com::sun::star::accessibility"
 112                 >AccessibleStateType::SHOWING</const> is set
 113                 if the object is displayed on the screen.</li>
 114             <li><const scope="com::sun::star::accessibility"
 115                 >AccessibleStateType::VISIBLE</const> is always set.</li>
 116             </ul>
 117             </li>
 118         </ul>
 119      */
 120     interface ::com::sun::star::accessibility::XAccessibleContext;
 121     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 122     interface ::com::sun::star::accessibility::XAccessibleComponent;
 123     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 124 };
 125
 126 }; }; }; };
 127
 128 #endif