xref: /aoo42x/main/offapi/com/sun/star/text/Text.idl (revision ebe15e47)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_Text_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_Text_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_container_XEnumerationAccess_idl__
27cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__
30cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl>
31cdf0e10cSrcweir#endif
32cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyValues_idl__
33cdf0e10cSrcweir#include <com/sun/star/beans/PropertyValues.idl>
34cdf0e10cSrcweir#endif
35cdf0e10cSrcweir
36cdf0e10cSrcweir
37cdf0e10cSrcweir//=============================================================================
38cdf0e10cSrcweir
39cdf0e10cSrcweir module com {  module sun {  module star {  module text {
40cdf0e10cSrcweir
41cdf0e10cSrcweir published interface XText;
42cdf0e10cSrcweir published interface XTextRangeMover;
43cdf0e10cSrcweir published interface XTextRangeCompare;
44cdf0e10cSrcweir published interface XRelativeTextContentInsert;
45cdf0e10cSrcweir//=============================================================================
46cdf0e10cSrcweir
47cdf0e10cSrcweir/** is an independent piece of text which consists of a
48cdf0e10cSrcweir	series of one or more paragraphs.
49cdf0e10cSrcweir
50cdf0e10cSrcweir	<p>This service is used, for example, for the text of a TextDocument
51cdf0e10cSrcweir	or the text in a cell or TextFrame.
52cdf0e10cSrcweir
53cdf0e10cSrcweir	@see com::sun::star::text::TextDocument
54cdf0e10cSrcweir	@see com::sun::star::text::TextFrame
55cdf0e10cSrcweir	@see com::sun::star::table::Cell
56cdf0e10cSrcweir */
57cdf0e10cSrcweirpublished service Text
58cdf0e10cSrcweir{
59cdf0e10cSrcweir	/** This is the factory for an enumeration of the paragraphs in this text.
60cdf0e10cSrcweir
61cdf0e10cSrcweir		<p>This interface is mainly useful for exporting the text to a
62cdf0e10cSrcweir		data format.
63cdf0e10cSrcweir	 */
64cdf0e10cSrcweir	interface com::sun::star::container::XEnumerationAccess;
65cdf0e10cSrcweir
66cdf0e10cSrcweir//=============================================================================
67cdf0e10cSrcweir
68cdf0e10cSrcweir	/** provides a cursor factory and the possibility to insert and remove contents.
69cdf0e10cSrcweir	 */
70cdf0e10cSrcweir	interface XText;
71cdf0e10cSrcweir
72cdf0e10cSrcweir//=============================================================================
73cdf0e10cSrcweir
74*ebe15e47SJohn Bampton	/** optional interface to compare positions of <type>TextRange</type>
75cdf0e10cSrcweir				instances within this text.
76cdf0e10cSrcweir	 */
77cdf0e10cSrcweir	[optional] interface XTextRangeCompare;
78cdf0e10cSrcweir
79cdf0e10cSrcweir//=============================================================================
80cdf0e10cSrcweir
81cdf0e10cSrcweir	/** makes it possible to change the position of paragraphs.
82cdf0e10cSrcweir
83cdf0e10cSrcweir	 */
84cdf0e10cSrcweir	[optional] interface XTextRangeMover;
85cdf0e10cSrcweir
86cdf0e10cSrcweir//=============================================================================
87cdf0e10cSrcweir
88cdf0e10cSrcweir	/** makes it possible to insert a new text content, before or
89cdf0e10cSrcweir			   	after existing text contents.
90cdf0e10cSrcweir
91cdf0e10cSrcweir		   		@deprecated hack
92cdf0e10cSrcweir	 */
93cdf0e10cSrcweir	[optional] interface XRelativeTextContentInsert;
94cdf0e10cSrcweir
95cdf0e10cSrcweir//=============================================================================
96cdf0e10cSrcweir
97cdf0e10cSrcweir    /** contains the properties of a redline at the start of the document.<br>
98cdf0e10cSrcweir    The sequence contains the following properties
99cdf0e10cSrcweir    <UL>
100cdf0e10cSrcweir        <LI><P>string RedlineAuthor        </P></LI>
101cdf0e10cSrcweir        <LI><P>com::sun::star::util::DateTime RedlineDate_Time     </P></LI>
102cdf0e10cSrcweir        <LI><P>string RedlineComment       </P></LI>
103cdf0e10cSrcweir        <LI><P>string RedlineType          </P></LI>
104cdf0e10cSrcweir        <LI><P>string RedlineIdentifier    </P></LI>
105cdf0e10cSrcweir        <LI><P>boolean IsCollapsed          </P></LI>
106cdf0e10cSrcweir        <LI><P>boolean IsStart              </P></LI>
107cdf0e10cSrcweir        <LI><P>boolean MergeLastPara        </P></LI>
108cdf0e10cSrcweir        <LI><P>[maybevoid] com::sun::star::text::XText RedlineText  (maybevoid)</P></LI>
109cdf0e10cSrcweir        <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData
110cdf0e10cSrcweir            (contains the same properties except for the RedlineSuccessorData</P></LI>
111cdf0e10cSrcweir    </UL>
112cdf0e10cSrcweir     @see EndRedline
113cdf0e10cSrcweir     */
114cdf0e10cSrcweir    [optional, property] ::com::sun::star::beans::PropertyValues StartRedline;
115cdf0e10cSrcweir
116cdf0e10cSrcweir//=============================================================================
117cdf0e10cSrcweir
118cdf0e10cSrcweir    /** contains the properties of a redline at the start of the document.
119cdf0e10cSrcweir    The sequence contains the following properties
120cdf0e10cSrcweir    <UL>
121cdf0e10cSrcweir        <LI><P>string RedlineAuthor        </P></LI>
122cdf0e10cSrcweir        <LI><P>com::sun::star::util::DateTime RedlineDate_Time     </P></LI>
123cdf0e10cSrcweir        <LI><P>string RedlineComment       </P></LI>
124cdf0e10cSrcweir        <LI><P>string RedlineType          </P></LI>
125cdf0e10cSrcweir        <LI><P>string RedlineIdentifier    </P></LI>
126cdf0e10cSrcweir        <LI><P>boolean IsCollapsed          </P></LI>
127cdf0e10cSrcweir        <LI><P>boolean IsStart              </P></LI>
128cdf0e10cSrcweir        <LI><P>boolean MergeLastPara        </P></LI>
129cdf0e10cSrcweir        <LI><P>[maybevoid] com::sun::star::text::XText RedlineText  (maybevoid)</P></LI>
130cdf0e10cSrcweir        <LI><P>com::sun::star::beans::PropertyValues RedlineSuccessorData
131cdf0e10cSrcweir            (contains the same properties except for the RedlineSuccessorData</P></LI>
132cdf0e10cSrcweir    </UL>
133cdf0e10cSrcweir     @see StartRedline
134cdf0e10cSrcweir     */
135cdf0e10cSrcweir    [optional, maybevoid, property] ::com::sun::star::beans::PropertyValues EndRedline;
136cdf0e10cSrcweir
137cdf0e10cSrcweir//=============================================================================
138cdf0e10cSrcweir
139cdf0e10cSrcweir};
140cdf0e10cSrcweir
141cdf0e10cSrcweir//=============================================================================
142cdf0e10cSrcweir
143cdf0e10cSrcweir}; }; }; };
144cdf0e10cSrcweir
145cdf0e10cSrcweir#endif
146