summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/office/XAnnotation.idl
blob: a5d669676a2e8b33f0d4bda37b1c2210971df091 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_office_XAnnotation_idl__
#define __com_sun_star_office_XAnnotation_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
#include <com/sun/star/beans/XMultiPropertySet.idl>
#endif

#ifndef __com_sun_star_util_DateTime_idl__ 
#include <com/sun/star/util/DateTime.idl>
#endif

#ifndef __com_sun_star_text_XText_idl__
#include <com/sun/star/text/XText.idl>
#endif

#ifndef __com_sun_star_geometry_RealPoint2D_idl__
#include <com/sun/star/geometry/RealPoint2D.idl>
#endif

#ifndef __com_sun_star_geometry_RealSize2D_idl__
#include <com/sun/star/geometry/RealSize2D.idl>
#endif

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module office {

//=============================================================================

/** This interface gives access to an annotation inside a document.
 */
interface XAnnotation
{
    /** All attributes are also available as properties. */
    interface ::com::sun::star::beans::XPropertySet;

    /** manages the lifetime of this annotation, should only be used
        by the owner of the annotation which should be the document itself. */
    interface ::com::sun::star::lang::XComponent;

    /** a reference to the document content this annotation is anchored to. */
    [attribute, readonly] any Anchor;
    
    /** this is an optional position that gives the user interface a hint where
        the annotation should be rendered. This could be an offset to the
        annotations anchor. */
    [attribute] ::com::sun::star::geometry::RealPoint2D Position;

    /** this is an optional size that gives the user interface a hint how
        large the annotation should be rendered. */
    [attribute] ::com::sun::star::geometry::RealSize2D Size;

    /** stores the full name of the author who created this annotation. */
    [attribute] string Author;

    /** stores the date and time this annotation was last edited. */
    [attribute] ::com::sun::star::util::DateTime DateTime;

    /** gives access to the annotations text. */
    [attribute, readonly] ::com::sun::star::text::XText TextRange;
};

//=============================================================================

}; }; }; };

#endif