Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: view ::

interface XViewCursor

Base Interface
com::sun::star::uno::XInterface

Description
makes it possible to move a cursor up/down/left/right within laid out text.
See also
com::sun::star::sheet::CellCursor
See also
com::sun::star::text::TextCursor
See also
com::sun::star::view::LineCursor


Methods' Summary

goDown moves the cursor the specified number of lines down.
goUp moves the cursor the specified number of lines up.
goLeft moves the cursor the specified number of characters to the left.
goRight moves the cursor the specified number of characters to the right.

Methods' Details

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

Description
moves the cursor the specified number of lines down.
Parameter nCount
specifies the number of lines to go down.
Parameter bExpand
determines 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.
goUp
 
boolean
goUp(
[ in ] short nCount,
[ in ] boolean bExpand );

Description
moves the cursor the specified number of lines up.
Parameter nCount
specifies the number of lines to go up.
Parameter bExpand
determines 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.
goLeft
 
boolean
goLeft(
[ in ] short nCount,
[ in ] boolean bExpand );

Description
moves the cursor the specified number of characters to the left.
Parameter nCount
specifies the number of characters to move.
Parameter bExpand
determines 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.
goRight
 
boolean
goRight(
[ in ] short nCount,
[ in ] boolean bExpand );

Description
moves the cursor the specified number of characters to the right.
Parameter nCount
specifies the number of characters to move.
Parameter bExpand
determines 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.

Top of Page