offapi/com/sun/star/text/XRedline.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: XRedline.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 #ifndef __com_sun_star_text_XRedline_idl__
  31 #define __com_sun_star_text_XRedline_idl__
  32
  33 #ifndef __com_sun_star_beans_PropertyValues_idl__
  34 #include <com/sun/star/beans/PropertyValues.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  37 #include <com/sun/star/lang/IllegalArgumentException.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module text {
  43
  44 //=============================================================================
  45
  46 /** enables creation of redlines (change tracking).
  47  */
  48 published interface XRedline
  49 {
  50     //-------------------------------------------------------------------------
  51
  52         /**
  53                 @param RedlineType
  54                 <p> Valid type names are:</p>
  55                     <UL>
  56                     <LI><P>Insert - marks an insertion</P>
  57                     <LI><P>Delete - marks an deletion</P>
  58                     <LI><P>Format - marks an attribute change</P>
  59                     <LI><P>TextTable - marks a text table</P>
  60                     <LI><P>Style - marks an applied style</P>
  61                 </UL>
  62                 @param RedlineProperties
  63                         contains the following parameters
  64                 [readonly, property] string RedlineAuthor;
  65                 [readonly, property] com::sun::star::util::DateTime RedlineDateTime;
  66                 [readonly, property] string RedlineComment;
  67         */
  68         void makeRedline( [in]string RedlineType, [in] com::sun::star::beans::PropertyValues  RedlineProperties)
  69                         raises( com::sun::star::lang::IllegalArgumentException );
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif