/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XPageCursor.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 06:43:58 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XPageCursor_idl__
#define __com_sun_star_text_XPageCursor_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


//=============================================================================

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

//=============================================================================

// DocMerge from xml: interface com::sun::star::text::XPageCursor
/** makes it possible to perform cursor movements between pages.
 */
published interface XPageCursor: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToFirstPage
    /** moves the cursor to the first page.
     */
    boolean jumpToFirstPage();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToLastPage
    /** moves the cursor to the last page.
     */
    boolean jumpToLastPage();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToPage
    /** moves the cursor to the specified page.
     */
    boolean jumpToPage( [in] short nPage );

    //-------------------------------------------------------------------------

    // DocMerge from idl: method com::sun::star::text::XPageCursor::getPage
    /** @returns
                the number of the page within the document of this cursor.
     */
    short getPage();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToNextPage
    /** moves the cursor to the next page.

        @see XPageCursor::jumpToPreviousPage
     */
    boolean jumpToNextPage();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToPreviousPage
    /** moves the cursor to the previous page.

        @see XPageCursor::jumpToNextPage
     */
    boolean jumpToPreviousPage();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToEndOfPage
    /** moves the cursor to the end of the current page.

        @see XPageCursor::jumpToEndOfPreviousPage
     */
    boolean jumpToEndOfPage();

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToStartOfPage
    /** moves the cursor to the start of the current page.
     */
    boolean jumpToStartOfPage();

};

//=============================================================================

}; }; }; };

#endif
