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