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