xref: /AOO41X/main/offapi/com/sun/star/text/AdvancedTextDocument.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_AdvancedTextDocument_idl__
24#define __com_sun_star_text_AdvancedTextDocument_idl__
25
26#ifndef __com_sun_star_lang_Locale_idl__
27#include <com/sun/star/lang/Locale.idl>
28#endif
29
30#ifndef __com_sun_star_text_HypertextDocument_idl__
31#include <com/sun/star/text/HypertextDocument.idl>
32#endif
33
34#ifndef __com_sun_star_text_XFootnotesSupplier_idl__
35#include <com/sun/star/text/XFootnotesSupplier.idl>
36#endif
37
38#ifndef __com_sun_star_text_XEndnotesSupplier_idl__
39#include <com/sun/star/text/XEndnotesSupplier.idl>
40#endif
41
42#ifndef __com_sun_star_util_XReplaceable_idl__
43#include <com/sun/star/util/XReplaceable.idl>
44#endif
45
46#ifndef __com_sun_star_text_XPagePrintable_idl__
47#include <com/sun/star/text/XPagePrintable.idl>
48#endif
49
50#ifndef __com_sun_star_text_XReferenceMarksSupplier_idl__
51#include <com/sun/star/text/XReferenceMarksSupplier.idl>
52#endif
53
54#ifndef __com_sun_star_text_XLineNumberingSupplier_idl__
55#include <com/sun/star/text/XLineNumberingSupplier.idl>
56#endif
57
58#ifndef __com_sun_star_text_XChapterNumberingSupplier_idl__
59#include <com/sun/star/text/XChapterNumberingSupplier.idl>
60#endif
61
62#ifndef __com_sun_star_beans_XPropertySet_idl__
63#include <com/sun/star/beans/XPropertySet.idl>
64#endif
65
66
67//=============================================================================
68
69 module com {  module sun {  module star {  module text {
70
71//=============================================================================
72
73// DocMerge from xml: service com::sun::star::text::AdvancedTextDocument
74/** An advanced text document is an extension of a hypertext document
75    which can also contain text-frames, foot- and endnotes, and some
76    other advanced contents.
77
78    @deprecated
79        use <type>TextDocument</type> instead.
80 */
81published service AdvancedTextDocument
82{
83    // DocMerge: empty anyway
84    service com::sun::star::text::HypertextDocument;
85
86    // DocMerge: empty anyway
87    interface com::sun::star::text::XFootnotesSupplier;
88
89    // DocMerge: empty anyway
90    interface com::sun::star::text::XEndnotesSupplier;
91
92    // DocMerge: empty anyway
93    interface com::sun::star::util::XReplaceable;
94
95    // DocMerge: empty anyway
96    interface com::sun::star::text::XPagePrintable;
97
98    // DocMerge: empty anyway
99    interface com::sun::star::text::XReferenceMarksSupplier;
100
101    // DocMerge: empty anyway
102    interface com::sun::star::text::XLineNumberingSupplier;
103
104    // DocMerge: empty anyway
105    interface com::sun::star::text::XChapterNumberingSupplier;
106
107    // DocMerge: empty anyway
108    interface com::sun::star::beans::XPropertySet;
109
110    //-------------------------------------------------------------------------
111
112    // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::CharLocale
113    /** contains the identifier of the default locale of the document.
114     */
115    [property] com::sun::star::lang::Locale CharLocale;
116
117    //-------------------------------------------------------------------------
118
119    // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::CharacterCount
120    /** contains the count of all characters in the document.
121     */
122    [readonly, property] long CharacterCount;
123
124    //-------------------------------------------------------------------------
125
126    // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::ParagraphCount
127    /** contains the count of all paragraphs in the document.
128     */
129    [readonly, property] long ParagraphCount;
130
131    //-------------------------------------------------------------------------
132
133    // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::WordCount
134    /** contains the count of all words in the document.@see WordSeparator
135     */
136    [readonly, property] long WordCount;
137
138    //-------------------------------------------------------------------------
139
140    // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::WordSeparator
141    /** contains a string that consists of characters that mark the
142        separation of words in counting the words in a document.
143
144
145
146        <p> I.e., slash and backslash. Whitespaces (tab stop,
147        space, paragraph break, or line break) always separate
148        words.</p>@see WordCount
149     */
150    [property] string WordSeparator;
151
152};
153
154//=============================================================================
155
156}; }; }; };
157
158#endif
159