Writer/API/Text cursor
A text cursor can only move within the text range of the text object in which it was created. Thus a text cursor that is created for the main document's text range can not move inside a table.
Contents
Creating a text cursor
A common thing to do is to create a text cursor which has the same location as the view cursor, as follows:
oVC = thisComponent.getCurrentController.getViewCursor oCursor = oVC.getText.createTextCursorByRange(oVC)
If you want a cursor for the text in the main document:
oCursor = thisComponent.getText.createTextCursor 'or oText = thisComponent.getText oCursor = oText.createTextCursorByRange(oText.getStart)
NOTE: here is only ONE View Cursor but you can have many non-visible Text Cursors
Start and End of a text cursor
A cursor has the methods getStart, and getEnd. Which is the Start end and which is the End end of the selection is determined by the direction in which the selection was made.
However, the methods collapseToStart and collapseToEnd are relative to the start and end of the document.
Moving a cursor
A cursor has a number of gotoXXX where XXX is some relative location. In each case there is always a boolean parameter for "extending the selection". When this parameter is set to true the selection is extended from the current selection to the new location.
There is no method for adding to the selection. While the view cursor can have more than one selection, text cursors only have one selection.
The gotoXXX methods return true if they were able to execute the movement, false otherwise.
bExtend = false oCursor.goLeft(5, bExtend) 'go left 5 characters oCursor.goRight(10, bExtend) 'go right 10 characters oCursor.goUp(1, bExtend) 'go up one line oCursor.goDown(2, bExtend) 'go down two lines oCursor.gotoStart(bExtend) 'go to the start of the text range oCursor.gotoEnd(bExtend) 'go to the end of the text range oCursor.gotoRange(oVC, false)'go to the same range as the view cursor (error if oVC not in same text range) oCursor.gotoNextWord(bExtend) oCursor.gotoPreviousWord(bExtend) oCursor.gotoEndOfWord(bExtend) oCursor.gotoStartOfWord(bExtend) oCursor.gotoNextSentence(bExtend) oCursor.gotoPreviousSentence(bExtend) oCursor.gotoStartOfSentence(bExtend) oCursor.gotoEndOfSentence(bExtend) oCursor.gotoStartOfParagraph(bExtend) oCursor.gotoEndOfParagraph(bExtend) oCursor.gotoNextParagraph(bExtend) oCursor.gotoPreviousParagraph(bExtend) oCursor.JumpToFirstPage(bExtend) oCursor.JumpToLastPage(bExtend) oCursor.JumpToPage(5,bExtend) 'go to page 5 oCursor.JumpToPreviousPage(bExtend) oCursor.JumpToNextPage(bExtend) oCursor.JumpToStartOfPage(bExtend) oCursor.JumpToEndOfPage(bExtend) oCursor.ScreenUp(bExtend) oCursor.ScreenDown(bExtend)
Checking a cursor
To check if the text cursor is at the beginning or the end of a line.
If oCursor.isAtStartOfLine() then print "Text cursor is at the Start of the line" If oCursor.isAtEndOfLine() then print "Text cursor is at the End of the line" If oCursor.IsVisible() then print "This text cursor is visible (aka the View Cursor)"
Getting text from a cursor
If you manage to select text with the Text Cursor, you can see what you have selected
Print oCursor.string 'without formatting
To see a full list of a Text Cursor's methods.
MsgBox oCursor.DBG_methods
