offapi/com/sun/star/text/XTextDocument.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: XTextDocument.idl,v $
  10  * $Revision: 1.12 $
  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_XTextDocument_idl__
  31 #define __com_sun_star_text_XTextDocument_idl__
  32
  33 #ifndef __com_sun_star_frame_XModel_idl__
  34 #include <com/sun/star/frame/XModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_XText_idl__
  38 #include <com/sun/star/text/XText.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module text {
  45
  46 //=============================================================================
  47
  48 // DocMerge from xml: interface com::sun::star::text::XTextDocument
  49 /** is the main interface of a text document.@see com::sun::star::text::TextDocument
  50  */
  51 published interface XTextDocument: com::sun::star::frame::XModel
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     // DocMerge from idl: method com::sun::star::text::XTextDocument::getText
  56     /** @returns
  57                 the major <type scope="com::sun::star::text">Text</type> of the text document.
  58
  59                 <p>This text does not contain texts in <type>TextFrame</type>s,
  60                 or cells of <type>TextTable</type>s etc. directly. These are
  61                 accessible from the contents via <code>X...Supplier</code>
  62                 (e.g. <type>XTextTablesSupplier</type>).
  63      */
  64     com::sun::star::text::XText getText();
  65
  66     //-------------------------------------------------------------------------
  67
  68     // DocMerge from xml: method com::sun::star::text::XTextDocument::reformat
  69     /** reformats the contents of the document.
  70      */
  71     void reformat();
  72
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif