offapi/com/sun/star/text/XFlatParagraphIterator.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFlatParagraphIterator.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_text_XFlatParagraphIterator_idl__
  32 #define __com_sun_star_text_XFlatParagraphIterator_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_text_XFlatParagraph_idl__
  43 #include <com/sun/star/text/XFlatParagraph.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module text {
  49
  50 //=============================================================================
  51
  52 /** provides functionality to ...
  53
  54     @since OOo 3.0
  55  */
  56
  57 interface XFlatParagraphIterator: com::sun::star::uno::XInterface
  58 {
  59
  60     //-------------------------------------------------------------------------
  61     /** get the first flat paragraph to be checked or an empty reference if
  62         there are no more paragraphs to check.
  63
  64         @returns
  65                 the paragraph.
  66     */
  67     com::sun::star::text::XFlatParagraph getFirstPara();
  68
  69     //-------------------------------------------------------------------------
  70     /** get the next flat paragraph to be checked or an empty reference if
  71         there are no more paragraphs to check.
  72
  73         @returns
  74                 the paragraph.
  75     */
  76     com::sun::star::text::XFlatParagraph getNextPara();
  77
  78     //-------------------------------------------------------------------------
  79     /** get the last flat paragraph
  80
  81         @returns
  82                 the paragraph.
  83     */
  84     com::sun::star::text::XFlatParagraph getLastPara();
  85
  86     //-------------------------------------------------------------------------
  87     /** get the flat paragraph before this one
  88
  89         @param  xPara
  90                 the current flat paragraph
  91
  92         @returns
  93                 the flat paragraph.
  94
  95         @throws IllegalArgumentException
  96                 if any argument is wrong.
  97     */
  98     com::sun::star::text::XFlatParagraph getParaBefore( [in] com::sun::star::text::XFlatParagraph xPara )
  99             raises( com::sun::star::lang::IllegalArgumentException );
 100
 101     //-------------------------------------------------------------------------
 102     /** get the flat paragraph just following this one
 103
 104         @param  xPara
 105                 the current flat paragraph
 106
 107         @returns
 108                 the flat paragraph.
 109
 110         @throws IllegalArgumentException
 111                 if any argument is wrong.
 112     */
 113     com::sun::star::text::XFlatParagraph getParaAfter( [in] com::sun::star::text::XFlatParagraph xPara )
 114             raises( com::sun::star::lang::IllegalArgumentException );
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif