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