LibreOffice
LibreOffice 7.2 SDK API Reference
Public Member Functions | List of all members
XWordCursor Interface Referencepublished

makes it possible to move a cursor word by word. More...

import"XWordCursor.idl";

Inheritance diagram for XWordCursor:
XTextCursor XTextRange XInterface TextCursor TextLayoutCursor TextViewCursor

Public Member Functions

boolean isStartOfWord ()
 determines if the cursor is positioned at the start of a word. More...
 
boolean isEndOfWord ()
 determines if the cursor is positioned at the end of a word. More...
 
boolean gotoNextWord ([in] boolean bExpand)
 moves the cursor to the next word. More...
 
boolean gotoPreviousWord ([in] boolean bExpand)
 moves the cursor to the previous word. More...
 
boolean gotoEndOfWord ([in] boolean bExpand)
 moves the cursor to the end of the current word. More...
 
boolean gotoStartOfWord ([in] boolean bExpand)
 moves the cursor to the start of the current word. More...
 
- Public Member Functions inherited from XTextCursor
void collapseToStart ()
 sets the end of the position to the start. More...
 
void collapseToEnd ()
 sets the start of the position to the end. More...
 
boolean isCollapsed ()
 determines if the start and end positions are the same. More...
 
boolean goLeft ([in] short nCount, [in] boolean bExpand)
 moves the cursor the specified number of characters to the left. More...
 
boolean goRight ([in] short nCount, [in] boolean bExpand)
 moves the cursor the specified number of characters to the right. More...
 
void gotoStart ([in] boolean bExpand)
 moves the cursor to the start of the text. More...
 
void gotoEnd ([in] boolean bExpand)
 moves the cursor to the end of the text. More...
 
void gotoRange ([in] com::sun::star::text::XTextRange xRange, [in] boolean bExpand)
 moves or expands the cursor to a specified TextRange. More...
 
- Public Member Functions inherited from XTextRange
XText getText ()
 
XTextRange getStart ()
 
XTextRange getEnd ()
 
string getString ()
 
void setString ([in] string aString)
 the whole string of characters of this piece of text is replaced. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

makes it possible to move a cursor word by word.

Member Function Documentation

◆ gotoEndOfWord()

boolean gotoEndOfWord ( [in] boolean  bExpand)

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.

◆ gotoNextWord()

boolean gotoNextWord ( [in] boolean  bExpand)

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)

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.

◆ gotoStartOfWord()

boolean gotoStartOfWord ( [in] boolean  bExpand)

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.

◆ isEndOfWord()

boolean isEndOfWord ( )

determines if the cursor is positioned at the end of a word.

◆ isStartOfWord()

boolean isStartOfWord ( )

determines if the cursor is positioned at the start of a word.


The documentation for this interface was generated from the following file: