/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_text_XFlatParagraphIterator_idl__
#define __com_sun_star_text_XFlatParagraphIterator_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/text/XFlatParagraph.idl>


module com {  module sun {  module star {  module text {


/** provides functionality to ...

    @since OOo 3.0
 */

interface XFlatParagraphIterator: com::sun::star::uno::XInterface
{

    /** get the first flat paragraph to be checked or an empty reference if
        there are no more paragraphs to check.

        @returns
                the paragraph.
    */
    com::sun::star::text::XFlatParagraph getFirstPara();

    /** get the next flat paragraph to be checked or an empty reference if
        there are no more paragraphs to check.

        @returns
                the paragraph.
    */
    com::sun::star::text::XFlatParagraph getNextPara();

    /** get the last flat paragraph

        @returns
                the paragraph.
    */
    com::sun::star::text::XFlatParagraph getLastPara();

    /** get the flat paragraph before this one

        @param  xPara
                the current flat paragraph

        @returns
                the flat paragraph.

        @throws IllegalArgumentException
                if any argument is wrong.
    */
    com::sun::star::text::XFlatParagraph getParaBefore( [in] com::sun::star::text::XFlatParagraph xPara )
            raises( com::sun::star::lang::IllegalArgumentException );

    /** get the flat paragraph just following this one

        @param  xPara
                the current flat paragraph

        @returns
                the flat paragraph.

        @throws IllegalArgumentException
                if any argument is wrong.
    */
    com::sun::star::text::XFlatParagraph getParaAfter( [in] com::sun::star::text::XFlatParagraph xPara )
            raises( com::sun::star::lang::IllegalArgumentException );
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */