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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_awt_AccessibleTabBarPage_idl__
  30 #define __com_sun_star_awt_AccessibleTabBarPage_idl__
  31
  32 #include <com/sun/star/accessibility/XAccessibleContext.idl>
  33 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
  34 #include <com/sun/star/accessibility/XAccessibleComponent.idl>
  35 #include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
  36
  37 module com { module sun { module star { module awt {
  38
  39 /** specifies accessibility support for a tabbar page.
  40
  41     @since OOo 1.1.2
  42  */
  43 published service AccessibleTabBarPage
  44 {
  45     /** This interface gives access to the structural information of a
  46         tabbar page:
  47
  48         <ul>
  49         <li>Role: The role of a tabbar page is <const
  50             scope="com::sun::star::accessibility"
  51             >AccessibleRole::PAGE_TAB</const>.</li>
  52         <li>Name: The name of a tabbar page is the localized
  53             tabbar page text.</li>
  54         <li>Description: The description of a tabbar page is its localized
  55             help text.</li>
  56         <li>Children: There are no children.</li>
  57         <li>Parent: The parent of a tabbar page is the tabbar page list,
  58             whose accessible context supports the service
  59             <type>AccessibleTabBarPageList</type>.</li>
  60         <li>Relations: There are no relations.</li>
  61         <li>States: The states supported by this service are
  62             <ul>
  63             <li><const scope="com::sun::star::accessibility"
  64                 >AccessibleStateType::DEFUNC</const>
  65                 is set if the object has already been disposed
  66                 and subsequent calls to this object result in
  67                 <type scope="com::sun::star::lang">DisposedException</type>
  68                 exceptions.</li>
  69             <li><const scope="com::sun::star::accessibility"
  70                 >AccessibleStateType::ENABLED</const> is set
  71                 if the object is enabled.</li>
  72             <li><const scope="com::sun::star::accessibility"
  73                 >AccessibleStateType::SELECTABLE</const> is always set.</li>
  74             <li><const scope="com::sun::star::accessibility"
  75                 >AccessibleStateType::SELECTED</const> is set
  76                 if the object is selected.</li>
  77             <li><const scope="com::sun::star::accessibility"
  78                 >AccessibleStateType::SHOWING</const> is set
  79                 if the object is displayed on the screen.</li>
  80             <li><const scope="com::sun::star::accessibility"
  81                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  82             </ul>
  83             </li>
  84         </ul>
  85      */
  86     interface ::com::sun::star::accessibility::XAccessibleContext;
  87
  88     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  89
  90     interface ::com::sun::star::accessibility::XAccessibleComponent;
  91
  92     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  93
  94 };
  95
  96 }; }; }; };
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */