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