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
  21 module com {  module sun {  module star {  module text {
  22
  23
  24 /** provides functionality to ...
  25
  26     @since OOo 3.0
  27  */
  28
  29 interface XFlatParagraphIterator: com::sun::star::uno::XInterface
  30 {
  31
  32     /** get the first flat paragraph to be checked or an empty reference if
  33         there are no more paragraphs to check.
  34
  35         @returns
  36                 the paragraph.
  37     */
  38     com::sun::star::text::XFlatParagraph getFirstPara();
  39
  40     /** get the next flat paragraph to be checked or an empty reference if
  41         there are no more paragraphs to check.
  42
  43         @returns
  44                 the paragraph.
  45     */
  46     com::sun::star::text::XFlatParagraph getNextPara();
  47
  48     /** get the last flat paragraph
  49
  50         @returns
  51                 the paragraph.
  52     */
  53     com::sun::star::text::XFlatParagraph getLastPara();
  54
  55     /** get the flat paragraph before this one
  56
  57         @param  xPara
  58                 the current flat paragraph
  59
  60         @returns
  61                 the flat paragraph.
  62
  63         @throws IllegalArgumentException
  64                 if any argument is wrong.
  65     */
  66     com::sun::star::text::XFlatParagraph getParaBefore( [in] com::sun::star::text::XFlatParagraph xPara )
  67             raises( com::sun::star::lang::IllegalArgumentException );
  68
  69     /** get the flat paragraph just following this one
  70
  71         @param  xPara
  72                 the current flat paragraph
  73
  74         @returns
  75                 the flat paragraph.
  76
  77         @throws IllegalArgumentException
  78                 if any argument is wrong.
  79     */
  80     com::sun::star::text::XFlatParagraph getParaAfter( [in] com::sun::star::text::XFlatParagraph xPara )
  81             raises( com::sun::star::lang::IllegalArgumentException );
  82 };
  83
  84
  85 }; }; }; };
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */