op.getCursor

Syntax op.getCursor ()

Params None required

Action Generates a number that can be used later by op.setCursor to return the cursor to its present heading even if the original cursor is moved in the interim.

Returns A number that has value only as an argument to be passed to op.setCursor

Examples In examples.Sample Outline 1, position the cursor on "Subhead 3, Summit 2" and then execute:
startPoint = op.getCursor ();

op.go (flatup, infinity);

clock.waitSeconds (3);

op.setCursor (startPoint)


   » true

If all goes well, you should see the cursor move to the summit of the outline, and then three seconds later you should see it return to the line on which it started.

Notes You can think of the marker as a unique tag that has no specific relationship to the heading's position in the outline.

The marker is guaranteed to remain valid only as long as the window remains open, or the target remains set, and as long as the original heading has not been deleted.

The most frequent use for this verb is when you are performing an operation on an outline that might relocate the cursor but you want to keep the operation transparent for the user.

See Also op.setCursor

op.go

op.setDisplay

op.getDisplay

Discuss