offapi/com/sun/star/text/XTextFrame.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_XTextFrame_idl__
  20 #define __com_sun_star_text_XTextFrame_idl__
  21
  22 #include <com/sun/star/text/XTextContent.idl>
  23 #include <com/sun/star/text/XText.idl>
  24
  25
  26
  27  module com {  module sun {  module star {  module text {
  28
  29 /** provides access to the Text of a TextFrame.
  30     @see TextFrame
  31  */
  32 published interface XTextFrame: com::sun::star::text::XTextContent
  33 {
  34     /** @returns
  35                 the text within this frame. The returned interface belongs
  36                 to an object which implements the service Text.
  37      */
  38     com::sun::star::text::XText getText();
  39
  40 };
  41
  42
  43 }; }; }; };
  44
  45 #endif
  46
  47 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */