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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_office_XAnnotation_idl__
  21 #define __com_sun_star_office_XAnnotation_idl__
  22
  23 #include <com/sun/star/beans/XPropertySet.idl>
  24 #include <com/sun/star/beans/XMultiPropertySet.idl>
  25 #include <com/sun/star/util/DateTime.idl>
  26 #include <com/sun/star/text/XText.idl>
  27 #include <com/sun/star/geometry/RealPoint2D.idl>
  28 #include <com/sun/star/geometry/RealSize2D.idl>
  29 #include <com/sun/star/lang/XComponent.idl>
  30
  31
  32 module com {  module sun {  module star {  module office {
  33
  34
  35 /** This interface gives access to an annotation inside a document.
  36  */
  37 interface XAnnotation
  38 {
  39     /** All attributes are also available as properties. */
  40     interface ::com::sun::star::beans::XPropertySet;
  41
  42     /** manages the lifetime of this annotation, should only be used
  43         by the owner of the annotation which should be the document itself. */
  44     interface ::com::sun::star::lang::XComponent;
  45
  46     /** a reference to the document content this annotation is anchored to. */
  47     [attribute, readonly] any Anchor;
  48
  49     /** this is an optional position that gives the user interface a hint where
  50         the annotation should be rendered. This could be an offset to the
  51         annotations anchor. */
  52     [attribute] ::com::sun::star::geometry::RealPoint2D Position;
  53
  54     /** this is an optional size that gives the user interface a hint how
  55         large the annotation should be rendered. */
  56     [attribute] ::com::sun::star::geometry::RealSize2D Size;
  57
  58     /** stores the full name of the author who created this annotation. */
  59     [attribute] string Author;
  60
  61     /** stores the initials of the author who created this annotation. */
  62     [attribute] string Initials;
  63
  64     /** stores the date and time this annotation was last edited. */
  65     [attribute] ::com::sun::star::util::DateTime DateTime;
  66
  67     /** gives access to the annotations text. */
  68     [attribute, readonly] ::com::sun::star::text::XText TextRange;
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */