Class

NSCandidateListTouchBarItem

A bar item that, along with its delegate, provides a list of textual suggestions for the current text view.

Declaration

@interface NSCandidateListTouchBarItem<__covariant CandidateType> : NSTouchBarItem

Topics

Providing a Client and a Delegate

client

The client object for the candidate list item.

delegate

The delegate of the candidate list item.

NSCandidateListTouchBarItemDelegate

A set of methods that a candidate list item delegate uses to enable selection state and list visibility.

Populating the Candidate List

- setCandidates:forSelectedRange:inString:

Sets an array of candidate objects to be displayed in the candidate list bar item.

candidates

The array of candidate objects previously set by setCandidates:forSelectedRange:inString:.

attributedStringForCandidate

A block that converts a candidate object into an attributed string for display in the candidate list item.

allowsTextInputContextCandidates

A Boolean value that specifies whether a candidate list item displays candidates from text input providers.

Handling Collapsible Behavior

allowsCollapsing

A Boolean value that specifies whether the item can be collapsed.

collapsed

A Boolean value that controls the visibility of the candidate list.

Managing Candidate List Visibility

candidateListVisible

A Boolean value that represents the visibility of this item's candidate list.

- updateWithInsertionPointVisibility:

Updates the candidate list visibility configuration based on the client's insertion point state.

Configuring Bar Customization

customizationLabel

The user-visible string identifying this item during bar customization.

Relationships

Inherits From

See Also

Touch Bar Items

NSTouchBarItem

A UI control shown in the Touch Bar on supported models of MacBook Pro.

NSColorPickerTouchBarItem

A bar item that provides a system-defined color picker.

NSCustomTouchBarItem

A bar item that contains a responder of your choice, such as a view, a button, or a scrubber (an instance of the NSScrubber class).

NSGroupTouchBarItem

A bar item that provides a bar to contain other items.

NSPopoverTouchBarItem

A bar item that provides a two-state control that can expand into its second state, showing the contents of a bar that it owns.

NSSharingServicePickerTouchBarItem

A bar item that, along with its delegate, provides a list of objects eligible for sharing.

NSSliderTouchBarItem

A bar item that provides a slider control for choosing a value in a range.

NSUserInterfaceCompressionOptions

An object that specifies how user interface elements resize themselves when space is constrained.