xref: /AOO41X/main/offapi/com/sun/star/text/XTextDocument.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_XTextDocument_idl__
24#define __com_sun_star_text_XTextDocument_idl__
25
26#ifndef __com_sun_star_frame_XModel_idl__
27#include <com/sun/star/frame/XModel.idl>
28#endif
29
30#ifndef __com_sun_star_text_XText_idl__
31#include <com/sun/star/text/XText.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module text {
38
39//=============================================================================
40
41// DocMerge from xml: interface com::sun::star::text::XTextDocument
42/** is the main interface of a text document.@see com::sun::star::text::TextDocument
43 */
44published interface XTextDocument: com::sun::star::frame::XModel
45{
46    //-------------------------------------------------------------------------
47
48    // DocMerge from idl: method com::sun::star::text::XTextDocument::getText
49    /** @returns
50                the major <type scope="com::sun::star::text">Text</type> of the text document.
51
52                <p>This text does not contain texts in <type>TextFrame</type>s,
53                or cells of <type>TextTable</type>s etc. directly. These are
54                accessible from the contents via <code>X...Supplier</code>
55                (e.g. <type>XTextTablesSupplier</type>).
56     */
57    com::sun::star::text::XText getText();
58
59    //-------------------------------------------------------------------------
60
61    // DocMerge from xml: method com::sun::star::text::XTextDocument::reformat
62    /** reformats the contents of the document.
63     */
64    void reformat();
65
66};
67
68//=============================================================================
69
70}; }; }; };
71
72#endif
73