offapi/com/sun/star/view/XViewCursor.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_XViewCursor_idl__
  29 #define __com_sun_star_view_XViewCursor_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 move a cursor up/down/left/right within laid out text.
  41
  42     @see com::sun::star::table::CellCursor
  43     @see com::sun::star::text::TextCursor
  44     @see com::sun::star::view::XLineCursor
  45  */
  46 published interface XViewCursor: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49     /** moves the cursor the specified number of lines down.
  50
  51         @param nCount
  52             specifies the number of lines to go down.
  53
  54         @param bExpand
  55             determines whether the text range of the cursor is expanded (<TRUE/>)
  56             or the cursor will be just at the new position after the move (<FALSE/>).
  57
  58         @returns
  59             <TRUE/> if the cursor was moved,
  60             or <FALSE/> if it was already in the bottom row.
  61      */
  62     boolean goDown( [in] short nCount, [in] boolean bExpand );
  63
  64     //-------------------------------------------------------------------------
  65     /** moves the cursor the specified number of lines up.
  66
  67         @param nCount
  68             specifies the number of lines to go up.
  69
  70         @param bExpand
  71             determines whether the text range of the cursor is expanded (<TRUE/>)
  72
  73         @returns
  74             <TRUE/> if the cursor was moved,
  75             or <FALSE/> if it was already in the top row.
  76      */
  77     boolean goUp( [in] short nCount, [in] boolean bExpand );
  78
  79     //-------------------------------------------------------------------------
  80     /** moves the cursor the specified number of characters to the left.
  81
  82         @param nCount
  83             specifies the number of characters to move.
  84
  85         @param bExpand
  86             determines whether the text range of the cursor is expanded (<TRUE/>)
  87
  88         @returns
  89             <TRUE/> if the cursor was moved,
  90             or <FALSE/> if it was already at the leftmost position.
  91      */
  92     boolean goLeft( [in] short nCount, [in] boolean bExpand );
  93
  94     //-------------------------------------------------------------------------
  95     /** moves the cursor the specified number of characters to the right.
  96
  97         @param nCount
  98             specifies the number of characters to move.
  99
 100         @param bExpand
 101             determines whether the text range of the cursor is expanded (<TRUE/>)
 102
 103         @returns
 104             <TRUE/> if the cursor was moved,
 105             or <FALSE/> if it was already at the rightmost position.
 106      */
 107     boolean goRight( [in] short nCount, [in] boolean bExpand );
 108
 109 };
 110
 111 //=============================================================================
 112
 113 }; }; }; };
 114
 115 #endif
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */