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
24#ifndef __com_sun_star_office_XAnnotation_idl__
25#define __com_sun_star_office_XAnnotation_idl__
26
27#ifndef __com_sun_star_beans_XPropertySet_idl__
28#include <com/sun/star/beans/XPropertySet.idl>
29#endif
30
31#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
32#include <com/sun/star/beans/XMultiPropertySet.idl>
33#endif
34
35#ifndef __com_sun_star_util_DateTime_idl__
36#include <com/sun/star/util/DateTime.idl>
37#endif
38
39#ifndef __com_sun_star_text_XText_idl__
40#include <com/sun/star/text/XText.idl>
41#endif
42
43#ifndef __com_sun_star_geometry_RealPoint2D_idl__
44#include <com/sun/star/geometry/RealPoint2D.idl>
45#endif
46
47#ifndef __com_sun_star_geometry_RealSize2D_idl__
48#include <com/sun/star/geometry/RealSize2D.idl>
49#endif
50
51#ifndef __com_sun_star_lang_XComponent_idl__
52#include <com/sun/star/lang/XComponent.idl>
53#endif
54
55//=============================================================================
56
57module com {  module sun {  module star {  module office {
58
59//=============================================================================
60
61/** This interface gives access to an annotation inside a document.
62 */
63interface XAnnotation
64{
65    /** All attributes are also available as properties. */
66    interface ::com::sun::star::beans::XPropertySet;
67
68    /** manages the lifetime of this annotation, should only be used
69        by the owner of the annotation which should be the document itself. */
70	interface ::com::sun::star::lang::XComponent;
71
72    /** a reference to the document content this annotation is anchored to. */
73    [attribute, readonly] any Anchor;
74
75    /** this is an optional position that gives the user interface a hint where
76        the annotation should be rendered. This could be an offset to the
77        annotations anchor. */
78    [attribute] ::com::sun::star::geometry::RealPoint2D Position;
79
80    /** this is an optional size that gives the user interface a hint how
81        large the annotation should be rendered. */
82    [attribute] ::com::sun::star::geometry::RealSize2D Size;
83
84    /** stores the full name of the author who created this annotation. */
85    [attribute] string Author;
86
87    /** stores the date and time this annotation was last edited. */
88    [attribute] ::com::sun::star::util::DateTime DateTime;
89
90    /** gives access to the annotations text. */
91	[attribute, readonly] ::com::sun::star::text::XText TextRange;
92};
93
94//=============================================================================
95
96}; }; }; };
97
98#endif
99