offapi/com/sun/star/text/GenericTextDocument.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: GenericTextDocument.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_GenericTextDocument_idl__
  31 #define __com_sun_star_text_GenericTextDocument_idl__
  32
  33 #ifndef __com_sun_star_document_OfficeDocument_idl__
  34 #include <com/sun/star/document/OfficeDocument.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_XTextDocument_idl__
  38 #include <com/sun/star/text/XTextDocument.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_XSearchable_idl__
  42 #include <com/sun/star/util/XSearchable.idl>
  43 #endif
  44
  45 #ifndef _com_sun_star_util_XRefreshable_idl_
  46 #include <com/sun/star/util/XRefreshable.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_text_XFootnotesSupplier_idl__
  50 #include <com/sun/star/text/XFootnotesSupplier.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_text_XEndnotesSupplier_idl__
  54 #include <com/sun/star/text/XEndnotesSupplier.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_util_XReplaceable_idl__
  58 #include <com/sun/star/util/XReplaceable.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_text_XPagePrintable_idl__
  62 #include <com/sun/star/text/XPagePrintable.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_text_XReferenceMarksSupplier_idl__
  66 #include <com/sun/star/text/XReferenceMarksSupplier.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_text_XLineNumberingSupplier_idl__
  70 #include <com/sun/star/text/XLineNumberingSupplier.idl>
  71 #endif
  72
  73 #ifndef __com_sun_star_text_XChapterNumberingSupplier_idl__
  74 #include <com/sun/star/text/XChapterNumberingSupplier.idl>
  75 #endif
  76
  77 #ifndef __com_sun_star_text_XTextGraphicObjectsSupplier_idl__
  78 #include <com/sun/star/text/XTextGraphicObjectsSupplier.idl>
  79 #endif
  80
  81 #ifndef __com_sun_star_text_XTextEmbeddedObjectsSupplier_idl__
  82 #include <com/sun/star/text/XTextEmbeddedObjectsSupplier.idl>
  83 #endif
  84
  85 #ifndef __com_sun_star_text_XTextTablesSupplier_idl__
  86 #include <com/sun/star/text/XTextTablesSupplier.idl>
  87 #endif
  88
  89 #ifndef __com_sun_star_style_XStyleFamiliesSupplier_idl__
  90 #include <com/sun/star/style/XStyleFamiliesSupplier.idl>
  91 #endif
  92
  93 #ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
  94 #include <com/sun/star/util/XNumberFormatsSupplier.idl>
  95 #endif
  96
  97 #ifndef __com_sun_star_text_XBookmarksSupplier_idl__
  98 #include <com/sun/star/text/XBookmarksSupplier.idl>
  99 #endif
 100
 101 #ifndef __com_sun_star_text_XDocumentIndexesSupplier_idl__
 102 #include <com/sun/star/text/XDocumentIndexesSupplier.idl>
 103 #endif
 104
 105 #ifndef __com_sun_star_text_XTextFieldsSupplier_idl__
 106 #include <com/sun/star/text/XTextFieldsSupplier.idl>
 107 #endif
 108
 109 #ifndef __com_sun_star_text_XTextFramesSupplier_idl__
 110 #include <com/sun/star/text/XTextFramesSupplier.idl>
 111 #endif
 112
 113 #ifndef __com_sun_star_text_XTextSectionsSupplier_idl__
 114 #include <com/sun/star/text/XTextSectionsSupplier.idl>
 115 #endif
 116
 117 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
 118 #include <com/sun/star/lang/XMultiServiceFactory.idl>
 119 #endif
 120
 121 #ifndef __com_sun_star_lang_Locale_idl__
 122 #include <com/sun/star/lang/Locale.idl>
 123 #endif
 124
 125 //=============================================================================
 126
 127  module com {  module sun {  module star {  module text {
 128
 129 //=============================================================================
 130
 131 /** A text document is a model component which contains text
 132     structured by paragraphs.
 133
 134     <p>Each paragraph and each portion of text can be fitted with
 135     some attributes (technically properties).</p>
 136
 137     <p>Its declared as generic text document, because its function is
 138     needed by different derived services (TextDocument/WebDocument/GlobalDocument).</p>
 139
 140     <p>In addition, all text objects can be searched.</p>
 141  */
 142 published service GenericTextDocument
 143 {
 144     service com::sun::star::document::OfficeDocument;
 145
 146     /** provides methods to create instances of several text document
 147         services.
 148         A text document provides several services which need the context
 149         of a text document and these text document dependent services are
 150         created at the text document directly and not over the global service
 151         manager.
 152      */
 153     interface com::sun::star::lang::XMultiServiceFactory;
 154
 155     interface com::sun::star::text::XTextDocument;
 156
 157     interface com::sun::star::util::XSearchable;
 158
 159     interface com::sun::star::util::XRefreshable;
 160
 161     [optional] interface com::sun::star::text::XFootnotesSupplier;
 162
 163     [optional] interface com::sun::star::text::XEndnotesSupplier;
 164
 165     [optional] interface com::sun::star::util::XReplaceable;
 166
 167     [optional] interface com::sun::star::text::XPagePrintable;
 168
 169     [optional] interface com::sun::star::text::XReferenceMarksSupplier;
 170
 171     [optional] interface com::sun::star::text::XLineNumberingSupplier;
 172
 173     [optional] interface com::sun::star::text::XChapterNumberingSupplier;
 174
 175     [optional] interface com::sun::star::beans::XPropertySet;
 176
 177     [optional] interface com::sun::star::text::XTextGraphicObjectsSupplier;
 178
 179     [optional] interface com::sun::star::text::XTextEmbeddedObjectsSupplier;
 180
 181     [optional] interface com::sun::star::text::XTextTablesSupplier;
 182
 183     [optional] interface com::sun::star::style::XStyleFamiliesSupplier;
 184
 185     /// @since OOo 1.1.2
 186     [optional] interface com::sun::star::text::XBookmarksSupplier;
 187
 188     /// @since OOo 1.1.2
 189     [optional] interface com::sun::star::text::XDocumentIndexesSupplier;
 190
 191     /// @since OOo 1.1.2
 192     [optional] interface com::sun::star::text::XTextFieldsSupplier;
 193
 194     /// @since OOo 1.1.2
 195     [optional] interface com::sun::star::text::XTextFramesSupplier;
 196
 197     /// @since OOo 1.1.2
 198     [optional] interface com::sun::star::text::XTextSectionsSupplier;
 199
 200     /// @since OOo 1.1.2
 201     [optional] interface com::sun::star::util::XNumberFormatsSupplier;
 202     //-------------------------------------------------------------------------
 203
 204     /** contains the identifier of the default locale of the document.
 205      */
 206     [optional, property] com::sun::star::lang::Locale CharLocale;
 207
 208     //-------------------------------------------------------------------------
 209
 210     /** contains the count of all characters in the document.
 211      */
 212     [optional, readonly, property] long CharacterCount;
 213
 214
 215     //-------------------------------------------------------------------------
 216
 217     /** contains the count of all paragraphs in the document.
 218      */
 219     [optional, readonly, property] long ParagraphCount;
 220
 221     //-------------------------------------------------------------------------
 222
 223     /** contains the count of all words in the document.@see WordSeparator
 224      */
 225     [optional, readonly, property] long WordCount;
 226
 227     //-------------------------------------------------------------------------
 228
 229     /** contains a string that consists of characters that mark the
 230         separation of words in counting the words in a document.
 231
 232
 233
 234         <p> I.e. slash and backslash. Whitespaces (tab stop,
 235         space, paragraph break, line break) always separate
 236         words.</p>@see WordCount
 237      */
 238     [optional, property] string WordSeparator;
 239
 240         //-------------------------------------------------------------------------
 241         /** specifies the concordance file taken into account when
 242          *  creating an index.
 243          *
 244          *  When no concordance file should be used the string is empty.
 245          *  Used for text documents only.
 246      *
 247      *  @since OOo 1.1.2
 248          */
 249         [optional, property] string IndexAutoMarkFileURL;
 250
 251         //-------------------------------------------------------------------------
 252         /** specifies if change recording is active.
 253      *
 254      *  @since OOo 1.1.2
 255          */
 256         [optional, property] boolean RecordChanges;
 257
 258         //-------------------------------------------------------------------------
 259         /** specifies the first 4 digit year to be used when years
 260          *  are given in 2 digits.
 261          *
 262          *  Example: if set to 1930
 263          *    Oct-12-29 will be interpreted as Oct-12-2029
 264          *    Oct-12-30 will be interpreted as Oct-12-1930
 265          *    Oct-12-02 will be interpreted as Oct-12-2002
 266      *
 267      *  @since OOo 1.1.2
 268          */
 269         [optional, property] short TwoDigitYear;
 270 };
 271
 272 //=============================================================================
 273
 274 }; }; }; };
 275
 276 #endif