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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XTextDocument_idl__
  20 #define __com_sun_star_text_XTextDocument_idl__
  21
  22 #include <com/sun/star/frame/XModel.idl>
  23
  24 #include <com/sun/star/text/XText.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module text {
  29
  30 /** is the main interface of a text document.@see com::sun::star::text::TextDocument
  31  */
  32 published interface XTextDocument: com::sun::star::frame::XModel
  33 {
  34     /** @returns
  35                 the major com::sun::star::text::Text of the text document.
  36
  37                 <p>This text does not contain texts in TextFrames,
  38                 or cells of TextTables etc. directly. These are
  39                 accessible from the contents via <code>X...Supplier</code>
  40                 (e.g. XTextTablesSupplier).
  41      */
  42     com::sun::star::text::XText getText();
  43
  44     /** reformats the contents of the document.
  45      */
  46     void reformat();
  47
  48 };
  49
  50
  51 }; }; }; };
  52
  53 #endif
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */