xref: /AOO41X/main/offapi/com/sun/star/text/AdvancedTextDocument.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_AdvancedTextDocument_idl__
28#define __com_sun_star_text_AdvancedTextDocument_idl__
29
30#ifndef __com_sun_star_lang_Locale_idl__
31#include <com/sun/star/lang/Locale.idl>
32#endif
33
34#ifndef __com_sun_star_text_HypertextDocument_idl__
35#include <com/sun/star/text/HypertextDocument.idl>
36#endif
37
38#ifndef __com_sun_star_text_XFootnotesSupplier_idl__
39#include <com/sun/star/text/XFootnotesSupplier.idl>
40#endif
41
42#ifndef __com_sun_star_text_XEndnotesSupplier_idl__
43#include <com/sun/star/text/XEndnotesSupplier.idl>
44#endif
45
46#ifndef __com_sun_star_util_XReplaceable_idl__
47#include <com/sun/star/util/XReplaceable.idl>
48#endif
49
50#ifndef __com_sun_star_text_XPagePrintable_idl__
51#include <com/sun/star/text/XPagePrintable.idl>
52#endif
53
54#ifndef __com_sun_star_text_XReferenceMarksSupplier_idl__
55#include <com/sun/star/text/XReferenceMarksSupplier.idl>
56#endif
57
58#ifndef __com_sun_star_text_XLineNumberingSupplier_idl__
59#include <com/sun/star/text/XLineNumberingSupplier.idl>
60#endif
61
62#ifndef __com_sun_star_text_XChapterNumberingSupplier_idl__
63#include <com/sun/star/text/XChapterNumberingSupplier.idl>
64#endif
65
66#ifndef __com_sun_star_beans_XPropertySet_idl__
67#include <com/sun/star/beans/XPropertySet.idl>
68#endif
69
70
71//=============================================================================
72
73 module com {  module sun {  module star {  module text {
74
75//=============================================================================
76
77// DocMerge from xml: service com::sun::star::text::AdvancedTextDocument
78/** An advanced text document is an extension of a hypertext document
79	which can also contain text-frames, foot- and endnotes, and some
80	other advanced contents.
81
82	@deprecated
83		use <type>TextDocument</type> instead.
84 */
85published service AdvancedTextDocument
86{
87	// DocMerge: empty anyway
88	service com::sun::star::text::HypertextDocument;
89
90	// DocMerge: empty anyway
91	interface com::sun::star::text::XFootnotesSupplier;
92
93	// DocMerge: empty anyway
94	interface com::sun::star::text::XEndnotesSupplier;
95
96	// DocMerge: empty anyway
97	interface com::sun::star::util::XReplaceable;
98
99	// DocMerge: empty anyway
100	interface com::sun::star::text::XPagePrintable;
101
102	// DocMerge: empty anyway
103	interface com::sun::star::text::XReferenceMarksSupplier;
104
105	// DocMerge: empty anyway
106	interface com::sun::star::text::XLineNumberingSupplier;
107
108	// DocMerge: empty anyway
109	interface com::sun::star::text::XChapterNumberingSupplier;
110
111	// DocMerge: empty anyway
112	interface com::sun::star::beans::XPropertySet;
113
114	//-------------------------------------------------------------------------
115
116	// DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::CharLocale
117	/** contains the identifier of the default locale of the document.
118	 */
119	[property] com::sun::star::lang::Locale CharLocale;
120
121	//-------------------------------------------------------------------------
122
123	// DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::CharacterCount
124	/** contains the count of all characters in the document.
125	 */
126	[readonly, property] long CharacterCount;
127
128	//-------------------------------------------------------------------------
129
130	// DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::ParagraphCount
131	/** contains the count of all paragraphs in the document.
132	 */
133	[readonly, property] long ParagraphCount;
134
135	//-------------------------------------------------------------------------
136
137	// DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::WordCount
138	/** contains the count of all words in the document.@see WordSeparator
139	 */
140	[readonly, property] long WordCount;
141
142	//-------------------------------------------------------------------------
143
144	// DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::WordSeparator
145	/** contains a string that consists of characters that mark the
146		separation of words in counting the words in a document.
147
148
149
150		<p> I.e., slash and backslash. Whitespaces (tab stop,
151		space, paragraph break, or line break) always separate
152		words.</p>@see WordCount
153	 */
154	[property] string WordSeparator;
155
156};
157
158//=============================================================================
159
160}; }; }; };
161
162#endif
163