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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_text_XFlatParagraphIterator_idl__
  21 #define __com_sun_star_text_XFlatParagraphIterator_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/text/XFlatParagraph.idl>
  26
  27
  28 module com {  module sun {  module star {  module text {
  29
  30
  31 /** provides functionality to ...
  32
  33     @since OOo 3.0
  34  */
  35
  36 interface XFlatParagraphIterator: com::sun::star::uno::XInterface
  37 {
  38
  39     /** get the first flat paragraph to be checked or an empty reference if
  40         there are no more paragraphs to check.
  41
  42         @returns
  43                 the paragraph.
  44     */
  45     com::sun::star::text::XFlatParagraph getFirstPara();
  46
  47     /** get the next flat paragraph to be checked or an empty reference if
  48         there are no more paragraphs to check.
  49
  50         @returns
  51                 the paragraph.
  52     */
  53     com::sun::star::text::XFlatParagraph getNextPara();
  54
  55     /** get the last flat paragraph
  56
  57         @returns
  58                 the paragraph.
  59     */
  60     com::sun::star::text::XFlatParagraph getLastPara();
  61
  62     /** get the flat paragraph before this one
  63
  64         @param  xPara
  65                 the current flat paragraph
  66
  67         @returns
  68                 the flat paragraph.
  69
  70         @throws IllegalArgumentException
  71                 if any argument is wrong.
  72     */
  73     com::sun::star::text::XFlatParagraph getParaBefore( [in] com::sun::star::text::XFlatParagraph xPara )
  74             raises( com::sun::star::lang::IllegalArgumentException );
  75
  76     /** get the flat paragraph just following this one
  77
  78         @param  xPara
  79                 the current flat paragraph
  80
  81         @returns
  82                 the flat paragraph.
  83
  84         @throws IllegalArgumentException
  85                 if any argument is wrong.
  86     */
  87     com::sun::star::text::XFlatParagraph getParaAfter( [in] com::sun::star::text::XFlatParagraph xPara )
  88             raises( com::sun::star::lang::IllegalArgumentException );
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */