offapi/com/sun/star/awt/AccessibleTabBarPage.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_AccessibleTabBarPage_idl__
  21 #define __com_sun_star_awt_AccessibleTabBarPage_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
  28 module com { module sun { module star { module awt {
  29
  30 /** specifies accessibility support for a tabbar page.
  31
  32     @since OOo 1.1.2
  33  */
  34 service AccessibleTabBarPage
  35 {
  36     /** This interface gives access to the structural information of a
  37         tabbar page:
  38
  39         <ul>
  40         <li>Role: The role of a tabbar page is <const
  41             scope="com::sun::star::accessibility"
  42             >AccessibleRole::PAGE_TAB</const>.</li>
  43         <li>Name: The name of a tabbar page is the localized
  44             tabbar page text.</li>
  45         <li>Description: The description of a tabbar page is its localized
  46             help text.</li>
  47         <li>Children: There are no children.</li>
  48         <li>Parent: The parent of a tabbar page is the tabbar page list,
  49             whose accessible context supports the service
  50             <type>AccessibleTabBarPageList</type>.</li>
  51         <li>Relations: There are no relations.</li>
  52         <li>States: The states supported by this service are
  53             <ul>
  54             <li><const scope="com::sun::star::accessibility"
  55                 >AccessibleStateType::DEFUNC</const>
  56                 is set if the object has already been disposed
  57                 and subsequent calls to this object result in
  58                 <type scope="com::sun::star::lang">DisposedException</type>
  59                 exceptions.</li>
  60             <li><const scope="com::sun::star::accessibility"
  61                 >AccessibleStateType::ENABLED</const> is set
  62                 if the object is enabled.</li>
  63             <li><const scope="com::sun::star::accessibility"
  64                 >AccessibleStateType::SELECTABLE</const> is always set.</li>
  65             <li><const scope="com::sun::star::accessibility"
  66                 >AccessibleStateType::SELECTED</const> is set
  67                 if the object is selected.</li>
  68             <li><const scope="com::sun::star::accessibility"
  69                 >AccessibleStateType::SHOWING</const> is set
  70                 if the object is displayed on the screen.</li>
  71             <li><const scope="com::sun::star::accessibility"
  72                 >AccessibleStateType::VISIBLE</const> is always set.</li>
  73             </ul>
  74             </li>
  75         </ul>
  76      */
  77     interface ::com::sun::star::accessibility::XAccessibleContext;
  78
  79     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  80
  81     interface ::com::sun::star::accessibility::XAccessibleComponent;
  82
  83     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  84
  85 };
  86
  87 }; }; }; };
  88
  89 #endif
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */