offapi/com/sun/star/text/XMultiTextMarkup.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 #ifndef __com_sun_star_text_XMultiTextMarkup_idl__
  21 #define __com_sun_star_text_XMultiTextMarkup_idl__
  22
  23 #include <com/sun/star/container/XStringKeyMap.idl>
  24 #include <com/sun/star/text/TextMarkupDescriptor.idl>
  25 #include <com/sun/star/lang/IllegalArgumentException.idl>
  26
  27
  28 module com {  module sun {  module star {  module text {
  29
  30
  31 /** provides functionality to apply multiple text markups in one call.
  32
  33     @since OOo 3.0.1
  34  */
  35
  36 interface XMultiTextMarkup
  37 {
  38     /** submits multiple new markup ranges.
  39
  40         <p>The main use of this function will probably be for proofreading to
  41         allow for setting the markup of all found errors in a sentence in a single
  42         call. For this the sequence needs to provide the markups for all errors along
  43         with the markup for the identified sentence boundaries.
  44         The order of those entries is arbitrary.</p>
  45
  46         @param aMarkups
  47                 a sequence of single text markups.
  48
  49         @see com::sun::star::text::XTextMarkup
  50         @see com::sun::star::text::TextMarkupType
  51
  52      */
  53     void commitMultiTextMarkup(
  54                     [in] sequence< com::sun::star::text::TextMarkupDescriptor > aMarkups )
  55             raises( com::sun::star::lang::IllegalArgumentException );
  56 };
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */