offapi/com/sun/star/view/XLineCursor.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: XLineCursor.idl,v $
  10  * $Revision: 1.12 $
  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_XLineCursor_idl__
  31 #define __com_sun_star_view_XLineCursor_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 by lines within laid out text.
  45
  46     @see com::sun::star::table::CellCursor
  47     @see com::sun::star::text::TextCursor
  48     @see com::sun::star::text::XTextViewCursor
  49  */
  50 published interface XLineCursor: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53     /** determines if the cursor is positioned at the start of a line.
  54      */
  55     boolean isAtStartOfLine();
  56
  57     //-------------------------------------------------------------------------
  58     /** determines if the cursor is positioned at the end of a line.
  59      */
  60     boolean isAtEndOfLine();
  61
  62     //-------------------------------------------------------------------------
  63     /** moves the cursor to the end of the current line.
  64
  65         @param bExpand
  66             determines whether the text range of the cursor is expanded (<TRUE/>)
  67             or the cursor will be just at the new position after the move (<FALSE/>).
  68      */
  69     void gotoEndOfLine( [in] boolean bExpand );
  70
  71     //-------------------------------------------------------------------------
  72     /** moves the cursor to the start of the current line.
  73
  74         @param bExpand
  75             determines whether the text range of the cursor is expanded (<TRUE/>)
  76             or the cursor will be just at the new position after the move (<FALSE/>).
  77      */
  78     void gotoStartOfLine( [in] boolean bExpand );
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif