Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: text ::

interface XWordCursor
Base Interfaces
XWordCursor
┗ XTextCursor
   ┗ XTextRange
XTextCursor
(referenced interface's summary:)
extends a text range by method to modify its position.
Description
makes it possible to move a cursor word by word.
Methods' Summary
isStartOfWord determines if the cursor is positioned at the start of a word.  
isEndOfWord determines if the cursor is positioned at the end of a word.  
gotoNextWord moves the cursor to the next word.  
gotoPreviousWord moves the cursor to the previous word.  
gotoEndOfWord moves the cursor to the end of the current word.  
gotoStartOfWord moves the cursor to the start of the current word.  
Methods' Details
isStartOfWord
boolean
isStartOfWord();
Description
determines if the cursor is positioned at the start of a word.
isEndOfWord
boolean
isEndOfWord();
Description
determines if the cursor is positioned at the end of a word.
gotoNextWord
boolean
gotoNextWord( [in] boolean  bExpand );
Description
moves the cursor to the next word.

Note: the function returning true does not necessarily mean that the cursor is located at the next word, or any word at all! This may happen for example if it travels over empty paragraphs.

Returns
true if the cursor was moved. It returns false it the cursor can not advance further.
gotoPreviousWord
boolean
gotoPreviousWord( [in] boolean  bExpand );
Description
moves the cursor to the previous word.

Note: the function returning true does not necessarily mean that the cursor is located at the previous word, or any word at all! This may happen for example if it travels over empty paragraphs.

Returns
true if the cursor was moved. It returns false it the cursor can not advance further.
gotoEndOfWord
boolean
gotoEndOfWord( [in] boolean  bExpand );
Description
moves the cursor to the end of the current word.
Returns
true if the cursor is now at the end of a word, false otherwise. If false was returned the cursor will remain at its original position.
gotoStartOfWord
boolean
gotoStartOfWord( [in] boolean  bExpand );
Description
moves the cursor to the start of the current word.
Returns
true if the cursor is now at the start of a word, false otherwise. If false was returned the cursor will remain at its original position.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.