offapi/com/sun/star/view/XScreenCursor.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_view_XScreenCursor_idl__
  29 #define __com_sun_star_view_XScreenCursor_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module view {
  37
  38 //=============================================================================
  39
  40 /** makes it possible to page through the document in steps of the displayed size.
  41  */
  42 published interface XScreenCursor: com::sun::star::uno::XInterface
  43 {
  44     //-------------------------------------------------------------------------
  45     /** scrolls the view forward by one visible page.
  46      */
  47     boolean screenDown();
  48
  49     //-------------------------------------------------------------------------
  50     /** scrolls the view backward by one visible page.
  51      */
  52     boolean screenUp();
  53
  54 };
  55
  56 //=============================================================================
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */