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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_text_XPageCursor_idl__
  20 #define __com_sun_star_text_XPageCursor_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26 module com {  module sun {  module star {  module text {
  27
  28 /** makes it possible to perform cursor movements between pages.
  29  */
  30 published interface XPageCursor: com::sun::star::uno::XInterface
  31 {
  32     /** moves the cursor to the first page.
  33      */
  34     boolean jumpToFirstPage();
  35
  36     /** moves the cursor to the last page.
  37      */
  38     boolean jumpToLastPage();
  39
  40     /** moves the cursor to the specified page.
  41      */
  42     boolean jumpToPage( [in] short nPage );
  43
  44     /** @returns
  45                 the number of the page within the document of this cursor.
  46      */
  47     short getPage();
  48
  49     /** moves the cursor to the next page.
  50
  51         @see XPageCursor::jumpToPreviousPage
  52      */
  53     boolean jumpToNextPage();
  54
  55     /** moves the cursor to the previous page.
  56
  57         @see XPageCursor::jumpToNextPage
  58      */
  59     boolean jumpToPreviousPage();
  60
  61     /** moves the cursor to the end of the current page.
  62
  63         @see XPageCursor::jumpToEndOfPreviousPage
  64      */
  65     boolean jumpToEndOfPage();
  66
  67     /** moves the cursor to the start of the current page.
  68      */
  69     boolean jumpToStartOfPage();
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */