Struct NSSpellChecker 

pub struct NSSpellChecker { /* private fields */ }

Available on crate feature NSSpellChecker only.

Apple’s documentation

Implementations

impl NSSpellChecker

pub fn sharedSpellChecker() -> Retained<NSSpellChecker>

pub fn sharedSpellCheckerExists() -> bool

pub fn uniqueSpellDocumentTag() -> NSInteger

pub unsafe fn checkSpellingOfString_startingAt_language_wrap_inSpellDocumentWithTag_wordCount( &self, string_to_check: &NSString, starting_offset: NSInteger, language: Option<&NSString>, wrap_flag: bool, tag: NSInteger, word_count: *mut NSInteger, ) -> NSRange

Safety

word_count must be a valid pointer or null.

pub fn checkSpellingOfString_startingAt( &self, string_to_check: &NSString, starting_offset: NSInteger, ) -> NSRange

pub fn countWordsInString_language( &self, string_to_count: &NSString, language: Option<&NSString>, ) -> NSInteger

pub unsafe fn checkGrammarOfString_startingAt_language_wrap_inSpellDocumentWithTag_details( &self, string_to_check: &NSString, starting_offset: NSInteger, language: Option<&NSString>, wrap_flag: bool, tag: NSInteger, details: Option<&mut Option<Retained<NSArray<NSDictionary<NSString, AnyObject>>>>>, ) -> NSRange

Safety

details generic generic should be of the correct type.

pub unsafe fn checkString_range_types_options_inSpellDocumentWithTag_orthography_wordCount( &self, string_to_check: &NSString, range: NSRange, checking_types: NSTextCheckingTypes, options: Option<&NSDictionary<NSTextCheckingOptionKey, AnyObject>>, tag: NSInteger, orthography: Option<&mut Option<Retained<NSOrthography>>>, word_count: *mut NSInteger, ) -> Retained<NSArray<NSTextCheckingResult>>

Safety

• options generic should be of the correct type.
• word_count must be a valid pointer or null.

pub unsafe fn requestCheckingOfString_range_types_options_inSpellDocumentWithTag_completionHandler( &self, string_to_check: &NSString, range: NSRange, checking_types: NSTextCheckingTypes, options: Option<&NSDictionary<NSTextCheckingOptionKey, AnyObject>>, tag: NSInteger, completion_handler: Option<&DynBlock<dyn Fn(NSInteger, NonNull<NSArray<NSTextCheckingResult>>, NonNull<NSOrthography>, NSInteger)>>, ) -> NSInteger

Available on crate feature block2 only.

Safety

options generic should be of the correct type.

pub unsafe fn requestCandidatesForSelectedRange_inString_types_options_inSpellDocumentWithTag_completionHandler( &self, selected_range: NSRange, string_to_check: &NSString, checking_types: NSTextCheckingTypes, options: Option<&NSDictionary<NSTextCheckingOptionKey, AnyObject>>, tag: NSInteger, completion_handler: Option<&DynBlock<dyn Fn(NSInteger, NonNull<NSArray<NSTextCheckingResult>>)>>, ) -> NSInteger

Available on crate feature block2 only.

Safety

options generic should be of the correct type.

pub unsafe fn menuForResult_string_options_atLocation_inView( &self, result: &NSTextCheckingResult, checked_string: &NSString, options: Option<&NSDictionary<NSTextCheckingOptionKey, AnyObject>>, location: NSPoint, view: &NSView, ) -> Option<Retained<NSMenu>>

Available on crate features NSMenu and NSResponder and NSView only.

Safety

options generic should be of the correct type.

pub fn userQuotesArrayForLanguage( &self, language: &NSString, ) -> Retained<NSArray<NSString>>

pub fn userReplacementsDictionary( &self, ) -> Retained<NSDictionary<NSString, NSString>>

pub fn updateSpellingPanelWithMisspelledWord(&self, word: &NSString)

pub unsafe fn updateSpellingPanelWithGrammarString_detail( &self, string: &NSString, detail: &NSDictionary<NSString, AnyObject>, )

Safety

detail generic should be of the correct type.

pub fn spellingPanel(&self, mtm: MainThreadMarker) -> Retained<NSPanel>

Available on crate features NSPanel and NSResponder and NSWindow only.

pub fn accessoryView(&self, mtm: MainThreadMarker) -> Option<Retained<NSView>>

Available on crate features NSResponder and NSView only.

pub fn setAccessoryView(&self, accessory_view: Option<&NSView>)

Available on crate features NSResponder and NSView only.

Setter for accessoryView.

pub fn substitutionsPanel(&self, mtm: MainThreadMarker) -> Retained<NSPanel>

Available on crate features NSPanel and NSResponder and NSWindow only.

pub fn substitutionsPanelAccessoryViewController( &self, mtm: MainThreadMarker, ) -> Option<Retained<NSViewController>>

Available on crate features NSResponder and NSViewController only.

pub fn setSubstitutionsPanelAccessoryViewController( &self, substitutions_panel_accessory_view_controller: Option<&NSViewController>, )

Available on crate features NSResponder and NSViewController only.

Setter for substitutionsPanelAccessoryViewController.

pub fn updatePanels(&self)

pub fn ignoreWord_inSpellDocumentWithTag( &self, word_to_ignore: &NSString, tag: NSInteger, )

pub fn ignoredWordsInSpellDocumentWithTag( &self, tag: NSInteger, ) -> Option<Retained<NSArray<NSString>>>

pub fn setIgnoredWords_inSpellDocumentWithTag( &self, words: &NSArray<NSString>, tag: NSInteger, )

pub fn guessesForWordRange_inString_language_inSpellDocumentWithTag( &self, range: NSRange, string: &NSString, language: Option<&NSString>, tag: NSInteger, ) -> Option<Retained<NSArray<NSString>>>

pub fn correctionForWordRange_inString_language_inSpellDocumentWithTag( &self, range: NSRange, string: &NSString, language: &NSString, tag: NSInteger, ) -> Option<Retained<NSString>>

pub fn completionsForPartialWordRange_inString_language_inSpellDocumentWithTag( &self, range: NSRange, string: &NSString, language: Option<&NSString>, tag: NSInteger, ) -> Option<Retained<NSArray<NSString>>>

pub fn languageForWordRange_inString_orthography( &self, range: NSRange, string: &NSString, orthography: Option<&NSOrthography>, ) -> Option<Retained<NSString>>

pub fn closeSpellDocumentWithTag(&self, tag: NSInteger)

pub fn recordResponse_toCorrection_forWord_language_inSpellDocumentWithTag( &self, response: NSCorrectionResponse, correction: &NSString, word: &NSString, language: Option<&NSString>, tag: NSInteger, )

pub fn showCorrectionIndicatorOfType_primaryString_alternativeStrings_forStringInRect_view_completionHandler( &self, type: NSCorrectionIndicatorType, primary_string: &NSString, alternative_strings: &NSArray<NSString>, rect_of_typed_string: NSRect, view: &NSView, completion_block: Option<&DynBlock<dyn Fn(*mut NSString)>>, )

Available on crate features NSResponder and NSView and block2 only.

pub fn dismissCorrectionIndicatorForView(&self, view: &NSView)

Available on crate features NSResponder and NSView only.

pub fn showInlinePredictionForCandidates_client( &self, candidates: &NSArray<NSTextCheckingResult>, client: &ProtocolObject<dyn NSTextInputClient>, )

Available on crate feature NSTextInputClient only.

pub fn preventsAutocorrectionBeforeString_language( &self, string: &NSString, language: Option<&NSString>, ) -> bool

pub fn deletesAutospaceBetweenString_andString_language( &self, preceding_string: &NSString, following_string: &NSString, language: Option<&NSString>, ) -> bool

pub fn availableLanguages(&self) -> Retained<NSArray<NSString>>

pub fn userPreferredLanguages(&self) -> Retained<NSArray<NSString>>

pub fn automaticallyIdentifiesLanguages(&self) -> bool

pub fn setAutomaticallyIdentifiesLanguages( &self, automatically_identifies_languages: bool, )

Setter for automaticallyIdentifiesLanguages.

pub fn setWordFieldStringValue(&self, string: &NSString)

pub fn learnWord(&self, word: &NSString)

pub fn hasLearnedWord(&self, word: &NSString) -> bool

pub fn unlearnWord(&self, word: &NSString)

pub fn isAutomaticTextReplacementEnabled() -> bool

pub fn isAutomaticSpellingCorrectionEnabled() -> bool

pub fn isAutomaticQuoteSubstitutionEnabled() -> bool

pub fn isAutomaticDashSubstitutionEnabled() -> bool

pub fn isAutomaticCapitalizationEnabled() -> bool

pub fn isAutomaticPeriodSubstitutionEnabled() -> bool

pub fn isAutomaticTextCompletionEnabled() -> bool

pub fn isAutomaticInlinePredictionEnabled() -> bool

pub fn language(&self) -> Retained<NSString>

pub fn setLanguage(&self, language: &NSString) -> bool

impl NSSpellChecker

Methods declared on superclass NSObject.

pub fn init(this: Allocated<Self>) -> Retained<Self>

pub fn new() -> Retained<Self>

impl NSSpellChecker

NSDeprecated.

pub unsafe fn guessesForWord( &self, word: Option<&NSString>, ) -> Option<Retained<NSArray>>

👎Deprecated: Use -guessesForWordRange:inString:language:inSpellDocumentWithTag instead

Safety

word might not allow None.

pub unsafe fn forgetWord(&self, word: Option<&NSString>)

👎Deprecated

Safety

word might not allow None.

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

Available on crate feature NSAccessibilityConstants only.

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.

Available on crate feature NSAccessibilityConstants only.

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,

Available on crate feature NSAccessibilityConstants only.

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 NSSpellChecker

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSSpellChecker

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSSpellChecker> for NSSpellChecker

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSSpellChecker

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSSpellChecker

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSSpellChecker

const NAME: &'static str = "NSSpellChecker"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSSpellChecker as ClassType>::Super as ClassType>::ThreadKind

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 NSSpellChecker

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

Formats the value using the given formatter.

impl DefaultRetained for NSSpellChecker

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSSpellChecker

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSSpellChecker

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 Message for NSSpellChecker

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSSpellChecker

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 PartialEq for NSSpellChecker

fn eq(&self, other: &Self) -> 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 RefEncode for NSSpellChecker

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

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

impl DowncastTarget for NSSpellChecker

impl Eq for NSSpellChecker