LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XTextViewCursor Interface Referencepublished

describes a cursor in a text document's view. More...

import"XTextViewCursor.idl";

Inheritance diagram for XTextViewCursor:
XTextCursor XTextRange XInterface

Public Member Functions

boolean isVisible ()
 
void setVisible ([in] boolean bVisible)
 shows or hides this cursor for the user. More...
 
com::sun::star::awt::Point getPosition ()
 
- 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

describes a cursor in a text document's view.

Member Function Documentation

◆ getPosition()

com::sun::star::awt::Point getPosition ( )
Returns
the cursor's coordinates relative to the top left position of the first page of the document.

◆ isVisible()

boolean isVisible ( )
Returns
TRUE if this cursor is visible for the user.

◆ setVisible()

void setVisible ( [in] boolean  bVisible)

shows or hides this cursor for the user.


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