offapi/com/sun/star/awt/AccessibleToolBoxItem.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_AccessibleToolBoxItem_idl__
  21 #define __com_sun_star_awt_AccessibleToolBoxItem_idl__
  22
  23 #include <com/sun/star/accessibility/AccessibleContext.idl>
  24
  25
  26 module com { module sun { module star { module accessibility {
  27
  28  interface XAccessibleAction;
  29  interface XAccessibleText;
  30  interface XAccessibleValue;
  31  interface XAccessibleExtendedComponent;
  32  interface XAccessibleComponent;
  33
  34 }; }; }; };
  35
  36 module com { module sun { module star { module awt {
  37
  38 /** specifies accessibility support for a tool box item.
  39
  40     @see com::sun::star::accessibility::AccessibleContext
  41
  42     @see com::sun::star::accessibility::XAccessibleComponent
  43     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  44
  45     @see com::sun::star::accessibility::XAccessibleAction
  46     @see com::sun::star::accessibility::XAccessibleText
  47     @see com::sun::star::accessibility::XAccessibleValue
  48
  49     @since OOo 1.1.2
  50 */
  51 service AccessibleToolBoxItem
  52 {
  53     /** This interface gives access to the structural information of a tool box item:
  54
  55        <ul>
  56        <li>Role: The role of a tool box item is
  57            <const scope="com::sun::star::accessibility">AccessibleRole::PUSH_BUTTON</const> when the item is a push button, or
  58            <const scope="com::sun::star::accessibility">AccessibleRole::TOGGLE_BUTTON</const> when the item is a button and checkable, or
  59            <const scope="com::sun::star::accessibility">AccessibleRole::PANEL</const> when the item is a window, or
  60            <const scope="com::sun::star::accessibility">AccessibleRole::FILLER</const> when the item is a fill item, or
  61            <const scope="com::sun::star::accessibility">AccessibleRole::SEPARATOR</const> when the item is a separator.</li>
  62        <li>Name: The name of a tool box item is the name set.</li>
  63        <li>Description: The description of a tool box item is its localized
  64            help text.</li>
  65        <li>Children: There can exist one child.
  66             This can be any kind of accessible object.</li>
  67        <li>Parent: The parent is the tool box that contains the tool box item.</li>
  68        <li>Relations: There are no relations.</li>
  69        <li>States: The states supported by this service are
  70            <ul>
  71            <li><const scope="com::sun::star::accessibility"
  72                >AccessibleStateType::DEFUNC</const>
  73                is set if the object has already been disposed
  74                and subsequent calls to this object result in
  75                <type scope="com::sun::star::lang">DisposedException</type>
  76                exceptions.</li>
  77            <li><const scope="com::sun::star::accessibility"
  78                >AccessibleStateType::ENABLED</const> is set
  79                if the object is enabled.</li>
  80            <li><const scope="com::sun::star::accessibility"
  81                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  82            <li><const scope="com::sun::star::accessibility"
  83                >AccessibleStateType::FOCUSED</const> is set
  84                if the object currently has the keyboard focus.</li>
  85            <li><const scope="com::sun::star::accessibility"
  86                >AccessibleStateType::SHOWING</const> is set
  87                if the object is displayed on the screen.</li>
  88            <li><const scope="com::sun::star::accessibility"
  89                >AccessibleStateType::VISIBLE</const> is always set.</li>
  90            <li><const scope="com::sun::star::accessibility"
  91                >AccessibleStateType::CHECKED</const> is set
  92                if the tool box item is checked.</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     /** This interface gives access to the actions that can be executed for
 103         a menu. The supported actions for a tool box item are:
 104         <ul>
 105         <li>click</li>
 106         </ul>
 107      */
 108     interface com::sun::star::accessibility::XAccessibleAction;
 109
 110     /** This interface gives read-only access to the text representation
 111         of a tool box item.
 112      */
 113     interface com::sun::star::accessibility::XAccessibleText;
 114     /** This interface gives access to the numerical value of a
 115         tool box item, which is related to the tool box item's
 116         <const scope="com::sun::star::accessibility"
 117         >AccessibleStateType::CHECKED</const> state.
 118      */
 119     interface com::sun::star::accessibility::XAccessibleValue;
 120 };
 121
 122 }; }; }; };
 123
 124 #endif
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */