xref: /AOO41X/main/offapi/com/sun/star/drawing/AccessibleImageBullet.idl (revision 96af39f745f380c70aec9fab3a79dc8b37f680ac)
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#ifndef __com_sun_star_drawing_AccessibleImageBullet_idl__
24#define __com_sun_star_drawing_AccessibleImageBullet_idl__
25
26#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
27#include <com/sun/star/accessibility/XAccessibleContext.idl>
28#endif
29
30#ifndef __com_sun_star_accessibility_XAccessibleComponent_idl__
31#include <com/sun/star/accessibility/XAccessibleComponent.idl>
32#endif
33
34#ifndef __com_sun_star_accessibility_XAccessibleEditableText_idl__
35#include <com/sun/star/accessibility/XAccessibleEditableText.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module drawing {
42
43//=============================================================================
44
45/** The accessible view of an image bullet.
46
47     @since OpenOffice 1.1.2
48 */
49service AccessibleImageBullet
50{
51    /** This interface gives access to an image bullet within a text
52        paragraph fragment that is at least partially visible on the
53        screen.
54
55        <ul>
56            <li>The parent returned by
57                <method scope="::com::sun::star::accessibility"
58                >XAccessibleContext::getAccessibleParent</method>
59                is the accessible object of a text paragraph.
60            <li>There are no children returned by
61                <method scope="::com::sun::star::accessibility"
62                >XAccessibleContext::getAccessibleChild</method>.
63            <li>The role is <const scope="::com::sun::star::accessibility"
64                >AccessibleRole::GRAPHIC</const>.
65            <li>The name is "image bullet" (or the equivalent term
66                in application's language).
67            <li>The description contains the term "image bullet" (or the equivalent
68                term in application's language) and the number of the paragraph
69                within this bullet appears.
70            <li>There are no relations.
71            <li>The following states are supported by the
72                <type scope="::com::sun::star::accessibility"
73                >XAccessibleStateSet</type> returned by
74                <method scope="::com::sun::star::accessibility"
75                >XAccessibleContext::getAccessibleStateSet</method>.
76                <ul>
77                    <li><const scope="::com::sun::star::accessibility"
78                        >AccessibleStateType::DEFUNC</const> (indicates that
79                        the document window has been closed or the image bullet
80                        is not existing any longer).
81                    <li><const scope="::com::sun::star::accessibility"
82                        >AccessibleStateType::ENABLED</const> (always
83                        contained)
84                    <li><const scope="::com::sun::star::accessibility"
85                        >AccessibleStateType::SHOWING</const>
86                    <li><const scope="::com::sun::star::accessibility"
87                        >AccessibleStateType::VISIBLE</const>
88                    <li><const scope="::com::sun::star::accessibility"
89                        >AccessibleStateType::INVALID</const>
90                </ul>
91        </ul>
92
93     */
94    interface ::com::sun::star::accessibility::XAccessibleContext;
95
96    /** This interface describes the graphical representation of an image
97        bullet.
98     */
99    interface ::com::sun::star::accessibility::XAccessibleComponent;
100
101};
102
103//=============================================================================
104
105}; }; }; };
106
107#endif
108