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