offapi/com/sun/star/awt/AccessibleToolBoxItem.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleToolBoxItem.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_awt_AccessibleToolBoxItem_idl__
  32 #define __com_sun_star_awt_AccessibleToolBoxItem_idl__
  33
  34 #ifndef __com_sun_star_accessibility_AccessibleContext_idl__
  35 #include <com/sun/star/accessibility/AccessibleContext.idl>
  36 #endif
  37
  38
  39 module com { module sun { module star { module accessibility {
  40
  41  published interface XAccessibleAction;
  42  published interface XAccessibleText;
  43  published interface XAccessibleValue;
  44  published interface XAccessibleExtendedComponent;
  45  published interface XAccessibleComponent;
  46
  47 }; }; }; };
  48
  49 module com { module sun { module star { module awt {
  50
  51 /** specifies accessibility support for a tool box item.
  52
  53     @see com::sun::star::accessibility::AccessibleContext
  54
  55     @see com::sun::star::accessibility::XAccessibleComponent
  56     @see com::sun::star::accessibility::XAccessibleExtendedComponent
  57
  58     @see com::sun::star::accessibility::XAccessibleAction
  59     @see com::sun::star::accessibility::XAccessibleText
  60     @see com::sun::star::accessibility::XAccessibleValue
  61
  62     @since OOo 1.1.2
  63 */
  64 published service AccessibleToolBoxItem
  65 {
  66     /** This interface gives access to the structural information of a tool box item:
  67
  68        <ul>
  69        <li>Role: The role of a tool box item is
  70            <const scope="com::sun::star::accessibility">AccessibleRole::PUSH_BUTTON</const> when the item is a push button, or
  71            <const scope="com::sun::star::accessibility">AccessibleRole::TOGGLE_BUTTON</const> when the item is a button and checkable, or
  72            <const scope="com::sun::star::accessibility">AccessibleRole::PANEL</const> when the item is a window, or
  73            <const scope="com::sun::star::accessibility">AccessibleRole::FILLER</const> when the item is a fill item, or
  74            <const scope="com::sun::star::accessibility">AccessibleRole::SEPARATOR</const> when the item is a separator.</li>
  75        <li>Name: The name of a tool box item is the name set.</li>
  76        <li>Description: The description of a tool box item is its localized
  77            help text.</li>
  78        <li>Children: There can exist one child.
  79             This can be any kind of accessible object.</li>
  80        <li>Parent: The parent is the tool box that contains the tool box item.</li>
  81        <li>Relations: There are no relations.</li>
  82        <li>States: The states supported by this service are
  83            <ul>
  84            <li><const scope="com::sun::star::accessibility"
  85                >AccessibleStateType::DEFUNC</const>
  86                is set if the object has already been disposed
  87                and subsequent calls to this object result in
  88                <type scope="com::sun::star::lang">DisposedException</type>
  89                exceptions.</li>
  90            <li><const scope="com::sun::star::accessibility"
  91                >AccessibleStateType::ENABLED</const> is set
  92                if the object is enabled.</li>
  93            <li><const scope="com::sun::star::accessibility"
  94                >AccessibleStateType::FOCUSABLE</const> is always set.</li>
  95            <li><const scope="com::sun::star::accessibility"
  96                >AccessibleStateType::FOCUSED</const> is set
  97                if the object currently has the keyboard focus.</li>
  98            <li><const scope="com::sun::star::accessibility"
  99                >AccessibleStateType::SHOWING</const> is set
 100                if the object is displayed on the screen.</li>
 101            <li><const scope="com::sun::star::accessibility"
 102                >AccessibleStateType::VISIBLE</const> is always set.</li>
 103            <li><const scope="com::sun::star::accessibility"
 104                >AccessibleStateType::CHECKED</const> is set
 105                if the tool box item is checked.</li>
 106            </ul>
 107            </li>
 108        </ul>
 109     */
 110     service   com::sun::star::accessibility::AccessibleContext;
 111
 112     interface com::sun::star::accessibility::XAccessibleComponent;
 113     interface com::sun::star::accessibility::XAccessibleExtendedComponent;
 114
 115     /** This interface gives access to the actions that can be executed for
 116         a menu. The supported actions for a tool box item are:
 117         <ul>
 118         <li>click</li>
 119         </ul>
 120      */
 121     interface com::sun::star::accessibility::XAccessibleAction;
 122
 123     /** This interface gives read-only access to the text representation
 124         of a tool box item.
 125      */
 126     interface com::sun::star::accessibility::XAccessibleText;
 127     /** This interface gives access to the numerical value of a
 128         tool box item, which is related to the tool box item's
 129         <const scope="com::sun::star::accessibility"
 130         >AccessibleStateType::CHECKED</const> state.
 131      */
 132     interface com::sun::star::accessibility::XAccessibleValue;
 133 };
 134
 135 }; }; }; };
 136
 137 #endif