LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XViewCursor Interface Referencepublished

makes it possible to move a cursor up/down/left/right within laid out text. More...

import"XViewCursor.idl";

Inheritance diagram for XViewCursor:
XInterface

Public Member Functions

boolean goDown ([in] short nCount, [in] boolean bExpand)
 moves the cursor the specified number of lines down. More...
 
boolean goUp ([in] short nCount, [in] boolean bExpand)
 moves the cursor the specified number of lines up. 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...
 
- 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 up/down/left/right within laid out text.

See also
com::sun::star::table::CellCursor
com::sun::star::text::TextCursor
com::sun::star::view::XLineCursor

Member Function Documentation

boolean goDown ( [in] short  nCount,
[in] boolean  bExpand 
)

moves the cursor the specified number of lines down.

Parameters
nCountspecifies the number of lines to go down.
bExpanddetermines whether the text range of the cursor is expanded (TRUE) or the cursor will be just at the new position after the move (FALSE).
Returns
TRUE if the cursor was moved, or FALSE if it was already in the bottom row.
boolean goLeft ( [in] short  nCount,
[in] boolean  bExpand 
)

moves the cursor the specified number of characters to the left.

Parameters
nCountspecifies the number of characters to move.
bExpanddetermines whether the text range of the cursor is expanded (TRUE)
Returns
TRUE if the cursor was moved, or FALSE if it was already at the leftmost position.
boolean goRight ( [in] short  nCount,
[in] boolean  bExpand 
)

moves the cursor the specified number of characters to the right.

Parameters
nCountspecifies the number of characters to move.
bExpanddetermines whether the text range of the cursor is expanded (TRUE)
Returns
TRUE if the cursor was moved, or FALSE if it was already at the rightmost position.
boolean goUp ( [in] short  nCount,
[in] boolean  bExpand 
)

moves the cursor the specified number of lines up.

Parameters
nCountspecifies the number of lines to go up.
bExpanddetermines whether the text range of the cursor is expanded (TRUE)
Returns
TRUE if the cursor was moved, or FALSE if it was already in the top row.

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