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