summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/GenericTextDocument.idl
blob: 9956b8026206cb48a1e7682294a4f9797aaa6dd7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_text_GenericTextDocument_idl__
#define __com_sun_star_text_GenericTextDocument_idl__

#include <com/sun/star/document/OfficeDocument.idl>
#include <com/sun/star/text/XTextDocument.idl>
#include <com/sun/star/util/XSearchable.idl>
#include <com/sun/star/util/XRefreshable.idl>
#include <com/sun/star/text/XFootnotesSupplier.idl>
#include <com/sun/star/text/XEndnotesSupplier.idl>
#include <com/sun/star/util/XReplaceable.idl>
#include <com/sun/star/text/XPagePrintable.idl>
#include <com/sun/star/text/XReferenceMarksSupplier.idl>
#include <com/sun/star/text/XChapterNumberingSupplier.idl>
#include <com/sun/star/text/XTextGraphicObjectsSupplier.idl>
#include <com/sun/star/text/XTextEmbeddedObjectsSupplier.idl>
#include <com/sun/star/text/XTextTablesSupplier.idl>
#include <com/sun/star/style/XStyleFamiliesSupplier.idl>
#include <com/sun/star/util/XNumberFormatsSupplier.idl>
#include <com/sun/star/text/XBookmarksSupplier.idl>
#include <com/sun/star/text/XDocumentIndexesSupplier.idl>
#include <com/sun/star/text/XTextFieldsSupplier.idl>
#include <com/sun/star/text/XTextFramesSupplier.idl>
#include <com/sun/star/text/XTextSectionsSupplier.idl>
#include <com/sun/star/lang/XMultiServiceFactory.idl>
#include <com/sun/star/lang/Locale.idl>


 module com {  module sun {  module star {  module text {


/** A text document is a model component which contains text
    structured by paragraphs.

    <p>Each paragraph and each portion of text can be fitted with
    some attributes (technically properties).</p>

    <p>Its declared as generic text document, because its function is
    needed by different derived services (TextDocument/WebDocument/GlobalDocument).</p>

    <p>In addition, all text objects can be searched.</p>
 */
published service GenericTextDocument
{
    service com::sun::star::document::OfficeDocument;

    /** provides methods to create instances of several text document
        services.
        A text document provides several services which need the context
        of a text document and these text document dependent services are
        created at the text document directly and not over the global service
        manager.
     */
    interface com::sun::star::lang::XMultiServiceFactory;

    interface com::sun::star::text::XTextDocument;

    interface com::sun::star::util::XSearchable;

    interface com::sun::star::util::XRefreshable;

    [optional] interface com::sun::star::text::XFootnotesSupplier;

    [optional] interface com::sun::star::text::XEndnotesSupplier;

    [optional] interface com::sun::star::util::XReplaceable;

    [optional] interface com::sun::star::text::XPagePrintable;

    [optional] interface com::sun::star::text::XReferenceMarksSupplier;

    [optional] interface com::sun::star::text::XChapterNumberingSupplier;

    [optional] interface com::sun::star::beans::XPropertySet;

    [optional] interface com::sun::star::text::XTextGraphicObjectsSupplier;

    [optional] interface com::sun::star::text::XTextEmbeddedObjectsSupplier;

    [optional] interface com::sun::star::text::XTextTablesSupplier;

    [optional] interface com::sun::star::style::XStyleFamiliesSupplier;

    /** @since OOo 1.1.2
     */
    [optional] interface com::sun::star::text::XBookmarksSupplier;

    /** @since OOo 1.1.2
     */
    [optional] interface com::sun::star::text::XDocumentIndexesSupplier;

    /** @since OOo 1.1.2
     */
    [optional] interface com::sun::star::text::XTextFieldsSupplier;

    /** @since OOo 1.1.2
     */
    [optional] interface com::sun::star::text::XTextFramesSupplier;

    /** @since OOo 1.1.2
     */
    [optional] interface com::sun::star::text::XTextSectionsSupplier;

    /** @since OOo 1.1.2
     */
    [optional] interface com::sun::star::util::XNumberFormatsSupplier;

    /** contains the identifier of the default locale of the document.
     */
    [optional, property] com::sun::star::lang::Locale CharLocale;


    /** contains the count of all characters in the document.
     */
    [optional, readonly, property] long CharacterCount;



    /** contains the count of all paragraphs in the document.
     */
    [optional, readonly, property] long ParagraphCount;


    /** contains the count of all words in the document.@see WordSeparator
     */
    [optional, readonly, property] long WordCount;


    /** contains a string that consists of characters that mark the
        separation of words in counting the words in a document.



        <p> I.e. slash and backslash. Whitespace (tab stop,
        space, paragraph break, line break) always separate
        words.</p>@see WordCount
     */
    [optional, property] string WordSeparator;

        /** specifies the concordance file taken into account when
         *  creating an index.
         *
         *  When no concordance file should be used the string is empty.
         *  Used for text documents only.
     *
     *  @since OOo 1.1.2
         */
        [optional, property] string IndexAutoMarkFileURL;

        /** specifies if change recording is active.
     *
     *  @since OOo 1.1.2
         */
        [optional, property] boolean RecordChanges;

        /** specifies the first 4 digit year to be used when years
         *  are given in 2 digits.
         *
         *  Example: if set to 1930
         *    Oct-12-29 will be interpreted as Oct-12-2029
         *    Oct-12-30 will be interpreted as Oct-12-1930
         *    Oct-12-02 will be interpreted as Oct-12-2002
     *
     *  @since OOo 1.1.2
         */
        [optional, property] short TwoDigitYear;
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */