1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_XPageCursor_idl__
24#define __com_sun_star_text_XPageCursor_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33module com {  module sun {  module star {  module text {
34
35//=============================================================================
36
37// DocMerge from xml: interface com::sun::star::text::XPageCursor
38/** makes it possible to perform cursor movements between pages.
39 */
40published interface XPageCursor: com::sun::star::uno::XInterface
41{
42	//-------------------------------------------------------------------------
43
44	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToFirstPage
45	/** moves the cursor to the first page.
46	 */
47	boolean jumpToFirstPage();
48
49	//-------------------------------------------------------------------------
50
51	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToLastPage
52	/** moves the cursor to the last page.
53	 */
54	boolean jumpToLastPage();
55
56	//-------------------------------------------------------------------------
57
58	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToPage
59	/** moves the cursor to the specified page.
60	 */
61	boolean jumpToPage( [in] short nPage );
62
63	//-------------------------------------------------------------------------
64
65	// DocMerge from idl: method com::sun::star::text::XPageCursor::getPage
66	/** @returns
67				the number of the page within the document of this cursor.
68	 */
69	short getPage();
70
71	//-------------------------------------------------------------------------
72
73	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToNextPage
74	/** moves the cursor to the next page.
75
76		@see XPageCursor::jumpToPreviousPage
77	 */
78	boolean jumpToNextPage();
79
80	//-------------------------------------------------------------------------
81
82	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToPreviousPage
83	/** moves the cursor to the previous page.
84
85		@see XPageCursor::jumpToNextPage
86	 */
87	boolean jumpToPreviousPage();
88
89	//-------------------------------------------------------------------------
90
91	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToEndOfPage
92	/** moves the cursor to the end of the current page.
93
94		@see XPageCursor::jumpToEndOfPreviousPage
95	 */
96	boolean jumpToEndOfPage();
97
98	//-------------------------------------------------------------------------
99
100	// DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToStartOfPage
101	/** moves the cursor to the start of the current page.
102	 */
103	boolean jumpToStartOfPage();
104
105};
106
107//=============================================================================
108
109}; }; }; };
110
111#endif
112