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