1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_text_XFlatParagraphIterator_idl__ 25cdf0e10cSrcweir#define __com_sun_star_text_XFlatParagraphIterator_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 32cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_text_XFlatParagraph_idl__ 36cdf0e10cSrcweir#include <com/sun/star/text/XFlatParagraph.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module text { 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweir/** provides functionality to ... 46cdf0e10cSrcweir 47*2a413f17SJürgen Schmidt @since OpenOffice 3.0 48cdf0e10cSrcweir */ 49cdf0e10cSrcweir 50cdf0e10cSrcweirinterface XFlatParagraphIterator: com::sun::star::uno::XInterface 51cdf0e10cSrcweir{ 52cdf0e10cSrcweir 53cdf0e10cSrcweir //------------------------------------------------------------------------- 54cdf0e10cSrcweir /** get the first flat paragraph to be checked or an empty reference if 55cdf0e10cSrcweir there are no more paragraphs to check. 56cdf0e10cSrcweir 57cdf0e10cSrcweir @returns 58cdf0e10cSrcweir the paragraph. 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir com::sun::star::text::XFlatParagraph getFirstPara(); 61cdf0e10cSrcweir 62cdf0e10cSrcweir //------------------------------------------------------------------------- 63cdf0e10cSrcweir /** get the next flat paragraph to be checked or an empty reference if 64cdf0e10cSrcweir there are no more paragraphs to check. 65cdf0e10cSrcweir 66cdf0e10cSrcweir @returns 67cdf0e10cSrcweir the paragraph. 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir com::sun::star::text::XFlatParagraph getNextPara(); 70cdf0e10cSrcweir 71cdf0e10cSrcweir //------------------------------------------------------------------------- 72cdf0e10cSrcweir /** get the last flat paragraph 73cdf0e10cSrcweir 74cdf0e10cSrcweir @returns 75cdf0e10cSrcweir the paragraph. 76cdf0e10cSrcweir */ 77cdf0e10cSrcweir com::sun::star::text::XFlatParagraph getLastPara(); 78cdf0e10cSrcweir 79cdf0e10cSrcweir //------------------------------------------------------------------------- 80cdf0e10cSrcweir /** get the flat paragraph before this one 81cdf0e10cSrcweir 82cdf0e10cSrcweir @param xPara 83cdf0e10cSrcweir the current flat paragraph 84cdf0e10cSrcweir 85cdf0e10cSrcweir @returns 86cdf0e10cSrcweir the flat paragraph. 87cdf0e10cSrcweir 88cdf0e10cSrcweir @throws IllegalArgumentException 89cdf0e10cSrcweir if any argument is wrong. 90cdf0e10cSrcweir */ 91cdf0e10cSrcweir com::sun::star::text::XFlatParagraph getParaBefore( [in] com::sun::star::text::XFlatParagraph xPara ) 92cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 93cdf0e10cSrcweir 94cdf0e10cSrcweir //------------------------------------------------------------------------- 95cdf0e10cSrcweir /** get the flat paragraph just following this one 96cdf0e10cSrcweir 97cdf0e10cSrcweir @param xPara 98cdf0e10cSrcweir the current flat paragraph 99cdf0e10cSrcweir 100cdf0e10cSrcweir @returns 101cdf0e10cSrcweir the flat paragraph. 102cdf0e10cSrcweir 103cdf0e10cSrcweir @throws IllegalArgumentException 104cdf0e10cSrcweir if any argument is wrong. 105cdf0e10cSrcweir */ 106cdf0e10cSrcweir com::sun::star::text::XFlatParagraph getParaAfter( [in] com::sun::star::text::XFlatParagraph xPara ) 107cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 108cdf0e10cSrcweir}; 109cdf0e10cSrcweir 110cdf0e10cSrcweir//============================================================================= 111cdf0e10cSrcweir 112cdf0e10cSrcweir}; }; }; }; 113cdf0e10cSrcweir 114cdf0e10cSrcweir#endif 115