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