offapi/com/sun/star/awt/AccessibleTreeListBox.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_AccessibleTreeListBox_idl__
  21 #define __com_sun_star_awt_AccessibleTreeListBox_idl__
  22
  23 #include <com/sun/star/accessibility/AccessibleContext.idl>
  24
  25
  26 module com { module sun { module star { module accessibility {
  27
  28  interface XAccessibleSelection;
  29  interface XAccessibleComponent;
  30
  31 }; }; }; };
  32
  33 module com { module sun { module star { module awt {
  34
  35 /** specifies accessibility support for a tree list box.
  36
  37     @see com::sun::star::accessibility::AccessibleContext
  38
  39     @see com::sun::star::accessibility::XAccessibleComponent
  40     @see com::sun::star::accessibility::XAccessibleSelection
  41
  42     @since OOo 1.1.2
  43 */
  44 service AccessibleTreeListBox
  45 {
  46     /** This interface gives access to the structural information of a tree list box:
  47
  48        <ul>
  49        <li>Role: The role of a tree list box is
  50        com::sun::star::accessibility::AccessibleRole::TREE.</li>
  51        <li>Name: The name of a tree list box is its localized label.</li>
  52        <li>Description: The description of a tree list box is its localized
  53            help text.</li>
  54        <li>Children: There exists children of type com::sun::star::awt::AccessibleTreeListBoxEntry.
  55         </li>
  56        <li>Parent: The parent is the window that contains the tree list box.</li>
  57        <li>Relations: There are no relations.</li>
  58        <li>States: The states supported by this service are
  59            <ul>
  60            <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
  61                is set if the object has already been disposed
  62                and subsequent calls to this object result in
  63                com::sun::star::lang::DisposedException
  64                exceptions.</li>
  65            <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
  66                is set if the object is enabled.</li>
  67            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
  68                is always set.</li>
  69            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
  70                is set if the object currently has the keyboard focus.</li>
  71            <li>com::sun::star::accessibility::AccessibleStateType::ACTIVE
  72                is set if a child has currently the focus.</li>
  73            <li>com::sun::star::accessibility::AccessibleStateType::RESIZABLE
  74                is set if the object can be resized.</li>
  75            <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
  76                is set if the object is displayed on the screen.</li>
  77            <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
  78                is always set.</li>
  79            <li>com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE
  80                is set when multi selection is enabled.</li>
  81            </ul>
  82            </li>
  83        </ul>
  84     */
  85     service   com::sun::star::accessibility::AccessibleContext;
  86
  87     interface com::sun::star::accessibility::XAccessibleComponent;
  88
  89     /** This interface gives access to the selectable children of a
  90         tree list box.
  91      */
  92     interface com::sun::star::accessibility::XAccessibleSelection;
  93 };
  94
  95 }; }; }; };
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */