offapi/com/sun/star/awt/AccessibleTabPage.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_AccessibleTabPage_idl__
  21 #define __com_sun_star_awt_AccessibleTabPage_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 #include <com/sun/star/accessibility/XAccessibleText.idl>
  28
  29 module com { module sun { module star { module awt {
  30
  31 /** specifies accessibility support for a tab page.
  32
  33     @since OOo 1.1.2
  34  */
  35 service AccessibleTabPage
  36 {
  37     /** This interface gives access to the structural information of a
  38         tab page:
  39
  40         <ul>
  41         <li>Role: The role of a tab page is
  42         com::sun::star::accessibility::AccessibleRole::PAGE_TAB.</li>
  43         <li>Name: The name of a tab page is the localized tab page text.</li>
  44         <li>Description: The description of a tab page is its localized
  45             help text.</li>
  46         <li>Children: The child of a tab page is a panel.</li>
  47         <li>Parent: The parent of a tab page is the tab control,
  48             whose accessible context supports the service
  49             AccessibleTabControl.</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::DEFUNC
  54                 is set if the object has already been disposed
  55                 and subsequent calls to this object result in
  56                 com::sun::star::lang::DisposedException
  57                 exceptions.</li>
  58             <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  59                 is set if the object is enabled.</li>
  60             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  61                 is always set.</li>
  62             <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  63                 is set if the object currently has the keyboard focus.</li>
  64             <li>com::sun::star::accessibility::AccessibleStateType::SELECTABLE
  65                 is always set.</li>
  66             <li>com::sun::star::accessibility::AccessibleStateType::SELECTED
  67                 is set if the object is selected.</li>
  68             <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  69                 is set if the object is displayed on the screen.</li>
  70             <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  71                 is always set.</li>
  72             </ul>
  73             </li>
  74         </ul>
  75      */
  76     interface ::com::sun::star::accessibility::XAccessibleContext;
  77
  78     interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
  79
  80     interface ::com::sun::star::accessibility::XAccessibleComponent;
  81
  82     interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  83
  84     /** This interface gives read-only access to the text representation
  85         of a tab page.
  86      */
  87     interface ::com::sun::star::accessibility::XAccessibleText;
  88
  89 };
  90
  91 }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */