offapi/com/sun/star/text/RedlinePortion.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 #ifndef __com_sun_star_text_RedlinePortion_idl__
  20 #define __com_sun_star_text_RedlinePortion_idl__
  21
  22 #include <com/sun/star/text/TextPortion.idl>
  23 #include <com/sun/star/beans/PropertyValues.idl>
  24 #include <com/sun/star/util/DateTime.idl>
  25
  26
  27 module com { module sun { module star { module text {
  28
  29 /** A RedlinePortion is a TextPortion that marks a change that has been recorded by
  30 the change tracking.
  31
  32 */
  33 published service RedlinePortion
  34 {
  35     service com::sun::star::text::TextPortion;
  36     /** contains the name of the author of the change.*/
  37     [readonly, property] string RedlineAuthor;
  38     /** contains the date and time of the change.*/
  39     [readonly, property] com::sun::star::util::DateTime RedlineDateTime;
  40     /** contains a comment for the change.*/
  41     [readonly, property] string RedlineComment;
  42     /** contains the type of the change
  43     <p> Valid type names are:</p>
  44     <UL>
  45         <LI><P>Insert - marks an insertion</P>
  46         <LI><P>Delete - marks an deletion</P>
  47         <LI><P>Format - marks an attribute change</P>
  48         <LI><P>TextTable - marks a text table</P>
  49         <LI><P>Style - marks an applied style</P>
  50     </UL>
  51      */
  52     [readonly, property] string RedlineType;
  53     /** contains the data of a second level redline data
  54         <p> The elements of the sequence are:</p>
  55         <UL>
  56             <LI><P>string RedlineAuthor;                              </P>
  57             <LI><P>com::sun::star::util::DateTime RedlineDateTime;    </P>
  58             <LI><P>string RedlineComment;                             </P>
  59             <LI><P>string RedlineType;                                </P>
  60         </UL>
  61      */
  62     [readonly, property] com::sun::star::beans::PropertyValues RedlineSuccessorData;
  63     /** contains a unique identifier for the redline.
  64      This is necessary for file export filters to able to recognize redline portions
  65         that point to the same redline.*/
  66     [readonly, property] string RedlineIdentifier;
  67     /** determines whether the portion is member of a header or footer text.*/
  68     [readonly, property] boolean IsInHeaderFooter;
  69     /** provides access to the text of the redline. This interface is only provided
  70      if the change is not visible. The visibility depends on the redline display options that
  71      are set at the documents property set (RedlineDisplayType).*/
  72     [readonly, property] com::sun::star::text::XText RedlineText;
  73     /** determines whether the last paragraph of a redline text has to be merged with a
  74      possible following text content (i.e. a text table)*/
  75     [readonly, property] boolean MergeLastPara;
  76 };
  77
  78
  79 }; }; }; };
  80 #endif
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */