Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: text ::
interface XTextCursor
  Base Interfaces
      XTextCursor
      ┗ XTextRange
  XTextRange | (referenced interface's summary:) describes the object's position in a text.
Description extends a text range by method to modify its position.

Methods' Summary
collapseToStart | sets the end of the position to the start.
collapseToEnd | sets the start of the position to the end.
isCollapsed | determines if the start and end positions are the same.
goLeft | moves the cursor the specified number of characters to the left.
goRight | moves the cursor the specified number of characters to the right.
gotoStart | moves the cursor to the start of the text.
gotoEnd | moves the cursor to the end of the text.
gotoRange | moves or expands the cursor to a specified TextRange.

Methods' Details
collapseToStart
void
collapseToStart();
Description sets the end of the position to the start.
collapseToEnd
void
collapseToEnd();
Description sets the start of the position to the end.
isCollapsed
boolean
isCollapsed();
Description determines if the start and end positions are the same.
goLeft
boolean
goLeft( | [in] short | nCount,
| [in] boolean | bExpand );
Description moves the cursor the specified number of characters to the left. Parameter nCount the number of characters to move. Parameter bExpand specifies if the current selection of the cursor should be expanded or not. Returns 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.
goRight
boolean
goRight( | [in] short | nCount,
| [in] boolean | bExpand );
Description moves the cursor the specified number of characters to the right. Parameter nCount the number of characters to move. Parameter bExpand specifies if the current selection of the cursor should be expanded or not. Returns 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.
gotoStart
void
gotoStart( | [in] boolean | bExpand );
Description moves the cursor to the start of the text.
gotoEnd
void
gotoEnd( | [in] boolean | bExpand );
Description moves the cursor to the end of the text.
gotoRange
void
gotoRange( | [in] XTextRange | xRange,
| [in] boolean | bExpand );
Description moves or expands the cursor to a specified TextRange.

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.