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