xref: /aoo42x/main/offapi/com/sun/star/text/XPageCursor.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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