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_RedlinePortion_idl__
24#define __com_sun_star_text_RedlinePortion_idl__
25
26#ifndef __com_sun_star_text_TextPortion_idl__
27#include <com/sun/star/text/TextPortion.idl>
28#endif
29#ifndef __com_sun_star_beans_PropertyValues_idl__
30#include <com/sun/star/beans/PropertyValues.idl>
31#endif
32#ifndef __com_sun_star_util_DateTime_idl__
33#include <com/sun/star/util/DateTime.idl>
34#endif
35
36//=============================================================================
37
38module com { module sun { module star { module text {
39
40//=============================================================================
41/** A RedlinePortion is a TextPortion that marks a change that has been recorded by
42the change tracking.
43
44*/
45published service RedlinePortion
46{
47    service com::sun::star::text::TextPortion;
48    /** contains the name of the author of the change.*/
49    [readonly, property] string RedlineAuthor;
50    /** contains the date and time of the change.*/
51    [readonly, property] com::sun::star::util::DateTime RedlineDateTime;
52    /** contains a comment for the change.*/
53    [readonly, property] string RedlineComment;
54    /** contains the type of the change
55    <p> Valid type names are:</p>
56	<UL>
57        <LI><P>Insert - marks an insertion</P>
58        <LI><P>Delete - marks an deletion</P>
59        <LI><P>Format - marks an attribute change</P>
60        <LI><P>TextTable - marks a text table</P>
61        <LI><P>Style - marks an applied style</P>
62    </UL>
63     */
64    [readonly, property] string RedlineType;
65    /** contains the data of a second level redline data
66        <p> The elements of the sequence are:</p>
67        <UL>
68            <LI><P>string RedlineAuthor;                              </P>
69            <LI><P>com::sun::star::util::DateTime RedlineDateTime;    </P>
70            <LI><P>string RedlineComment;                             </P>
71            <LI><P>string RedlineType;                                </P>
72        </UL>
73     */
74    [readonly, property] com::sun::star::beans::PropertyValues RedlineSuccessorData;
75    /** contains a unique identifier for the redline.
76     This is necessary for file export filters to able to recognize redline portions
77        that point to the same redline.*/
78    [readonly, property] string RedlineIdentifier;
79    /** determines whether the portion is member of a header or footer text.*/
80    [readonly, property] boolean IsInHeaderFooter;
81    /** provides access to the text of the redline. This interface is only provided
82     if the change is not visible. The visibility depends on the redline display options that
83     are set at the documents property set (RedlineDisplayType).*/
84    [readonly, property] com::sun::star::text::XText RedlineText;
85    /** determines whether the last paragraph of a redline text has to be merged with a
86     possible following text content (i.e. a text table)*/
87    [readonly, property] boolean MergeLastPara;
88};
89
90//=============================================================================
91
92}; }; }; };
93#endif
94
95