offapi/com/sun/star/awt/AccessibleTabBar.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: AccessibleTabBar.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_AccessibleTabBar_idl__
  32 #define __com_sun_star_awt_AccessibleTabBar_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 tabbar.
  50
  51     @since OOo 1.1.2
  52  */
  53 published service AccessibleTabBar
  54 {
  55     /** This interface gives access to the structural information of a
  56         tabbar:
  57
  58         <ul>
  59         <li>Role: The role of a tabbar is <const
  60             scope="com::sun::star::accessibility"
  61             >AccessibleRole::PANEL</const>.</li>
  62         <li>Name: There is no name.</li>
  63         <li>Description: The description of a tabbar is its localized
  64             help text.</li>
  65         <li>Children: The children of a tabbar are tabbar buttons,
  66             the tabbar sizer and the tabbar page list,
  67             whose accessible context supports the service
  68             <type>AccessibleTabBarPageList</type>.</li>
  69         <li>Parent: The parent is the window that contains the
  70             tabbar.</li>
  71         <li>Relations: There are no relations.</li>
  72         <li>States: The states supported by this service are
  73             <ul>
  74             <li><const scope="com::sun::star::accessibility"
  75                 >AccessibleStateType::DEFUNC</const>
  76                 is set if the object has already been disposed
  77                 and subsequent calls to this object result in
  78                 <type scope="com::sun::star::lang">DisposedException</type>
  79                 exceptions.</li>
  80             <li><const scope="com::sun::star::accessibility"
  81                 >AccessibleStateType::ENABLED</const> is set
  82                 if the object is enabled.</li>
  83             <li><const scope="com::sun::star::accessibility"
  84                 >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  85             <li><const scope="com::sun::star::accessibility"
  86                 >AccessibleStateType::FOCUSED</const> is set
  87                 if the object currently has the keyboard focus.</li>
  88             <li><const scope="com::sun::star::accessibility"
  89                 >AccessibleStateType::RESIZABLE</const> is set
  90                 if the size of the object is not fixed.</li>
  91             <li><const scope="com::sun::star::accessibility"
  92                 >AccessibleStateType::SHOWING</const> is set
  93                 if the object is displayed on the screen.</li>
  94             <li><const scope="com::sun::star::accessibility"
  95                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  96             </ul>
  97             </li>
  98         </ul>
  99      */
 100     interface ::com::sun::star::accessibility::XAccessibleContext;
 101
 102     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
 103
 104     interface ::com::sun::star::accessibility::XAccessibleComponent;
 105
 106     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
 107
 108 };
 109
 110 }; }; }; };
 111
 112 #endif