xref: /aoo41x/main/offapi/com/sun/star/text/XFlatParagraphIteratorProvider.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_text_XFlatParagraphIteratorProvider_idl__
#define __com_sun_star_text_XFlatParagraphIteratorProvider_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_text_XFlatParagraphIterator_idl__
#include <com/sun/star/text/XFlatParagraphIterator.idl>
#endif

//---------------------------------------Note----------------------------------
//    allows for different iterators for grammar checking and smart tags,
//    interface must be implemented exactly once for each document since
//    the interface pointer will be used to get an unique document id.
//-----------------------------------------------------------------------------

//=============================================================================

module com {  module sun {  module star {  module text {

//=============================================================================

/** provides functionality to ...

    @since OOo 3.0
 */

interface XFlatParagraphIteratorProvider: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** get XFlatParagraphIterator

        @param  nType
                Type of text markup see <type>TextMarkupType</type>.

        @param  bAutomatic
                Automatic or interactive checking.

        @returns
                the iterator.

        @throws IllegalArgumentException
                if any argument is wrong.

    */
    com::sun::star::text::XFlatParagraphIterator getFlatParagraphIterator( [in] long nType,
                                                                           [in] boolean bAutomatic )
            raises( com::sun::star::lang::IllegalArgumentException );
};

//=============================================================================

}; }; }; };

#endif