/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XViewCursor.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 09:29:40 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_view_XViewCursor_idl__
#define __com_sun_star_view_XViewCursor_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module view {

//=============================================================================

/** makes it possible to move a cursor up/down/left/right within laid out text.

    @see com::sun::star::table::CellCursor
    @see com::sun::star::text::TextCursor
    @see com::sun::star::view::XLineCursor
 */
published interface XViewCursor: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** moves the cursor the specified number of lines down.

        @param nCount
            specifies the number of lines to go down.

        @param bExpand
            determines whether the text range of the cursor is expanded (<TRUE/>)
            or the cursor will be just at the new position after the move (<FALSE/>).

        @returns
            <TRUE/> if the cursor was moved,
            or <FALSE/> if it was already in the bottom row.
     */
    boolean goDown( [in] short nCount, [in] boolean bExpand );

    //-------------------------------------------------------------------------
    /** moves the cursor the specified number of lines up.

        @param nCount
            specifies the number of lines to go up.

        @param bExpand
            determines whether the text range of the cursor is expanded (<TRUE/>)

        @returns
            <TRUE/> if the cursor was moved,
            or <FALSE/> if it was already in the top row.
     */
    boolean goUp( [in] short nCount, [in] boolean bExpand );

    //-------------------------------------------------------------------------
    /** moves the cursor the specified number of characters to the left.

        @param nCount
            specifies the number of characters to move.

        @param bExpand
            determines whether the text range of the cursor is expanded (<TRUE/>)

        @returns
            <TRUE/> if the cursor was moved,
            or <FALSE/> if it was already at the leftmost position.
     */
    boolean goLeft( [in] short nCount, [in] boolean bExpand );

    //-------------------------------------------------------------------------
    /** moves the cursor the specified number of characters to the right.

        @param nCount
            specifies the number of characters to move.

        @param bExpand
            determines whether the text range of the cursor is expanded (<TRUE/>)

        @returns
            <TRUE/> if the cursor was moved,
            or <FALSE/> if it was already at the rightmost position.
     */
    boolean goRight( [in] short nCount, [in] boolean bExpand );

};

//=============================================================================

}; }; }; };

#endif
