offapi/com/sun/star/text/XText.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
  20
  21
  22  module com {  module sun {  module star {  module text {
  23
  24
  25 /** extends a XSimpleText by the capability of inserting
  26         XTextContents.
  27  */
  28 published interface XText: com::sun::star::text::XSimpleText
  29 {
  30
  31     /** inserts a content, such as a text table, text frame or text
  32         field.
  33
  34         <p>Which contents are accepted is implementation-specific. Some
  35         implementations may only accept contents which were created by the
  36         factory that supplied the same text or the document which contains
  37         the text.
  38         </p>
  39
  40         @param xRange
  41             specifies the position of insertion. Must belong to this XText.
  42
  43         @param xContent
  44             the text content to be inserted.
  45
  46         @param bAbsorb
  47             specifies whether the text spanned by <var>xRange</var> will be
  48             replaced. If `TRUE` then the content of <var>xRange</var> will
  49             be replaced by <var>xContent</var>, otherwise <var>xContent</var>
  50             will be inserted at the end of <var>xRange</var>.
  51      */
  52     void insertTextContent( [in] com::sun::star::text::XTextRange xRange,
  53              [in] com::sun::star::text::XTextContent xContent,
  54              [in] boolean bAbsorb )
  55             raises( com::sun::star::lang::IllegalArgumentException );
  56
  57
  58     /** removes the specified content from the text object.
  59         @param xContent
  60             the content that is to be removed.
  61      */
  62     void removeTextContent( [in] com::sun::star::text::XTextContent xContent )
  63             raises( com::sun::star::container::NoSuchElementException );
  64
  65 };
  66
  67
  68 }; }; }; };
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */