offapi/com/sun/star/text/XRedline.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XRedline_idl__
  28 #define __com_sun_star_text_XRedline_idl__
  29
  30 #ifndef __com_sun_star_beans_PropertyValues_idl__
  31 #include <com/sun/star/beans/PropertyValues.idl>
  32 #endif
  33 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module text {
  40
  41 //=============================================================================
  42
  43 /** enables creation of redlines (change tracking).
  44  */
  45 published interface XRedline
  46 {
  47     //-------------------------------------------------------------------------
  48
  49         /**
  50                 @param RedlineType
  51                 <p> Valid type names are:</p>
  52                     <UL>
  53                     <LI><P>Insert - marks an insertion</P>
  54                     <LI><P>Delete - marks an deletion</P>
  55                     <LI><P>Format - marks an attribute change</P>
  56                     <LI><P>TextTable - marks a text table</P>
  57                     <LI><P>Style - marks an applied style</P>
  58                 </UL>
  59                 @param RedlineProperties
  60                         contains the following parameters
  61                 [readonly, property] string RedlineAuthor;
  62                 [readonly, property] com::sun::star::util::DateTime RedlineDateTime;
  63                 [readonly, property] string RedlineComment;
  64         */
  65         void makeRedline( [in]string RedlineType, [in] com::sun::star::beans::PropertyValues  RedlineProperties)
  66                         raises( com::sun::star::lang::IllegalArgumentException );
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif