Struct TextFieldDelegate 

#[repr(C)]
pub(crate) struct TextFieldDelegate {
    __superclass: ManuallyDrop<<NSObject as ClassType>::__SubclassingType>,
    __phantom: PhantomData<(<Self as DefinedClass>::Ivars, ThreadKindAutoTraits<<Self as ClassType>::ThreadKind>)>,
}

Fields

__superclass: ManuallyDrop<<NSObject as ClassType>::__SubclassingType>

__phantom: PhantomData<(<Self as DefinedClass>::Ivars, ThreadKindAutoTraits<<Self as ClassType>::ThreadKind>)>

Implementations

impl TextFieldDelegate

extern "C-unwind" fn control_text_did_change( &self, _: Sel, _notification: <&NSNotification as ConvertArgument>::__Inner, )

extern "C-unwind" fn do_command( &self, _: Sel, _control: <&NSControl as ConvertArgument>::__Inner, _editor: <&NSTextView as ConvertArgument>::__Inner, command: <Sel as ConvertArgument>::__Inner, ) -> <bool as ConvertReturn<()>>::Inner

Return in a field with an action runs it, and answers that Return is handled, so the window’s default button isn’t pressed too.

impl TextFieldDelegate

pub(crate) fn new( mtm: MainThreadMarker, field: &Retained<NSTextField>, on_change: TextHandler, on_submit: Option<ClickHandler>, ) -> Retained<Self>

Only edits made by the user notify the delegate; setting the value in code does not.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated:

this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for TextFieldDelegate

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for TextFieldDelegate

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<TextFieldDelegate> for TextFieldDelegate

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for TextFieldDelegate

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for TextFieldDelegate

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for TextFieldDelegate

const NAME: &'static str = "NiftyTextFieldDelegate"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for TextFieldDelegate

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

Formats the value using the given formatter.

impl DefinedClass for TextFieldDelegate

type Ivars = TextFieldDelegateIvars

A type representing the instance variables that this class carries.

fn ivars(&self) -> &Self::Ivars

where Self: Sized,

Get a reference to the instance variable data that this object carries.

impl Deref for TextFieldDelegate

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DowncastTarget for TextFieldDelegate

impl Message for TextFieldDelegate

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSControlTextEditingDelegate for TextFieldDelegate

fn controlTextDidBeginEditing(&self, obj: &NSNotification)

where Self: Sized + Message,

fn controlTextDidEndEditing(&self, obj: &NSNotification)

where Self: Sized + Message,

fn controlTextDidChange(&self, obj: &NSNotification)

where Self: Sized + Message,

fn control_textShouldBeginEditing( &self, control: &NSControl, field_editor: &NSText, ) -> bool

where Self: Sized + Message,

fn control_textShouldEndEditing( &self, control: &NSControl, field_editor: &NSText, ) -> bool

where Self: Sized + Message,

fn control_didFailToFormatString_errorDescription( &self, control: &NSControl, string: &NSString, error: Option<&NSString>, ) -> bool

where Self: Sized + Message,

fn control_didFailToValidatePartialString_errorDescription( &self, control: &NSControl, string: &NSString, error: Option<&NSString>, )

where Self: Sized + Message,

unsafe fn control_isValidObject( &self, control: &NSControl, obj: Option<&AnyObject>, ) -> bool

where Self: Sized + Message,

Safety

unsafe fn control_textView_doCommandBySelector( &self, control: &NSControl, text_view: &NSTextView, command_selector: Sel, ) -> bool

where Self: Sized + Message,

Safety

unsafe fn control_textView_completions_forPartialWordRange_indexOfSelectedItem( &self, control: &NSControl, text_view: &NSTextView, words: &NSArray<NSString>, char_range: NSRange, index: NonNull<isize>, ) -> Retained<NSArray<NSString>>

where Self: Sized + Message,

Safety

impl NSObjectProtocol for TextFieldDelegate

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated:

use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSTextFieldDelegate for TextFieldDelegate

fn textField_textView_candidatesForSelectedRange( &self, text_field: &NSTextField, text_view: &NSTextView, selected_range: NSRange, ) -> Option<Retained<NSArray>>

where Self: Sized + Message,

Provides a customized list of candidates to the text view’s candidateListTouchBarItem. Invoked from -updateCandidates. NSTextView uses the candidates returned from this method and suppress its built-in candidate generation. Returning nil from this delegate method allows NSTextView to query candidates from NSSpellChecker.

fn textField_textView_candidates_forSelectedRange( &self, text_field: &NSTextField, text_view: &NSTextView, candidates: &NSArray<NSTextCheckingResult>, selected_range: NSRange, ) -> Retained<NSArray<NSTextCheckingResult>>

where Self: Sized + Message,

Allows customizing the candidate list queried from NSSpellChecker.

fn textField_textView_shouldSelectCandidateAtIndex( &self, text_field: &NSTextField, text_view: &NSTextView, index: usize, ) -> bool

where Self: Sized + Message,

Notifies the delegate that the user selected the candidate at index in -[NSCandidateListTouchBarItem candidates] for the text view’s candidateListTouchBarItem. Returns a Boolean value that indicates whether to select the text object at the index.

impl RefEncode for TextFieldDelegate

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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