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