offapi/com/sun/star/text/XParagraphAppend.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_XParagraphAppend_idl__
  20 #define __com_sun_star_text_XParagraphAppend_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
  28 #include <com/sun/star/text/XTextRange.idl>
  29
  30
  31  module com {  module sun {  module star {  module text {
  32
  33
  34 /** allows inserting and appending paragraphs.
  35  */
  36 interface XParagraphAppend : com::sun::star::uno::XInterface
  37 {
  38          /** appends a new and empty paragraph at the end of the text.
  39
  40                 <p>The properties are applied to the last paragraph before the new paragraph is inserted.
  41                 </p>
  42
  43         @param
  44             CharacterAndParagraphProperties can contain all the properties defined by the service
  45                       Paragraph.
  46
  47          */
  48          com::sun::star::text::XTextRange finishParagraph(  [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties )
  49                         raises( com::sun::star::lang::IllegalArgumentException,
  50                                        com::sun::star::beans::UnknownPropertyException );
  51
  52          /** inserts a new and empty paragraph to the text at a given position.
  53
  54                 <p>The properties are applied to the last paragraph before the new paragraph is inserted.
  55                 </p>
  56
  57         @param
  58             CharacterAndParagraphProperties can contain all the properties defined by the service
  59                       Paragraph.
  60
  61         @param
  62             TextRange specifies the position of the insertion.
  63
  64         @since LibreOffice 4.0
  65
  66          */
  67          com::sun::star::text::XTextRange finishParagraphInsert(  [in] com::sun::star::beans::PropertyValues CharacterAndParagraphProperties,
  68                                                                   [in] com::sun::star::text::XTextRange TextRange )
  69                         raises( com::sun::star::lang::IllegalArgumentException,
  70                                        com::sun::star::beans::UnknownPropertyException );
  71
  72 };
  73
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */