/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XLineCursor.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 09:25:14 $
 *
 *  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_XLineCursor_idl__
#define __com_sun_star_view_XLineCursor_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 by lines within laid out text.

    @see com::sun::star::table::CellCursor
    @see com::sun::star::text::TextCursor
    @see com::sun::star::text::XTextViewCursor
 */
published interface XLineCursor: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** determines if the cursor is positioned at the start of a line.
     */
    boolean isAtStartOfLine();

    //-------------------------------------------------------------------------
    /** determines if the cursor is positioned at the end of a line.
     */
    boolean isAtEndOfLine();

    //-------------------------------------------------------------------------
    /** moves the cursor to the end of the current line.

        @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/>).
     */
    void gotoEndOfLine( [in] boolean bExpand );

    //-------------------------------------------------------------------------
    /** moves the cursor to the start of the current line.

        @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/>).
     */
    void gotoStartOfLine( [in] boolean bExpand );

};

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

}; }; }; };

#endif
