xref: /trunk/main/offapi/com/sun/star/text/XRedline.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_XRedline_idl__
24#define __com_sun_star_text_XRedline_idl__
25
26#ifndef __com_sun_star_beans_PropertyValues_idl__
27#include <com/sun/star/beans/PropertyValues.idl>
28#endif
29#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
30#include <com/sun/star/lang/IllegalArgumentException.idl>
31#endif
32
33//=============================================================================
34
35 module com {  module sun {  module star {  module text {
36
37//=============================================================================
38
39/** enables creation of redlines (change tracking).
40 */
41published interface XRedline
42{
43	//-------------------------------------------------------------------------
44
45        /**
46                @param RedlineType
47                <p> Valid type names are:</p>
48                    <UL>
49                    <LI><P>Insert - marks an insertion</P>
50                    <LI><P>Delete - marks an deletion</P>
51                    <LI><P>Format - marks an attribute change</P>
52                    <LI><P>TextTable - marks a text table</P>
53                    <LI><P>Style - marks an applied style</P>
54                </UL>
55                @param RedlineProperties
56                        contains the following parameters
57                [readonly, property] string RedlineAuthor;
58                [readonly, property] com::sun::star::util::DateTime RedlineDateTime;
59                [readonly, property] string RedlineComment;
60        */
61        void makeRedline( [in]string RedlineType, [in] com::sun::star::beans::PropertyValues  RedlineProperties)
62                        raises( com::sun::star::lang::IllegalArgumentException );
63};
64
65//=============================================================================
66
67}; }; }; };
68
69#endif
70