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

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