1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_text_XFlatParagraphIteratorProvider_idl__
25#define __com_sun_star_text_XFlatParagraphIteratorProvider_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
32#include <com/sun/star/lang/IllegalArgumentException.idl>
33#endif
34
35#ifndef __com_sun_star_text_XFlatParagraphIterator_idl__
36#include <com/sun/star/text/XFlatParagraphIterator.idl>
37#endif
38
39//---------------------------------------Note----------------------------------
40//    allows for different iterators for grammar checking and smart tags,
41//    interface must be implemented exactly once for each document since
42//    the interface pointer will be used to get an unique document id.
43//-----------------------------------------------------------------------------
44
45//=============================================================================
46
47module com {  module sun {  module star {  module text {
48
49//=============================================================================
50
51/** provides functionality to ...
52
53    @since OpenOffice 3.0
54 */
55
56interface XFlatParagraphIteratorProvider: com::sun::star::uno::XInterface
57{
58    //-------------------------------------------------------------------------
59    /** get XFlatParagraphIterator
60
61        @param  nType
62                Type of text markup see <type>TextMarkupType</type>.
63
64        @param  bAutomatic
65                Automatic or interactive checking.
66
67        @returns
68                the iterator.
69
70        @throws IllegalArgumentException
71                if any argument is wrong.
72
73    */
74    com::sun::star::text::XFlatParagraphIterator getFlatParagraphIterator( [in] long nType,
75                                                                           [in] boolean bAutomatic )
76            raises( com::sun::star::lang::IllegalArgumentException );
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84