summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/AccessibleToolBox.idl
blob: 2d47013296ceae8f3b067073e66e56f1c131f97e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_awt_AccessibleToolBox_idl__
#define __com_sun_star_awt_AccessibleToolBox_idl__

#include <com/sun/star/accessibility/AccessibleContext.idl>


module com { module sun { module star { module accessibility {

 interface XAccessibleExtendedComponent;
 interface XAccessibleComponent;

}; }; }; };

module com { module sun { module star { module awt {



/** specifies accessibility support for a tool box.

    @see com::sun::star::accessibility::AccessibleContext
    @see com::sun::star::accessibility::XAccessibleComponent
    @see com::sun::star::accessibility::XAccessibleExtendedComponent

    @since OOo 1.1.2
*/
service AccessibleToolBox
{
    /** This interface gives access to the structural information of a tool box:

       <ul>
       <li>Role: The role of a tool box is
       com::sun::star::accessibility::AccessibleRole::TOOL_BAR.</li>
       <li>Name: The name of a tool box is its localized label.</li>
       <li>Description: The description of a tool box is its localized
           help text.</li>
       <li>Children: There exists children of type com::sun::star::awt::AccessibleToolBoxItem.
       </li>
       <li>Parent: The parent is the window that contains the tool box.</li>
       <li>Relations: There are no relations.</li>
       <li>States: The states supported by this service are
           <ul>
           <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
               is set if the object has already been disposed
               and subsequent calls to this object result in
               com::sun::star::lang::DisposedException
               exceptions.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
               is set if the object is enabled.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
               is always set.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
               is set if the object currently has the keyboard focus.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::ACTIVE
               is set if a child has currently the focus.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::RESIZABLE
               is set if the object can be resized.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
               is set if the object is displayed on the screen.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
               is always set.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::VERTICAL
               is set if the tool box is vertical.</li>
           <li>com::sun::star::accessibility::AccessibleStateType::HORIZONTAL
               is set if the tool box is horizontal.</li>
           </ul>
           </li>
       </ul>
    */
    service   com::sun::star::accessibility::AccessibleContext;

    interface com::sun::star::accessibility::XAccessibleComponent;
    interface com::sun::star::accessibility::XAccessibleExtendedComponent;

};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */