offapi/com/sun/star/text/XRedline.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_XRedline_idl__
  20 #define __com_sun_star_text_XRedline_idl__
  21
  22 #include <com/sun/star/beans/PropertyValues.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24
  25
  26  module com {  module sun {  module star {  module text {
  27
  28
  29 /** enables creation of redlines (change tracking).
  30  */
  31 published interface XRedline
  32 {
  33
  34         /**
  35                 @param RedlineType
  36                 <p> Valid type names are:</p>
  37                     <UL>
  38                     <LI><P>Insert - marks an insertion</P>
  39                     <LI><P>Delete - marks an deletion</P>
  40                     <LI><P>Format - marks an attribute change</P>
  41                     <LI><P>TextTable - marks a text table</P>
  42                     <LI><P>Style - marks an applied style</P>
  43                 </UL>
  44                 @param RedlineProperties
  45                         contains the following parameters
  46                 [readonly, property] string RedlineAuthor;
  47                 [readonly, property] com::sun::star::util::DateTime RedlineDateTime;
  48                 [readonly, property] string RedlineComment;
  49         */
  50         void makeRedline( [in]string RedlineType, [in] com::sun::star::beans::PropertyValues  RedlineProperties)
  51                         raises( com::sun::star::lang::IllegalArgumentException );
  52 };
  53
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */