offapi/com/sun/star/text/XMultiTextMarkup.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_text_XMultiTextMarkup_idl__
  29 #define __com_sun_star_text_XMultiTextMarkup_idl__
  30
  31 #ifndef __com_sun_star_container_XStringKeyMap_idl__
  32 #include <com/sun/star/container/XStringKeyMap.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_text_TextMarkupDescriptor_idl__
  36 #include <com/sun/star/text/TextMarkupDescriptor.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  40 #include <com/sun/star/lang/IllegalArgumentException.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module text {
  46
  47 //=============================================================================
  48
  49 /** provides functionality to apply multiple text markups in one call.
  50
  51     @since OOo 3.0.1
  52  */
  53
  54 interface XMultiTextMarkup
  55 {
  56     //-------------------------------------------------------------------------
  57     /** submits multiple new markup ranges.
  58
  59         <p>The main use of this function will probably be for proofreading to
  60         allow for setting the markup of all found errors in a sentence in a single
  61         call. For this the sequence needs to provide the markups for all errors along
  62         with the markup for the identified sentence boundaries.
  63         The order of those entries is arbitrary.</p>
  64
  65         @param aMarkups
  66                 a sequence of single text markups.
  67
  68         @see com::sun::star::text::XTextMarkup
  69         @see com::sun::star::text::TextMarkupType
  70
  71      */
  72     void commitMultiTextMarkup(
  73                     [in] sequence< com::sun::star::text::TextMarkupDescriptor > aMarkups )
  74             raises( com::sun::star::lang::IllegalArgumentException );
  75 };
  76
  77 }; }; }; };
  78
  79 #endif