struct WordStep
- WordStep
- Struct
- Value
- Object
Overview
Advances the cursor to the beginning or to the end of the word the speculative next character lands in, depending on whether the movement's direction is left or right, respectively.
Included Modules
Defined in:
aspis/step.crConstructors
Instance Method Summary
-
#advance(document : Document, prev : Int, nxt : Int) : Int
Returns the next cursor index.
- #initialize
Instance methods inherited from module CursorStep
advance(document : Document, prev : Int, nxt : Int) : Int
advance
Constructor Detail
Instance Method Detail
Description copied from module CursorStep
Returns the next cursor index.
prev and nxt are indices belonging to document.
prev index is the previous index (where motion started).
nxt index is the speculative, character-based next index. It might be out of document's bounds.
The latter is usually the index you'd need to change/snap,
as a CursorStep implementor. The former is given to you
so you can e.g. compute delta or determine the direction
of the movement.
The returned index must be in bounds of the document.