1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_XPageCursor_idl__
28#define __com_sun_star_text_XPageCursor_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module text {
38
39//=============================================================================
40
41// DocMerge from xml: interface com::sun::star::text::XPageCursor
42/** makes it possible to perform cursor movements between pages.
43 */
44published interface XPageCursor: com::sun::star::uno::XInterface
45{
46	//-------------------------------------------------------------------------
47
48	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToFirstPage
49	/** moves the cursor to the first page.
50	 */
51	boolean jumpToFirstPage();
52
53	//-------------------------------------------------------------------------
54
55	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToLastPage
56	/** moves the cursor to the last page.
57	 */
58	boolean jumpToLastPage();
59
60	//-------------------------------------------------------------------------
61
62	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToPage
63	/** moves the cursor to the specified page.
64	 */
65	boolean jumpToPage( [in] short nPage );
66
67	//-------------------------------------------------------------------------
68
69	// DocMerge from idl: method com::sun::star::text::XPageCursor::getPage
70	/** @returns
71				the number of the page within the document of this cursor.
72	 */
73	short getPage();
74
75	//-------------------------------------------------------------------------
76
77	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToNextPage
78	/** moves the cursor to the next page.
79
80		@see XPageCursor::jumpToPreviousPage
81	 */
82	boolean jumpToNextPage();
83
84	//-------------------------------------------------------------------------
85
86	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToPreviousPage
87	/** moves the cursor to the previous page.
88
89		@see XPageCursor::jumpToNextPage
90	 */
91	boolean jumpToPreviousPage();
92
93	//-------------------------------------------------------------------------
94
95	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToEndOfPage
96	/** moves the cursor to the end of the current page.
97
98		@see XPageCursor::jumpToEndOfPreviousPage
99	 */
100	boolean jumpToEndOfPage();
101
102	//-------------------------------------------------------------------------
103
104	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToStartOfPage
105	/** moves the cursor to the start of the current page.
106	 */
107	boolean jumpToStartOfPage();
108
109};
110
111//=============================================================================
112
113}; }; }; };
114
115#endif
116