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_AccessibleCheckBox_idl__
21#define __com_sun_star_awt_AccessibleCheckBox_idl__
22
23#include <com/sun/star/accessibility/XAccessibleContext.idl>
24#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>
25#include <com/sun/star/accessibility/XAccessibleComponent.idl>
26#include <com/sun/star/accessibility/XAccessibleExtendedComponent.idl>
27#include <com/sun/star/accessibility/XAccessibleText.idl>
28#include <com/sun/star/accessibility/XAccessibleAction.idl>
29#include <com/sun/star/accessibility/XAccessibleValue.idl>
30
31module com { module sun { module star { module awt {
32
33/** specifies accessibility support for a check box.
34
35    @since OOo 1.1.2
36 */
37service AccessibleCheckBox
38{
39    /** This interface gives access to the structural information of a
40        check box:
41
42        <ul>
43        <li>Role: The role of a check box is
44            com::sun::star::accessibility::AccessibleRole::CHECK_BOX.</li>
45        <li>Name: The name of a check box is its localized label.</li>
46        <li>Description: The description of a check box is its localized
47            help text.</li>
48        <li>Children: There are no children.</li>
49        <li>Parent: The parent is the window that contains the check box.</li>
50        <li>Relations: There are no relations.</li>
51        <li>States: The states supported by this service are
52            <ul>
53            <li>com::sun::star::accessibility::AccessibleStateType::CHECKED
54                is set if the object is currently checked.</li>
55            <li>com::sun::star::accessibility::AccessibleStateType::DEFUNC
56                is set if the object has already been disposed
57                and subsequent calls to this object result in
58                com::sun::star::lang::DisposedException
59                exceptions.</li>
60            <li>com::sun::star::accessibility::AccessibleStateType::ENABLED
61                is set if the object is enabled.</li>
62            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
63                is always set.</li>
64            <li>com::sun::star::accessibility::AccessibleStateType::FOCUSED
65                is set if the object currently has the keyboard focus.</li>
66            <li>com::sun::star::accessibility::AccessibleStateType::SHOWING
67                is set if the object is displayed on the screen.</li>
68            <li>com::sun::star::accessibility::AccessibleStateType::VISIBLE
69                is always set.</li>
70            </ul>
71            </li>
72        </ul>
73     */
74    interface ::com::sun::star::accessibility::XAccessibleContext;
75
76    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
77
78    interface ::com::sun::star::accessibility::XAccessibleComponent;
79
80    interface ::com::sun::star::accessibility::XAccessibleExtendedComponent;
81
82    /** This interface gives read-only access to the text representation
83        of a check box.
84     */
85    interface ::com::sun::star::accessibility::XAccessibleText;
86
87    /** This interface gives access to the actions that can be executed for
88        a check box. The supported actions for a check box are:
89        <ul>
90        <li>click</li>
91        </ul>
92     */
93    interface ::com::sun::star::accessibility::XAccessibleAction;
94
95    /** This interface gives access to the numerical value of a
96        check box, which is related to the check box state:
97
98        <pre>
99        0: not checked
100        1: checked
101        2: don't know
102        </pre>
103     */
104    interface ::com::sun::star::accessibility::XAccessibleValue;
105};
106
107}; }; }; };
108
109#endif
110
111/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
112