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

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