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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XTextDocument_idl__
  28 #define __com_sun_star_text_XTextDocument_idl__
  29
  30 #ifndef __com_sun_star_frame_XModel_idl__
  31 #include <com/sun/star/frame/XModel.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_text_XText_idl__
  35 #include <com/sun/star/text/XText.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module text {
  42
  43 //=============================================================================
  44
  45 // DocMerge from xml: interface com::sun::star::text::XTextDocument
  46 /** is the main interface of a text document.@see com::sun::star::text::TextDocument
  47  */
  48 published interface XTextDocument: com::sun::star::frame::XModel
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     // DocMerge from idl: method com::sun::star::text::XTextDocument::getText
  53     /** @returns
  54                 the major <type scope="com::sun::star::text">Text</type> of the text document.
  55
  56                 <p>This text does not contain texts in <type>TextFrame</type>s,
  57                 or cells of <type>TextTable</type>s etc. directly. These are
  58                 accessible from the contents via <code>X...Supplier</code>
  59                 (e.g. <type>XTextTablesSupplier</type>).
  60      */
  61     com::sun::star::text::XText getText();
  62
  63     //-------------------------------------------------------------------------
  64
  65     // DocMerge from xml: method com::sun::star::text::XTextDocument::reformat
  66     /** reformats the contents of the document.
  67      */
  68     void reformat();
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif