summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/XPageCursor.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/text/XPageCursor.idl')
-rw-r--r--offapi/com/sun/star/text/XPageCursor.idl78
1 files changed, 78 insertions, 0 deletions
diff --git a/offapi/com/sun/star/text/XPageCursor.idl b/offapi/com/sun/star/text/XPageCursor.idl
new file mode 100644
index 000000000..9d65b326a
--- /dev/null
+++ b/offapi/com/sun/star/text/XPageCursor.idl
@@ -0,0 +1,78 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * 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 .
+ */
+#ifndef __com_sun_star_text_XPageCursor_idl__
+#define __com_sun_star_text_XPageCursor_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+
+module com { module sun { module star { module text {
+
+/** makes it possible to perform cursor movements between pages.
+ */
+published interface XPageCursor: com::sun::star::uno::XInterface
+{
+ /** moves the cursor to the first page.
+ */
+ boolean jumpToFirstPage();
+
+ /** moves the cursor to the last page.
+ */
+ boolean jumpToLastPage();
+
+ /** moves the cursor to the specified page.
+ */
+ boolean jumpToPage( [in] short nPage );
+
+ /** @returns
+ the number of the page within the document of this cursor.
+ */
+ short getPage();
+
+ /** moves the cursor to the next page.
+
+ @see XPageCursor::jumpToPreviousPage
+ */
+ boolean jumpToNextPage();
+
+ /** moves the cursor to the previous page.
+
+ @see XPageCursor::jumpToNextPage
+ */
+ boolean jumpToPreviousPage();
+
+ /** moves the cursor to the end of the current page.
+
+ @see XPageCursor::jumpToEndOfPreviousPage
+ */
+ boolean jumpToEndOfPage();
+
+ /** moves the cursor to the start of the current page.
+ */
+ boolean jumpToStartOfPage();
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */