xref: /aoo42x/main/offapi/com/sun/star/text/Text.idl (revision ebe15e47)
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_Text_idl__
24#define __com_sun_star_text_Text_idl__
25
26#ifndef __com_sun_star_container_XEnumerationAccess_idl__
27#include <com/sun/star/container/XEnumerationAccess.idl>
28#endif
29#ifndef __com_sun_star_beans_XPropertySet_idl__
30#include <com/sun/star/beans/XPropertySet.idl>
31#endif
32#ifndef __com_sun_star_beans_PropertyValues_idl__
33#include <com/sun/star/beans/PropertyValues.idl>
34#endif
35
36
37//=============================================================================
38
39 module com {  module sun {  module star {  module text {
40
41 published interface XText;
42 published interface XTextRangeMover;
43 published interface XTextRangeCompare;
44 published interface XRelativeTextContentInsert;
45//=============================================================================
46
47/** is an independent piece of text which consists of a
48	series of one or more paragraphs.
49
50	<p>This service is used, for example, for the text of a TextDocument
51	or the text in a cell or TextFrame.
52
53	@see com::sun::star::text::TextDocument
54	@see com::sun::star::text::TextFrame
55	@see com::sun::star::table::Cell
56 */
57published service Text
58{
59	/** This is the factory for an enumeration of the paragraphs in this text.
60
61		<p>This interface is mainly useful for exporting the text to a
62		data format.
63	 */
64	interface com::sun::star::container::XEnumerationAccess;
65
66//=============================================================================
67
68	/** provides a cursor factory and the possibility to insert and remove contents.
69	 */
70	interface XText;
71
72//=============================================================================
73
74	/** optional interface to compare positions of <type>TextRange</type>
75				instances within this text.
76	 */
77	[optional] interface XTextRangeCompare;
78
79//=============================================================================
80
81	/** makes it possible to change the position of paragraphs.
82
83	 */
84	[optional] interface XTextRangeMover;
85
86//=============================================================================
87
88	/** makes it possible to insert a new text content, before or
89			   	after existing text contents.
90
91		   		@deprecated hack
92	 */
93	[optional] interface XRelativeTextContentInsert;
94
95//=============================================================================
96
97    /** contains the properties of a redline at the start of the document.<br>
98    The sequence contains the following properties
99    <UL>
100        <LI><P>string RedlineAuthor        </P></LI>
101        <LI><P>com::sun::star::util::DateTime RedlineDate_Time     </P></LI>
102        <LI><P>string RedlineComment       </P></LI>
103        <LI><P>string RedlineType          </P></LI>
104        <LI><P>string RedlineIdentifier    </P></LI>
105        <LI><P>boolean IsCollapsed          </P></LI>
106        <LI><P>boolean IsStart              </P></LI>
107        <LI><P>boolean MergeLastPara        </P></LI>
108        <LI><P>[maybevoid] com::sun::star::text::XText RedlineText  (maybevoid)</P></LI>
109        <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData
110            (contains the same properties except for the RedlineSuccessorData</P></LI>
111    </UL>
112     @see EndRedline
113     */
114    [optional, property] ::com::sun::star::beans::PropertyValues StartRedline;
115
116//=============================================================================
117
118    /** contains the properties of a redline at the start of the document.
119    The sequence contains the following properties
120    <UL>
121        <LI><P>string RedlineAuthor        </P></LI>
122        <LI><P>com::sun::star::util::DateTime RedlineDate_Time     </P></LI>
123        <LI><P>string RedlineComment       </P></LI>
124        <LI><P>string RedlineType          </P></LI>
125        <LI><P>string RedlineIdentifier    </P></LI>
126        <LI><P>boolean IsCollapsed          </P></LI>
127        <LI><P>boolean IsStart              </P></LI>
128        <LI><P>boolean MergeLastPara        </P></LI>
129        <LI><P>[maybevoid] com::sun::star::text::XText RedlineText  (maybevoid)</P></LI>
130        <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData
131            (contains the same properties except for the RedlineSuccessorData</P></LI>
132    </UL>
133     @see StartRedline
134     */
135    [optional, maybevoid, property] ::com::sun::star::beans::PropertyValues EndRedline;
136
137//=============================================================================
138
139};
140
141//=============================================================================
142
143}; }; }; };
144
145#endif
146