offapi/com/sun/star/text/XTextContentAppend.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_XTextContentAppend_idl__
  20 #define __com_sun_star_text_XTextContentAppend_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/PropertyValues.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26 #include <com/sun/star/beans/UnknownPropertyException.idl>
  27 #include <com/sun/star/text/XTextContent.idl>
  28
  29
  30  module com {  module sun {  module star {  module text {
  31
  32
  33 /** allows inserting and appending text content.
  34  */
  35 interface XTextContentAppend : com::sun::star::uno::XInterface
  36 {
  37
  38         /** appends a text content at the end of the text.
  39
  40                 <p> The sequence can contain all the properties defined by the service
  41                 Paragraph.
  42         </p>
  43
  44         @param TextContent
  45             contains the object to be inserted.
  46         @param CharacterAndParagraphProperties
  47             can contain all the properties defined by the service
  48                       Paragraph.
  49         @return
  50             the anchor text range of the inserted text content.
  51      */
  52          com::sun::star::text::XTextRange appendTextContent(
  53              [in] com::sun::star::text::XTextContent TextContent,
  54              [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties )
  55                                 raises( com::sun::star::lang::IllegalArgumentException,
  56                                        com::sun::star::beans::UnknownPropertyException );
  57
  58         /** inserts a text content at the given position.
  59
  60         @param TextContent
  61             contains the object to be inserted.
  62         @param CharacterAndParagraphProperties
  63             can contain all the properties defined by the service
  64                       Paragraph.
  65         @param TextRange
  66             insert position
  67         @return
  68             the anchor text range of the inserted text content.
  69
  70         @since LibreOffice 4.0
  71      */
  72          com::sun::star::text::XTextRange insertTextContentWithProperties(
  73              [in] com::sun::star::text::XTextContent TextContent,
  74              [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties,
  75              [in] com::sun::star::text::XTextRange TextRange )
  76                                 raises( com::sun::star::lang::IllegalArgumentException,
  77                                        com::sun::star::beans::UnknownPropertyException );
  78
  79 };
  80
  81
  82 }; }; }; };
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */