Struct NSWritingToolsCoordinatorTextAnimation

#[repr(transparent)]
pub struct NSWritingToolsCoordinatorTextAnimation(pub NSInteger);

Available on crate feature NSWritingToolsCoordinator only.

Use the NSWritingToolsCoordinator.TextAnimation constants to determine the type of animation that is occurring. During an interactive change to your view, Writing Tools creates animations to provide feedback about what’s happening. During the setup for each animation, Writing Tools reports the type of animation to the coordinator’s delegate, so that you can perform additional actions related to that animation. For example, during an insertion animation, you might animate changes to other views in your interface.

See also Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl NSWritingToolsCoordinatorTextAnimation

pub const Anticipate: Self

The animation that Writing Tools performs when waiting to receive results from the large language model.

This type of animation applies a visual effect to the text that Writing Tools is evaluating. When preparing for this animation, hide the text that Writing Tools is about to evaluate. In the same space where that text appears, Writing Tools displays a preview image that you provide and animates changes to that image.

pub const Remove: Self

The animation that Writing Tools performs when removing text from your view.

This type of animation shows the removal of text from your view. When preparing for this animation, hide the text in the provided range if you haven’t already. If you support animating the reflow of your view’s text, you can also prepare any other animations you need. Writing Tools uses a preview object you provide to animate the removal of the text.

pub const Insert: Self

The animation that Writing Tools performs when inserting text into your view.

This type of animation shows the insertion of text to your view. When preparing for this animation, hide the text in the provided range if you haven’t already. If you support animating the reflow of your view’s text, you can also prepare any other animations you need. Writing Tools uses a preview object you provide to animate the insertion of the text.

pub const AnticipateInactive: Self

The animation effect that Writing Tools performs when the view is waiting for results, but the system isn’t actively evaluating the text.

When Writing Tools isn’t actively evaluating your text, it creates this animation. When preparing for this animation, display the text in the specified range with a foreground color of 50% grey.

pub const Translate: Self

The animation effect that Writing Tools performs on text situated after the insertion point.

When Writing Tools inserts text at a given location, it creates an animation to make room for the new text. When preparing for this animation, hide the text between the insertion point and the end of your text storage. When finishing the animation, show the text again.

Trait Implementations

impl Clone for NSWritingToolsCoordinatorTextAnimation

fn clone(&self) -> NSWritingToolsCoordinatorTextAnimation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NSWritingToolsCoordinatorTextAnimation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for NSWritingToolsCoordinatorTextAnimation

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for NSWritingToolsCoordinatorTextAnimation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NSWritingToolsCoordinatorTextAnimation

fn cmp(&self, other: &NSWritingToolsCoordinatorTextAnimation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NSWritingToolsCoordinatorTextAnimation

fn eq(&self, other: &NSWritingToolsCoordinatorTextAnimation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NSWritingToolsCoordinatorTextAnimation

fn partial_cmp( &self, other: &NSWritingToolsCoordinatorTextAnimation, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for NSWritingToolsCoordinatorTextAnimation

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for NSWritingToolsCoordinatorTextAnimation

impl Eq for NSWritingToolsCoordinatorTextAnimation

impl StructuralPartialEq for NSWritingToolsCoordinatorTextAnimation