LibreOffice LibreOffice 26.2 SDK API Reference

Loading...
Searching...
No Matches
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
20
21 module com { module sun { module star { module text {
22
23
35published service GenericTextDocument
36{
37 service com::sun::star::document::OfficeDocument;
38
46 interface com::sun::star::lang::XMultiServiceFactory;
47
48 interface com::sun::star::text::XTextDocument;
49
50 interface com::sun::star::util::XSearchable;
51
52 interface com::sun::star::util::XRefreshable;
53
54 [optional] interface com::sun::star::text::XFootnotesSupplier;
55
56 [optional] interface com::sun::star::text::XEndnotesSupplier;
57
59 [optional] interface com::sun::star::text::XContentControlsSupplier;
60
61 [optional] interface com::sun::star::util::XReplaceable;
62
63 [optional] interface com::sun::star::text::XPagePrintable;
64
65 [optional] interface com::sun::star::text::XReferenceMarksSupplier;
66
67 [optional] interface com::sun::star::text::XChapterNumberingSupplier;
68
69 [optional] interface com::sun::star::beans::XPropertySet;
70
71 [optional] interface com::sun::star::text::XTextGraphicObjectsSupplier;
72
73 [optional] interface com::sun::star::text::XTextEmbeddedObjectsSupplier;
74
75 [optional] interface com::sun::star::text::XTextTablesSupplier;
76
77 [optional] interface com::sun::star::style::XStyleFamiliesSupplier;
78
81 [optional] interface com::sun::star::text::XBookmarksSupplier;
82
85 [optional] interface com::sun::star::text::XDocumentIndexesSupplier;
86
89 [optional] interface com::sun::star::text::XTextFieldsSupplier;
90
93 [optional] interface com::sun::star::text::XTextFramesSupplier;
94
97 [optional] interface com::sun::star::text::XTextSectionsSupplier;
98
101 [optional] interface com::sun::star::util::XNumberFormatsSupplier;
102
105 [optional, property] com::sun::star::lang::Locale CharLocale;
106
107
110 [optional, readonly, property] long CharacterCount;
111
112
113
116 [optional, readonly, property] long ParagraphCount;
117
118
121 [optional, readonly, property] long WordCount;
122
123
133 [optional, property] string WordSeparator;
134
143 [optional, property] string IndexAutoMarkFileURL;
144
149 [optional, property] boolean RecordChanges;
150
161 [optional, property] short TwoDigitYear;
162};
163
164
165}; }; }; };
166
167/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition XPropertySet.idl:46
com::sun::star::lang::XMultiServiceFactory
Allows creating instances specified by a string name.
Definition XMultiServiceFactory.idl:34
com::sun::star::style::XStyleFamiliesSupplier
This interface provides access to the style families within the container document.
Definition XStyleFamiliesSupplier.idl:28
com::sun::star::text::XBookmarksSupplier
provides access to the collection of all bookmarks within this text container.
Definition XBookmarksSupplier.idl:27
com::sun::star::text::XChapterNumberingSupplier
contains the settings of the chapter numbering in a text document.
Definition XChapterNumberingSupplier.idl:28
com::sun::star::text::XContentControlsSupplier
makes it possible to access the content controls within the context (e.g.
Definition XContentControlsSupplier.idl:28
com::sun::star::text::XDocumentIndexesSupplier
gives access to the collection of document indexes.
Definition XDocumentIndexesSupplier.idl:31
com::sun::star::text::XEndnotesSupplier
makes it possible to access the endnotes within the context (e.g.
Definition XEndnotesSupplier.idl:28
com::sun::star::text::XFootnotesSupplier
makes it possible to access the footnotes within the context (e.g.
Definition XFootnotesSupplier.idl:28
com::sun::star::text::XPagePrintable
Print several pages on one printer page.
Definition XPagePrintable.idl:28
com::sun::star::text::XReferenceMarksSupplier
provides access to the reference marks within this context (i.e.
Definition XReferenceMarksSupplier.idl:34
com::sun::star::text::XTextDocument
is the main interface of a text document.
Definition XTextDocument.idl:27
com::sun::star::text::XTextEmbeddedObjectsSupplier
provides the collection of all embedded objects within this context (i.e.
Definition XTextEmbeddedObjectsSupplier.idl:28
com::sun::star::text::XTextFieldsSupplier
makes it possible to access the text fields used in this context (e.g.
Definition XTextFieldsSupplier.idl:29
com::sun::star::text::XTextFramesSupplier
makes it possible to access the TextFrame instances in this context (e.g.
Definition XTextFramesSupplier.idl:28
com::sun::star::text::XTextGraphicObjectsSupplier
provides access to the collection of all embedded and linked graphics within this context (i....
Definition XTextGraphicObjectsSupplier.idl:28
com::sun::star::text::XTextSectionsSupplier
manages the text sections within the context (i.e.
Definition XTextSectionsSupplier.idl:27
com::sun::star::text::XTextTablesSupplier
enables the object to handle text tables.
Definition XTextTablesSupplier.idl:28
com::sun::star::util::XNumberFormatsSupplier
supplies the collection of NumberFormats (for example, in a document) and the settings belonging to t...
Definition XNumberFormatsSupplier.idl:29
com::sun::star::util::XRefreshable
is supported by objects with data that can be refreshed from a data source.
Definition XRefreshable.idl:28
com::sun::star::util::XReplaceable
makes it possible to replace strings in a text described by a SearchDescriptor.
Definition XReplaceable.idl:38
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:46
com
Definition Ambiguous.idl:20
com::sun::star::document::OfficeDocument
abstract service which specifies a storable and printable document
Definition OfficeDocument.idl:34
com::sun::star::text::GenericTextDocument
A text document is a model component which contains text structured by paragraphs.
Definition GenericTextDocument.idl:36
com::sun::star::text::GenericTextDocument::CharLocale
com::sun::star::lang::Locale CharLocale
contains the identifier of the default locale of the document.
Definition GenericTextDocument.idl:105
com::sun::star::text::GenericTextDocument::IndexAutoMarkFileURL
string IndexAutoMarkFileURL
specifies the concordance file taken into account when creating an index.
Definition GenericTextDocument.idl:143
com::sun::star::text::GenericTextDocument::WordCount
long WordCount
contains the count of all words in the document.
Definition GenericTextDocument.idl:121
com::sun::star::text::GenericTextDocument::RecordChanges
boolean RecordChanges
specifies if change recording is active.
Definition GenericTextDocument.idl:149
com::sun::star::text::GenericTextDocument::CharacterCount
long CharacterCount
contains the count of all characters in the document.
Definition GenericTextDocument.idl:110
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:133
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:161
com::sun::star::text::GenericTextDocument::ParagraphCount
long ParagraphCount
contains the count of all paragraphs in the document.
Definition GenericTextDocument.idl:116
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition Locale.idl:34