offapi/com/sun/star/text/XTextPortionAppend.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 formatted text portions.
  25  */
  26 interface XTextPortionAppend : com::sun::star::uno::XInterface
  27 {
  28
  29         /** appends a new text portion to the paragraph at the end of the text.
  30
  31                 <p> The sequence can contain all the properties defined by the service TextPortion.
  32         </p>
  33
  34         @param
  35             Text contains the text to be appended.
  36
  37         @param
  38             CharacterAndParagraphProperties can contain all the properties defined by the service
  39                       Paragraph.
  40      */
  41          com::sun::star::text::XTextRange  appendTextPortion(
  42                                 [in] string Text,
  43                                 [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties )
  44                         raises( com::sun::star::lang::IllegalArgumentException,
  45                                 com::sun::star::beans::UnknownPropertyException,
  46                                 com::sun::star::beans::PropertyVetoException );
  47
  48         /** inserts a new text portion to the paragraph at a given position.
  49
  50                 <p> The sequence can contain all the properties defined by the service TextPortion.
  51         </p>
  52
  53         @param
  54             Text contains the text to be inserted.
  55
  56         @param
  57             CharacterAndParagraphProperties can contain all the properties defined by the service
  58                       Paragraph.
  59
  60         @param
  61             TextRange specifies the position of the insert.
  62
  63         @since LibreOffice 4.0
  64
  65      */
  66          com::sun::star::text::XTextRange  insertTextPortion(
  67                                 [in] string Text,
  68                                 [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties,
  69                                 [in] com::sun::star::text::XTextRange TextRange)
  70                         raises( com::sun::star::lang::IllegalArgumentException,
  71                                 com::sun::star::beans::UnknownPropertyException,
  72                                 com::sun::star::beans::PropertyVetoException );
  73
  74 };
  75
  76
  77 }; }; }; };
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */