xref: /aoo41x/main/offapi/com/sun/star/text/XPageCursor.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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