offapi/com/sun/star/text/XWordCursor.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: XWordCursor.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_text_XWordCursor_idl__
  31 #define __com_sun_star_text_XWordCursor_idl__
  32
  33 #ifndef __com_sun_star_text_XTextCursor_idl__
  34 #include <com/sun/star/text/XTextCursor.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module text {
  41
  42 //=============================================================================
  43
  44 /** makes it possible to move a cursor word by word.
  45  */
  46 published interface XWordCursor: com::sun::star::text::XTextCursor
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** determines if the cursor is positioned at the start of a word.
  51      */
  52     boolean isStartOfWord();
  53
  54     //-------------------------------------------------------------------------
  55
  56     /** determines if the cursor is positioned at the end of a word.
  57      */
  58     boolean isEndOfWord();
  59
  60     //-------------------------------------------------------------------------
  61
  62     /** moves the cursor to the next word.
  63
  64         <p>Note: the function returning <true/> does not necessarily mean
  65         that the cursor is located at the next word, or any word at all!
  66         This may happen for example if it travels over empty paragraphs.</p>
  67
  68         @returns
  69             <true/> if the cursor was moved. It returns <false/> it the
  70             cursor can not advance further.
  71      */
  72     boolean gotoNextWord( [in] boolean bExpand );
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** moves the cursor to the previous word.
  77
  78         <p>Note: the function returning <true/> does not necessarily mean
  79         that the cursor is located at the previous word, or any word at all!
  80         This may happen for example if it travels over empty paragraphs.</p>
  81
  82         @returns
  83             <true/> if the cursor was moved. It returns <false/> it the
  84             cursor can not advance further.
  85      */
  86     boolean gotoPreviousWord( [in] boolean bExpand );
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** moves the cursor to the end of the current word.
  91
  92         @returns
  93             <true/> if the cursor is now at the end of a word,
  94             <false/> otherwise. If <false/> was returned the cursor
  95             will remain at its original position.
  96      */
  97     boolean gotoEndOfWord( [in] boolean bExpand );
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** moves the cursor to the start of the current word.
 102
 103         @returns
 104             <true/> if the cursor is now at the start of a word,
 105             <false/> otherwise. If <false/> was returned the cursor
 106             will remain at its original position.
 107      */
 108     boolean gotoStartOfWord( [in] boolean bExpand );
 109
 110 };
 111
 112 //=============================================================================
 113
 114 }; }; }; };
 115
 116 #endif