|
LibreOffice
LibreOffice 25.2 SDK API Reference
|
extends a text range by method to modify its position. More...
import"XTextCursor.idl";
Public Member Functions | |
| 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... | |
extends a text range by method to modify its position.
| void collapseToEnd | ( | ) |
sets the start of the position to the end.
| void collapseToStart | ( | ) |
sets the end of the position to the start.
| boolean goLeft | ( | [in] short | nCount, |
| [in] boolean | bExpand | ||
| ) |
moves the cursor the specified number of characters to the left.
| nCount | the number of characters to move. |
| bExpand | specifies if the current selection of the cursor should be expanded or not. |
TRUE if the command was successfully completed. FALSE otherwise.Note: Even if the command was not completed successfully it may be completed partially. E.g. if it was required to move 5 characters but it is only possible to move 3 FALSE will be returned and the cursor moves only those 3 characters.
| boolean goRight | ( | [in] short | nCount, |
| [in] boolean | bExpand | ||
| ) |
moves the cursor the specified number of characters to the right.
| nCount | the number of characters to move. |
| bExpand | specifies if the current selection of the cursor should be expanded or not. |
TRUE if the command was successfully completed. FALSE otherwise.Note: Even if the command was not completed successfully it may be completed partially. E.g. if it was required to move 5 characters but it is only possible to move 3 FALSE will be returned and the cursor moves only those 3 characters.
| void gotoEnd | ( | [in] boolean | bExpand | ) |
moves the cursor to the end of the text.
| void gotoRange | ( | [in] com::sun::star::text::XTextRange | xRange, |
| [in] boolean | bExpand | ||
| ) |
moves or expands the cursor to a specified TextRange.
| void gotoStart | ( | [in] boolean | bExpand | ) |
moves the cursor to the start of the text.
| boolean isCollapsed | ( | ) |
determines if the start and end positions are the same.
1.8.14