offapi/com/sun/star/text/XFlatParagraphIteratorProvider.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: XFlatParagraphIteratorProvider.idl,v $
  10  * $Revision: 1.3 $
  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_XFlatParagraphIteratorProvider_idl__
  32 #define __com_sun_star_text_XFlatParagraphIteratorProvider_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_text_XFlatParagraphIterator_idl__
  43 #include <com/sun/star/text/XFlatParagraphIterator.idl>
  44 #endif
  45
  46 //---------------------------------------Note----------------------------------
  47 //    allows for different iterators for grammar checking and smart tags,
  48 //    interface must be implemented exactly once for each document since
  49 //    the interface pointer will be used to get an unique document id.
  50 //-----------------------------------------------------------------------------
  51
  52 //=============================================================================
  53
  54 module com {  module sun {  module star {  module text {
  55
  56 //=============================================================================
  57
  58 /** provides functionality to ...
  59
  60     @since OOo 3.0
  61  */
  62
  63 interface XFlatParagraphIteratorProvider: com::sun::star::uno::XInterface
  64 {
  65     //-------------------------------------------------------------------------
  66     /** get XFlatParagraphIterator
  67
  68         @param  nType
  69                 Type of text markup see <type>TextMarkupType</type>.
  70
  71         @param  bAutomatic
  72                 Automatic or interactive checking.
  73
  74         @returns
  75                 the iterator.
  76
  77         @throws IllegalArgumentException
  78                 if any argument is wrong.
  79
  80     */
  81     com::sun::star::text::XFlatParagraphIterator getFlatParagraphIterator( [in] long nType,
  82                                                                            [in] boolean bAutomatic )
  83             raises( com::sun::star::lang::IllegalArgumentException );
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif