offapi/com/sun/star/view/XLineCursor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_view_XLineCursor_idl__
  28 #define __com_sun_star_view_XLineCursor_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module view {
  38
  39 //=============================================================================
  40
  41 /** makes it possible to move a cursor by lines within laid out text.
  42
  43     @see com::sun::star::table::CellCursor
  44     @see com::sun::star::text::TextCursor
  45     @see com::sun::star::text::XTextViewCursor
  46  */
  47 published interface XLineCursor: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50     /** determines if the cursor is positioned at the start of a line.
  51      */
  52     boolean isAtStartOfLine();
  53
  54     //-------------------------------------------------------------------------
  55     /** determines if the cursor is positioned at the end of a line.
  56      */
  57     boolean isAtEndOfLine();
  58
  59     //-------------------------------------------------------------------------
  60     /** moves the cursor to the end of the current line.
  61
  62         @param bExpand
  63             determines whether the text range of the cursor is expanded (<TRUE/>)
  64             or the cursor will be just at the new position after the move (<FALSE/>).
  65      */
  66     void gotoEndOfLine( [in] boolean bExpand );
  67
  68     //-------------------------------------------------------------------------
  69     /** moves the cursor to the start of the current line.
  70
  71         @param bExpand
  72             determines whether the text range of the cursor is expanded (<TRUE/>)
  73             or the cursor will be just at the new position after the move (<FALSE/>).
  74      */
  75     void gotoStartOfLine( [in] boolean bExpand );
  76
  77 };
  78
  79 //=============================================================================
  80
  81 }; }; }; };
  82
  83 #endif