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 © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.