offapi/com/sun/star/office/XAnnotation.idl

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