Class

NSTextAlternatives

A list of alternative strings for a piece of text.

Declaration

@interface NSTextAlternatives : NSObject

Overview

NSTextAlternatives is an immutable value class that stores a list of alternatives for a piece of text and communicates the user’s selection of an alternative via a notification to your app. To support dictation, for example, you might use NSTextAlternatives to present a list of alternative interpretations for a word or phrase the user speaks. If the user chooses to replace the initial interpretation with an alternative, NSTextAlternatives notifies you of the choice so that you can update the text appropriately.

NSTextAlternatives instances are attached to attributed strings as the value of a text attribute, NSTextAlternativesAttributeName.

Topics

Initializing a Text Alternatives Object

- initWithPrimaryString:alternativeStrings:

Initializes an NSTextAlternatives instance.

Storing Alternative Text Strings

primaryString

The text that was initially chosen as the input string.

alternativeStrings

An array of alternative possible interpretations that the user might select.

Selecting an Alternative String

- noteSelectedAlternativeString:

Sent to the NSTextAlternatives object by the text view when the user chooses one of the alternative strings.

Notifications

NSTextAlternativesSelectedAlternativeStringNotification

Posted when the user selects an alternate string.

Relationships

Inherits From

Conforms To

See Also

Input Management

NSTextInput

A set of methods that text views must implement to interact properly with the text input management system.

NSTextInputClient

A set of methods that text views must implement to interact properly with the text input management system.

NSTextInputContext

An object that represents the Cocoa text input system.