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