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_XFlatParagraphIterator_idl__
25#define __com_sun_star_text_XFlatParagraphIterator_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_XFlatParagraph_idl__
36#include <com/sun/star/text/XFlatParagraph.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module text {
42
43//=============================================================================
44
45/** provides functionality to ...
46
47    @since OpenOffice 3.0
48 */
49
50interface XFlatParagraphIterator: com::sun::star::uno::XInterface
51{
52
53    //-------------------------------------------------------------------------
54    /** get the first flat paragraph to be checked or an empty reference if
55        there are no more paragraphs to check.
56
57        @returns
58                the paragraph.
59    */
60    com::sun::star::text::XFlatParagraph getFirstPara();
61
62    //-------------------------------------------------------------------------
63    /** get the next flat paragraph to be checked or an empty reference if
64        there are no more paragraphs to check.
65
66        @returns
67                the paragraph.
68    */
69    com::sun::star::text::XFlatParagraph getNextPara();
70
71    //-------------------------------------------------------------------------
72    /** get the last flat paragraph
73
74        @returns
75                the paragraph.
76    */
77    com::sun::star::text::XFlatParagraph getLastPara();
78
79    //-------------------------------------------------------------------------
80    /** get the flat paragraph before this one
81
82        @param  xPara
83                the current flat paragraph
84
85		@returns
86                the flat paragraph.
87
88        @throws IllegalArgumentException
89                if any argument is wrong.
90    */
91    com::sun::star::text::XFlatParagraph getParaBefore( [in] com::sun::star::text::XFlatParagraph xPara )
92            raises( com::sun::star::lang::IllegalArgumentException );
93
94    //-------------------------------------------------------------------------
95    /** get the flat paragraph just following this one
96
97        @param  xPara
98                the current flat paragraph
99
100		@returns
101                the flat paragraph.
102
103        @throws IllegalArgumentException
104                if any argument is wrong.
105    */
106    com::sun::star::text::XFlatParagraph getParaAfter( [in] com::sun::star::text::XFlatParagraph xPara )
107            raises( com::sun::star::lang::IllegalArgumentException );
108};
109
110//=============================================================================
111
112}; }; }; };
113
114#endif
115