summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/AccessibleTextEmbeddedObject.idl
blob: bf455397f7fb9d6b54f5f2af92438830d3c41c12 (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
100
101
102
103
104
105
106
/* -*- 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_text_AccessibleTextEmbeddedObject_idl__
#define __com_sun_star_text_AccessibleTextEmbeddedObject_idl__

#include <com/sun/star/accessibility/XAccessibleContext.idl>
#include <com/sun/star/accessibility/XAccessibleComponent.idl>
#include <com/sun/star/accessibility/XAccessibleImage.idl>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.idl>




module com {  module sun {  module star {  module text {


/** The accessible view of an inactive embedded object. If an embedded
    object gets active, the active document gets an accessible object
    tree of its own. This tree is not a subtree of the object that supports
    this service but of the document service itself. The tree exist only
    until the object is deactivated.

     @since OOo 1.1.2
 */
service AccessibleTextEmbeddedObject
{
    /** This interface comprises the basic accessibility of embedded objects.

        <ul>
            <li>The parent returned by
                ::com::sun::star::accessibility::XAccessibleContext::getAccessibleParent()
                is the accessible view of a paragraph if the embedded object is
                bound as character, and the accessible view of the document
                (or of a page in the page preview) in any other case.
            <li>There are no children returned by
                ::com::sun::star::accessibility::XAccessibleContext::getAccessibleChild()
                . See above.
            <li>The role is
                ::com::sun::star::accessibility::AccessibleRole::EMBEDDED_OBJECT
            <li>The name is the one assigned to the object in the text
                document. This means that it is not internationalized.
            <li>The description is the one assigned to the object in the text
                document. This means that it is not internationalized. If no
                description has been set, the description equals the name.
            <li>There are no relations.
            <li>The following states might be contained in the state set
                returned by
                ::com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet():
                <ul>
                    <li>::com::sun::star::accessibility::AccessibleStateType::DEFUNC
                        (indicates that
                        the document window has been closed or the graphic
                        is not existing any longer)
                    <li>::com::sun::star::accessibility::AccessibleStateType::EDITABLE
                    <li>::com::sun::star::accessibility::AccessibleStateType::ENABLED
                        (always contained)
                    <li>::com::sun::star::accessibility::AccessibleStateType::OPAQUE
                    <li>::com::sun::star::accessibility::AccessibleStateType::SELECTABLE
                    <li>::com::sun::star::accessibility::AccessibleStateType::SELECTED
                    <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSABLE
                    <li>::com::sun::star::accessibility::AccessibleStateType::FOCUSED
                    <li>::com::sun::star::accessibility::AccessibleStateType::SHOWING
                    <li>::com::sun::star::accessibility::AccessibleStateType::VISIBLE
                </ul>
            <li>The locale is the one the text document itself.
        </ul>

    */
    interface ::com::sun::star::accessibility::XAccessibleContext;

    /** This interface describes the graphical representation of an
          embedded object.
    */
    interface ::com::sun::star::accessibility::XAccessibleComponent;

    /** This interface gives access to the object's size and its description.
    */
    interface ::com::sun::star::accessibility::XAccessibleImage;

    /** This is the interface for listeners
    */
    interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster;
};


}; }; }; };

#endif

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