offapi/com/sun/star/text/AdvancedTextDocument.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: AdvancedTextDocument.idl,v $
  10  * $Revision: 1.11 $
  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_AdvancedTextDocument_idl__
  31 #define __com_sun_star_text_AdvancedTextDocument_idl__
  32
  33 #ifndef __com_sun_star_lang_Locale_idl__
  34 #include <com/sun/star/lang/Locale.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_HypertextDocument_idl__
  38 #include <com/sun/star/text/HypertextDocument.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_text_XFootnotesSupplier_idl__
  42 #include <com/sun/star/text/XFootnotesSupplier.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_text_XEndnotesSupplier_idl__
  46 #include <com/sun/star/text/XEndnotesSupplier.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_util_XReplaceable_idl__
  50 #include <com/sun/star/util/XReplaceable.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_text_XPagePrintable_idl__
  54 #include <com/sun/star/text/XPagePrintable.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_text_XReferenceMarksSupplier_idl__
  58 #include <com/sun/star/text/XReferenceMarksSupplier.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_text_XLineNumberingSupplier_idl__
  62 #include <com/sun/star/text/XLineNumberingSupplier.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_text_XChapterNumberingSupplier_idl__
  66 #include <com/sun/star/text/XChapterNumberingSupplier.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_beans_XPropertySet_idl__
  70 #include <com/sun/star/beans/XPropertySet.idl>
  71 #endif
  72
  73
  74 //=============================================================================
  75
  76  module com {  module sun {  module star {  module text {
  77
  78 //=============================================================================
  79
  80 // DocMerge from xml: service com::sun::star::text::AdvancedTextDocument
  81 /** An advanced text document is an extension of a hypertext document
  82     which can also contain text-frames, foot- and endnotes, and some
  83     other advanced contents.
  84
  85     @deprecated
  86         use <type>TextDocument</type> instead.
  87  */
  88 published service AdvancedTextDocument
  89 {
  90     // DocMerge: empty anyway
  91     service com::sun::star::text::HypertextDocument;
  92
  93     // DocMerge: empty anyway
  94     interface com::sun::star::text::XFootnotesSupplier;
  95
  96     // DocMerge: empty anyway
  97     interface com::sun::star::text::XEndnotesSupplier;
  98
  99     // DocMerge: empty anyway
 100     interface com::sun::star::util::XReplaceable;
 101
 102     // DocMerge: empty anyway
 103     interface com::sun::star::text::XPagePrintable;
 104
 105     // DocMerge: empty anyway
 106     interface com::sun::star::text::XReferenceMarksSupplier;
 107
 108     // DocMerge: empty anyway
 109     interface com::sun::star::text::XLineNumberingSupplier;
 110
 111     // DocMerge: empty anyway
 112     interface com::sun::star::text::XChapterNumberingSupplier;
 113
 114     // DocMerge: empty anyway
 115     interface com::sun::star::beans::XPropertySet;
 116
 117     //-------------------------------------------------------------------------
 118
 119     // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::CharLocale
 120     /** contains the identifier of the default locale of the document.
 121      */
 122     [property] com::sun::star::lang::Locale CharLocale;
 123
 124     //-------------------------------------------------------------------------
 125
 126     // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::CharacterCount
 127     /** contains the count of all characters in the document.
 128      */
 129     [readonly, property] long CharacterCount;
 130
 131     //-------------------------------------------------------------------------
 132
 133     // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::ParagraphCount
 134     /** contains the count of all paragraphs in the document.
 135      */
 136     [readonly, property] long ParagraphCount;
 137
 138     //-------------------------------------------------------------------------
 139
 140     // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::WordCount
 141     /** contains the count of all words in the document.@see WordSeparator
 142      */
 143     [readonly, property] long WordCount;
 144
 145     //-------------------------------------------------------------------------
 146
 147     // DocMerge from xml: property com::sun::star::text::AdvancedTextDocument::WordSeparator
 148     /** contains a string that consists of characters that mark the
 149         separation of words in counting the words in a document.
 150
 151
 152
 153         <p> I.e., slash and backslash. Whitespaces (tab stop,
 154         space, paragraph break, or line break) always separate
 155         words.</p>@see WordCount
 156      */
 157     [property] string WordSeparator;
 158
 159 };
 160
 161 //=============================================================================
 162
 163 }; }; }; };
 164
 165 #endif