Instance Method

insertCompletion:forPartialWordRange:movement:isFinal:

Inserts the selected completion into the text at the appropriate location.

Declaration

- (void)insertCompletion:(NSString *)word forPartialWordRange:(NSRange)charRange movement:(NSInteger)movement isFinal:(BOOL)flag;

Parameters

word

The text to insert, including the matched partial word and its potential completion.

charRange

The range of characters of the matched partial word to be completed.

movement

The direction of movement. For possible values see the NSText Constants section. This value allows subclasses to distinguish between canceling completion and selection by arrow keys, by return, by tab, or by other means such as clicking.

flag

NO while the user navigates through the potential text completions, YES when a completion is definitively selected or cancelled and the original value is reinserted.

Discussion

This method has two effects, text substitution and changing of the selection:

  • It replaces the text between charRange.start and the current insertion point with word.

  • If flag is NO it changes the selection to be the last n characters of word where n is equal to [word length] minus charRange.length, that is, the potential completion.

  • If flag is YES it makes the selection empty and puts the insertion point just after word.

See Also

Text Completion

- complete:

Invokes completion in a text view.

- completionsForPartialWordRange:indexOfSelectedItem:

Returns an array of potential completions, in the order to be presented, representing possible word completions available from a partial word.

rangeForUserCompletion

The partial range from the most recent beginning of a word up to the insertion point.