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