summaryrefslogtreecommitdiff
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.idl161
1 files changed, 161 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 000000000000..5083315cb8f0
--- /dev/null
+++ b/offapi/com/sun/star/text/XPageCursor.idl
@@ -0,0 +1,161 @@
+/*************************************************************************
+ *
+ * $RCSfile: XPageCursor.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:22:21 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library 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 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#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.
+ */
+[ uik(E2281242-33D6-11D1-AABE00A0-249D5590), ident( "XPageCursor", 1.0 ) ]
+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 jumpToPreviousPage()
+ */
+ boolean jumpToNextPage();
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToPreviousPage
+ /** moves the cursor to the previous page.@see jumpToNextPage()
+ */
+ boolean jumpToPreviousPage();
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: method com::sun::star::text::XPageCursor::jumpToEndOfPage
+ /** moves the cursor to the end of the current page.@see 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();
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+ $Log: not supported by cvs2svn $
+ Revision 1.1.1.1 2000/09/18 23:36:04 hjs
+ initial import
+
+ Revision 1.4 2000/09/11 11:53:02 mi
+ documentation merged from XML
+
+ Revision 1.2 2000/01/03 12:03:23 mi
+ reference manual
+
+ Revision 1.1.1.1 1999/11/11 09:48:46 jsc
+ new
+
+
+=============================================================================*/
+#endif