Struct NSTextContentStorage 

pub struct NSTextContentStorage { /* private fields */ }

Available on crate feature NSTextContentManager only.

Apple’s documentation

Implementations

impl NSTextContentStorage

pub fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSTextContentStorageDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSTextContentStorageDelegate>>, )

Setter for delegate.

This is a weak property.

pub fn includesTextListMarkers(&self) -> bool

pub fn setIncludesTextListMarkers(&self, includes_text_list_markers: bool)

Setter for includesTextListMarkers.

pub fn attributedString(&self) -> Option<Retained<NSAttributedString>>

pub fn setAttributedString( &self, attributed_string: Option<&NSAttributedString>, )

Setter for attributedString.

This is copied when set.

pub fn attributedStringForTextElement( &self, text_element: &NSTextElement, ) -> Option<Retained<NSAttributedString>>

Available on crate feature NSTextElement only.

pub fn textElementForAttributedString( &self, attributed_string: &NSAttributedString, ) -> Option<Retained<NSTextElement>>

Available on crate feature NSTextElement only.

pub fn locationFromLocation_withOffset( &self, location: &ProtocolObject<dyn NSTextLocation>, offset: NSInteger, ) -> Option<Retained<ProtocolObject<dyn NSTextLocation>>>

Available on crate feature NSTextRange only.

pub fn offsetFromLocation_toLocation( &self, from: &ProtocolObject<dyn NSTextLocation>, to: &ProtocolObject<dyn NSTextLocation>, ) -> NSInteger

Available on crate feature NSTextRange only.

pub fn adjustedRangeFromRange_forEditingTextSelection( &self, text_range: &NSTextRange, for_editing_text_selection: bool, ) -> Option<Retained<NSTextRange>>

Available on crate feature NSTextRange only.

impl NSTextContentStorage

Methods declared on superclass NSTextContentManager.

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

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

Safety

coder possibly has further requirements.

impl NSTextContentStorage

Methods declared on superclass NSObject.

pub fn new() -> Retained<Self>

Methods from Deref<Target = NSTextContentManager>

pub fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSTextContentManagerDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSTextContentManagerDelegate>>, )

Setter for delegate.

This is a weak property.

pub fn textLayoutManagers(&self) -> Retained<NSArray<NSTextLayoutManager>>

Available on crate feature NSTextLayoutManager only.

pub fn addTextLayoutManager(&self, text_layout_manager: &NSTextLayoutManager)

Available on crate feature NSTextLayoutManager only.

pub fn removeTextLayoutManager(&self, text_layout_manager: &NSTextLayoutManager)

Available on crate feature NSTextLayoutManager only.

pub fn primaryTextLayoutManager(&self) -> Option<Retained<NSTextLayoutManager>>

Available on crate feature NSTextLayoutManager only.

pub fn setPrimaryTextLayoutManager( &self, primary_text_layout_manager: Option<&NSTextLayoutManager>, )

Available on crate feature NSTextLayoutManager only.

Setter for primaryTextLayoutManager.

pub fn synchronizeTextLayoutManagers( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

pub fn textElementsForRange( &self, range: &NSTextRange, ) -> Retained<NSArray<NSTextElement>>

Available on crate features NSTextElement and NSTextRange only.

pub fn hasEditingTransaction(&self) -> bool

pub fn performEditingTransactionUsingBlock( &self, transaction: &DynBlock<dyn Fn() + '_>, )

Available on crate feature block2 only.

pub fn recordEditActionInRange_newTextRange( &self, original_text_range: &NSTextRange, new_text_range: &NSTextRange, )

Available on crate feature NSTextRange only.

pub fn automaticallySynchronizesTextLayoutManagers(&self) -> bool

pub fn setAutomaticallySynchronizesTextLayoutManagers( &self, automatically_synchronizes_text_layout_managers: bool, )

Setter for automaticallySynchronizesTextLayoutManagers.

pub fn automaticallySynchronizesToBackingStore(&self) -> bool

pub fn setAutomaticallySynchronizesToBackingStore( &self, automatically_synchronizes_to_backing_store: bool, )

Setter for automaticallySynchronizesToBackingStore.

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 NSTextContentStorage

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSTextContentStorage

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSTextContentManager> for NSTextContentStorage

fn as_ref(&self) -> &NSTextContentManager

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

impl AsRef<NSTextContentStorage> for NSTextContentStorage

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSTextContentStorage

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSTextContentStorage

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSTextContentManager> for NSTextContentStorage

fn borrow(&self) -> &NSTextContentManager

Immutably borrows from an owned value.

impl ClassType for NSTextContentStorage

const NAME: &'static str = "NSTextContentStorage"

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

type Super = NSTextContentManager

The superclass of this class.

type ThreadKind = <<NSTextContentStorage 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 NSTextContentStorage

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

Formats the value using the given formatter.

impl DefaultRetained for NSTextContentStorage

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSTextContentStorage

type Target = NSTextContentManager

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSTextContentStorage

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 NSTextContentStorage

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSTextContentStorage

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSObjectProtocol for NSTextContentStorage

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 NSSecureCoding for NSTextContentStorage

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl NSTextElementProvider for NSTextContentStorage

fn documentRange(&self) -> Retained<NSTextRange>

where Self: Sized + Message,

Available on crate feature NSTextRange only.

fn enumerateTextElementsFromLocation_options_usingBlock( &self, text_location: Option<&ProtocolObject<dyn NSTextLocation>>, options: NSTextContentManagerEnumerationOptions, block: &DynBlock<dyn Fn(NonNull<NSTextElement>) -> Bool + '_>, ) -> Option<Retained<ProtocolObject<dyn NSTextLocation>>>

where Self: Sized + Message,

Available on crate features NSTextElement and NSTextRange and block2 only.

fn replaceContentsInRange_withTextElements( &self, range: &NSTextRange, text_elements: Option<&NSArray<NSTextElement>>, )

where Self: Sized + Message,

Available on crate features NSTextElement and NSTextRange only.

fn synchronizeToBackingStore( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

where Self: Sized + Message,

Available on crate feature block2 only.

fn locationFromLocation_withOffset( &self, location: &ProtocolObject<dyn NSTextLocation>, offset: NSInteger, ) -> Option<Retained<ProtocolObject<dyn NSTextLocation>>>

where Self: Sized + Message,

Available on crate feature NSTextRange only.

fn offsetFromLocation_toLocation( &self, from: &ProtocolObject<dyn NSTextLocation>, to: &ProtocolObject<dyn NSTextLocation>, ) -> NSInteger

where Self: Sized + Message,

Available on crate feature NSTextRange only.

fn adjustedRangeFromRange_forEditingTextSelection( &self, text_range: &NSTextRange, for_editing_text_selection: bool, ) -> Option<Retained<NSTextRange>>

where Self: Sized + Message,

Available on crate feature NSTextRange only.

impl NSTextStorageObserving for NSTextContentStorage

fn textStorage(&self) -> Option<Retained<NSTextStorage>>

where Self: Sized + Message,

Available on crate feature NSTextStorage only.

fn setTextStorage(&self, text_storage: Option<&NSTextStorage>)

where Self: Sized + Message,

Available on crate feature NSTextStorage only.

Setter for textStorage.

fn processEditingForTextStorage_edited_range_changeInLength_invalidatedRange( &self, text_storage: &NSTextStorage, edit_mask: NSTextStorageEditActions, new_char_range: NSRange, delta: NSInteger, invalidated_char_range: NSRange, )

where Self: Sized + Message,

Available on crate feature NSTextStorage only.

fn performEditingTransactionForTextStorage_usingBlock( &self, text_storage: &NSTextStorage, transaction: &DynBlock<dyn Fn() + '_>, )

where Self: Sized + Message,

Available on crate features NSTextStorage and block2 only.

impl PartialEq for NSTextContentStorage

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 NSTextContentStorage

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

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

impl DowncastTarget for NSTextContentStorage

impl Eq for NSTextContentStorage