offapi/com/sun/star/text/XPageCursor.idl

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