1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_office_XAnnotation_idl__ 29#define __com_sun_star_office_XAnnotation_idl__ 30 31#ifndef __com_sun_star_beans_XPropertySet_idl__ 32#include <com/sun/star/beans/XPropertySet.idl> 33#endif 34 35#ifndef __com_sun_star_beans_XMultiPropertySet_idl__ 36#include <com/sun/star/beans/XMultiPropertySet.idl> 37#endif 38 39#ifndef __com_sun_star_util_DateTime_idl__ 40#include <com/sun/star/util/DateTime.idl> 41#endif 42 43#ifndef __com_sun_star_text_XText_idl__ 44#include <com/sun/star/text/XText.idl> 45#endif 46 47#ifndef __com_sun_star_geometry_RealPoint2D_idl__ 48#include <com/sun/star/geometry/RealPoint2D.idl> 49#endif 50 51#ifndef __com_sun_star_geometry_RealSize2D_idl__ 52#include <com/sun/star/geometry/RealSize2D.idl> 53#endif 54 55#ifndef __com_sun_star_lang_XComponent_idl__ 56#include <com/sun/star/lang/XComponent.idl> 57#endif 58 59//============================================================================= 60 61module com { module sun { module star { module office { 62 63//============================================================================= 64 65/** This interface gives access to an annotation inside a document. 66 */ 67interface XAnnotation 68{ 69 /** All attributes are also available as properties. */ 70 interface ::com::sun::star::beans::XPropertySet; 71 72 /** manages the lifetime of this annotation, should only be used 73 by the owner of the annotation which should be the document itself. */ 74 interface ::com::sun::star::lang::XComponent; 75 76 /** a reference to the document content this annotation is anchored to. */ 77 [attribute, readonly] any Anchor; 78 79 /** this is an optional position that gives the user interface a hint where 80 the annotation should be rendered. This could be an offset to the 81 annotations anchor. */ 82 [attribute] ::com::sun::star::geometry::RealPoint2D Position; 83 84 /** this is an optional size that gives the user interface a hint how 85 large the annotation should be rendered. */ 86 [attribute] ::com::sun::star::geometry::RealSize2D Size; 87 88 /** stores the full name of the author who created this annotation. */ 89 [attribute] string Author; 90 91 /** stores the date and time this annotation was last edited. */ 92 [attribute] ::com::sun::star::util::DateTime DateTime; 93 94 /** gives access to the annotations text. */ 95 [attribute, readonly] ::com::sun::star::text::XText TextRange; 96}; 97 98//============================================================================= 99 100}; }; }; }; 101 102#endif 103