1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_awt_AccessibleToolBoxItem_idl__
25#define __com_sun_star_awt_AccessibleToolBoxItem_idl__
26
27#ifndef __com_sun_star_accessibility_AccessibleContext_idl__
28#include <com/sun/star/accessibility/AccessibleContext.idl>
29#endif
30
31
32module com { module sun { module star { module accessibility {
33
34 published interface XAccessibleAction;
35 published interface XAccessibleText;
36 published interface XAccessibleValue;
37 published interface XAccessibleExtendedComponent;
38 published interface XAccessibleComponent;
39
40}; }; }; };
41
42module com { module sun { module star { module awt {
43
44/** specifies accessibility support for a tool box item.
45
46    @see com::sun::star::accessibility::AccessibleContext
47
48    @see com::sun::star::accessibility::XAccessibleComponent
49	@see com::sun::star::accessibility::XAccessibleExtendedComponent
50
51    @see com::sun::star::accessibility::XAccessibleAction
52	@see com::sun::star::accessibility::XAccessibleText
53	@see com::sun::star::accessibility::XAccessibleValue
54
55	@since OpenOffice 1.1.2
56*/
57published service AccessibleToolBoxItem
58{
59	/** This interface gives access to the structural information of a tool box item:
60
61       <ul>
62       <li>Role: The role of a tool box item is
63		   <const scope="com::sun::star::accessibility">AccessibleRole::PUSH_BUTTON</const> when the item is a push button, or
64		   <const scope="com::sun::star::accessibility">AccessibleRole::TOGGLE_BUTTON</const> when the item is a button and checkable, or
65		   <const scope="com::sun::star::accessibility">AccessibleRole::PANEL</const> when the item is a window, or
66		   <const scope="com::sun::star::accessibility">AccessibleRole::FILLER</const> when the item is a fill item, or
67		   <const scope="com::sun::star::accessibility">AccessibleRole::SEPARATOR</const> when the item is a separator.</li>
68       <li>Name: The name of a tool box item is the name set.</li>
69       <li>Description: The description of a tool box item is its localized
70           help text.</li>
71       <li>Children: There can exist one child.
72			This can be any kind of accessible object.</li>
73       <li>Parent: The parent is the tool box that contains the tool box item.</li>
74       <li>Relations: There are no relations.</li>
75       <li>States: The states supported by this service are
76           <ul>
77           <li><const scope="com::sun::star::accessibility"
78               >AccessibleStateType::DEFUNC</const>
79               is set if the object has already been disposed
80               and subsequent calls to this object result in
81               <type scope="com::sun::star::lang">DisposedException</type>
82               exceptions.</li>
83           <li><const scope="com::sun::star::accessibility"
84               >AccessibleStateType::ENABLED</const> is set
85               if the object is enabled.</li>
86           <li><const scope="com::sun::star::accessibility"
87               >AccessibleStateType::FOCUSABLE</const> is always set.</li>
88           <li><const scope="com::sun::star::accessibility"
89               >AccessibleStateType::FOCUSED</const> is set
90               if the object currently has the keyboard focus.</li>
91           <li><const scope="com::sun::star::accessibility"
92               >AccessibleStateType::SHOWING</const> is set
93               if the object is displayed on the screen.</li>
94           <li><const scope="com::sun::star::accessibility"
95               >AccessibleStateType::VISIBLE</const> is always set.</li>
96		   <li><const scope="com::sun::star::accessibility"
97               >AccessibleStateType::CHECKED</const> is set
98			   if the tool box item is checked.</li>
99           </ul>
100           </li>
101       </ul>
102    */
103    service   com::sun::star::accessibility::AccessibleContext;
104
105	interface com::sun::star::accessibility::XAccessibleComponent;
106	interface com::sun::star::accessibility::XAccessibleExtendedComponent;
107
108    /** This interface gives access to the actions that can be executed for
109        a menu. The supported actions for a tool box item are:
110        <ul>
111        <li>click</li>
112        </ul>
113     */
114    interface com::sun::star::accessibility::XAccessibleAction;
115
116    /** This interface gives read-only access to the text representation
117        of a tool box item.
118     */
119    interface com::sun::star::accessibility::XAccessibleText;
120    /** This interface gives access to the numerical value of a
121        tool box item, which is related to the tool box item's
122        <const scope="com::sun::star::accessibility"
123        >AccessibleStateType::CHECKED</const> state.
124     */
125    interface com::sun::star::accessibility::XAccessibleValue;
126};
127
128}; }; }; };
129
130#endif
131