LibreOffice LibreOffice 5.3 SDK API Reference

GenericTextDocument.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19 #ifndef __com_sun_star_text_GenericTextDocument_idl__
20 #define __com_sun_star_text_GenericTextDocument_idl__
21
22 #include <com/sun/star/document/OfficeDocument.idl>
23 #include <com/sun/star/text/XTextDocument.idl>
24 #include <com/sun/star/util/XSearchable.idl>
25 #include <com/sun/star/util/XRefreshable.idl>
26 #include <com/sun/star/tiledrendering/XTiledRenderable.idl>
27 #include <com/sun/star/text/XFootnotesSupplier.idl>
28 #include <com/sun/star/text/XEndnotesSupplier.idl>
29 #include <com/sun/star/util/XReplaceable.idl>
30 #include <com/sun/star/text/XPagePrintable.idl>
31 #include <com/sun/star/text/XReferenceMarksSupplier.idl>
32 #include <com/sun/star/text/XChapterNumberingSupplier.idl>
33 #include <com/sun/star/text/XTextGraphicObjectsSupplier.idl>
34 #include <com/sun/star/text/XTextEmbeddedObjectsSupplier.idl>
35 #include <com/sun/star/text/XTextTablesSupplier.idl>
36 #include <com/sun/star/style/XStyleFamiliesSupplier.idl>
37 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
38 #include <com/sun/star/text/XBookmarksSupplier.idl>
39 #include <com/sun/star/text/XDocumentIndexesSupplier.idl>
40 #include <com/sun/star/text/XTextFieldsSupplier.idl>
41 #include <com/sun/star/text/XTextFramesSupplier.idl>
42 #include <com/sun/star/text/XTextSectionsSupplier.idl>
43 #include <com/sun/star/lang/XMultiServiceFactory.idl>
44 #include <com/sun/star/lang/Locale.idl>
45
46
47 module com { module sun { module star { module text {
48
49
61 published service GenericTextDocument
62 {
63 service com::sun::star::document::OfficeDocument;
64
72 interface com::sun::star::lang::XMultiServiceFactory;
73
74 interface com::sun::star::text::XTextDocument;
75
76 interface com::sun::star::util::XSearchable;
77
78 interface com::sun::star::util::XRefreshable;
79
81 [optional] interface com::sun::star::tiledrendering::XTiledRenderable;
82
83 [optional] interface com::sun::star::text::XFootnotesSupplier;
84
85 [optional] interface com::sun::star::text::XEndnotesSupplier;
86
87 [optional] interface com::sun::star::util::XReplaceable;
88
89 [optional] interface com::sun::star::text::XPagePrintable;
90
91 [optional] interface com::sun::star::text::XReferenceMarksSupplier;
92
93 [optional] interface com::sun::star::text::XChapterNumberingSupplier;
94
95 [optional] interface com::sun::star::beans::XPropertySet;
96
97 [optional] interface com::sun::star::text::XTextGraphicObjectsSupplier;
98
99 [optional] interface com::sun::star::text::XTextEmbeddedObjectsSupplier;
100
101 [optional] interface com::sun::star::text::XTextTablesSupplier;
102
103 [optional] interface com::sun::star::style::XStyleFamiliesSupplier;
104
107 [optional] interface com::sun::star::text::XBookmarksSupplier;
108
111 [optional] interface com::sun::star::text::XDocumentIndexesSupplier;
112
115 [optional] interface com::sun::star::text::XTextFieldsSupplier;
116
119 [optional] interface com::sun::star::text::XTextFramesSupplier;
120
123 [optional] interface com::sun::star::text::XTextSectionsSupplier;
124
127 [optional] interface com::sun::star::util::XNumberFormatsSupplier;
128
131 [optional, property] com::sun::star::lang::Locale CharLocale;
132
133
136 [optional, readonly, property] long CharacterCount;
137
138
139
142 [optional, readonly, property] long ParagraphCount;
143
144
147 [optional, readonly, property] long WordCount;
148
149
159 [optional, property] string WordSeparator;
160
169 [optional, property] string IndexAutoMarkFileURL;
170
175 [optional, property] boolean RecordChanges;
176
187 [optional, property] short TwoDigitYear;
188 };
189
190
191 }; }; }; };
192
193 #endif
194
195 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::style::XStyleFamiliesSupplier
This interface provides access to the style families within the container document.
Definition: XStyleFamiliesSupplier.idl:33
XEndnotesSupplier.idl
XPagePrintable.idl
XStyleFamiliesSupplier.idl
com::sun::star::text::XDocumentIndexesSupplier
gives access to the collection of document indexes.
Definition: XDocumentIndexesSupplier.idl:36
com::sun::star::lang::XMultiServiceFactory
Allows creating instances specified by a string name.
Definition: XMultiServiceFactory.idl:39
com::sun::star::text::XTextFramesSupplier
makes it possible to access the TextFrame instances in this context (e.g.
Definition: XTextFramesSupplier.idl:33
XReplaceable.idl
com::sun::star::text::GenericTextDocument::WordCount
long WordCount
contains the count of all words in the document.
Definition: GenericTextDocument.idl:147
XDocumentIndexesSupplier.idl
com::sun::star::text::XTextTablesSupplier
enables the object to handle text tables.
Definition: XTextTablesSupplier.idl:33
com::sun::star::util::XReplaceable
makes it possible to replace strings in a text described by a SearchDescriptor.
Definition: XReplaceable.idl:45
com::sun::star::text::XFootnotesSupplier
makes it possible to access the footnotes within the context (e.g.
Definition: XFootnotesSupplier.idl:35
XFootnotesSupplier.idl
com::sun::star::text::XTextEmbeddedObjectsSupplier
provides the collection of all embedded objects within this context (i.e.
Definition: XTextEmbeddedObjectsSupplier.idl:33
com
Definition: Ambiguous.idl:22
XTiledRenderable.idl
XNumberFormatsSupplier.idl
com::sun::star::text::XChapterNumberingSupplier
contains the settings of the chapter numbering in a text document.
Definition: XChapterNumberingSupplier.idl:33
com::sun::star::text::GenericTextDocument::WordSeparator
string WordSeparator
contains a string that consists of characters that mark the separation of words in counting the words...
Definition: GenericTextDocument.idl:159
OfficeDocument.idl
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:52
com::sun::star::text::XTextSectionsSupplier
manages the text sections within the context (i.e.
Definition: XTextSectionsSupplier.idl:32
XTextFramesSupplier.idl
com::sun::star::document::OfficeDocument
abstract service which specifies a storable and printable document
Definition: OfficeDocument.idl:48
XBookmarksSupplier.idl
com::sun::star::text::XPagePrintable
Print several pages on one printer page.
Definition: XPagePrintable.idl:33
XChapterNumberingSupplier.idl
com::sun::star::text::XBookmarksSupplier
provides access to the collection of all bookmarks within this text container.
Definition: XBookmarksSupplier.idl:32
com::sun::star::text::GenericTextDocument::CharacterCount
long CharacterCount
contains the count of all characters in the document.
Definition: GenericTextDocument.idl:136
com::sun::star::text::GenericTextDocument::RecordChanges
boolean RecordChanges
specifies if change recording is active.
Definition: GenericTextDocument.idl:175
Locale.idl
XSearchable.idl
com::sun::star::util::XNumberFormatsSupplier
supplies the collection of NumberFormats (for example, in a document) and the settings belonging to t...
Definition: XNumberFormatsSupplier.idl:36
XReferenceMarksSupplier.idl
com::sun::star::text::GenericTextDocument::TwoDigitYear
short TwoDigitYear
specifies the first 4 digit year to be used when years are given in 2 digits.
Definition: GenericTextDocument.idl:187
com::sun::star::text::GenericTextDocument
A text document is a model component which contains text structured by paragraphs.
Definition: GenericTextDocument.idl:61
XTextSectionsSupplier.idl
XTextEmbeddedObjectsSupplier.idl
com::sun::star::util::XRefreshable
is supported by objects with data that can be refreshed from a data source.
Definition: XRefreshable.idl:33
com::sun::star::text::XTextFieldsSupplier
makes it possible to access the text fields used in this context (e.g.
Definition: XTextFieldsSupplier.idl:34
com::sun::star::text::XReferenceMarksSupplier
provides access to the reference marks within this context (i.e.
Definition: XReferenceMarksSupplier.idl:39
XTextTablesSupplier.idl
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:63
XRefreshable.idl
XMultiServiceFactory.idl
com::sun::star::tiledrendering::XTiledRenderable
tiled rendering using a system-specific handle to a window
Definition: XTiledRenderable.idl:29
com::sun::star::text::XTextDocument
is the main interface of a text document.
Definition: XTextDocument.idl:32
com::sun::star::text::GenericTextDocument::ParagraphCount
long ParagraphCount
contains the count of all paragraphs in the document.
Definition: GenericTextDocument.idl:142
XTextDocument.idl
com::sun::star::text::GenericTextDocument::IndexAutoMarkFileURL
string IndexAutoMarkFileURL
specifies the concordance file taken into account when creating an index.
Definition: GenericTextDocument.idl:169
com::sun::star::util::XSearchable
enables the object to look for specified contents of the object (in particular, for a text range whic...
Definition: XSearchable.idl:53
com::sun::star::text::XEndnotesSupplier
makes it possible to access the endnotes within the context (e.g.
Definition: XEndnotesSupplier.idl:35
XTextFieldsSupplier.idl
XTextGraphicObjectsSupplier.idl
com::sun::star::text::XTextGraphicObjectsSupplier
provides access to the collection of all embedded and linked graphics within this context (i...
Definition: XTextGraphicObjectsSupplier.idl:33