Struct NSTextStorage

#[repr(C)]
pub struct NSTextStorage { /* private fields */ }

Available on crate feature NSTextStorage only.

Apple’s documentation

Implementations

impl NSTextStorage

pub unsafe fn layoutManagers(&self) -> Retained<NSArray<NSLayoutManager>>

Available on crate feature NSLayoutManager only.

************************** Layout manager ***************************

pub unsafe fn addLayoutManager(&self, a_layout_manager: &NSLayoutManager)

Available on crate feature NSLayoutManager only.

pub unsafe fn removeLayoutManager(&self, a_layout_manager: &NSLayoutManager)

Available on crate feature NSLayoutManager only.

pub unsafe fn editedMask(&self) -> NSTextStorageEditActions

************************** Pending edit info ***************************

pub unsafe fn editedRange(&self) -> NSRange

pub unsafe fn changeInLength(&self) -> NSInteger

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

************************** Delegate ***************************

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

This is a weak property. Setter for delegate.

pub unsafe fn edited_range_changeInLength( &self, edited_mask: NSTextStorageEditActions, edited_range: NSRange, delta: NSInteger, )

************************** Edit management ***************************

pub unsafe fn processEditing(&self)

pub unsafe fn fixesAttributesLazily(&self) -> bool

************************** Attribute fixing ***************************

pub unsafe fn invalidateAttributesInRange(&self, range: NSRange)

pub unsafe fn ensureAttributesAreFixedInRange(&self, range: NSRange)

pub unsafe fn textStorageObserver( &self, ) -> Option<Retained<ProtocolObject<dyn NSTextStorageObserving>>>

************************** NSTextStorageObserving ***************************

pub unsafe fn setTextStorageObserver( &self, text_storage_observer: Option<&ProtocolObject<dyn NSTextStorageObserving>>, )

This is a weak property. Setter for textStorageObserver.

impl NSTextStorage

Methods declared on superclass NSObject.

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

pub unsafe fn new() -> Retained<Self>

impl NSTextStorage

Scripting.

pub unsafe fn attributeRuns(&self) -> Retained<NSArray<NSTextStorage>>

Available on crate feature NSTextStorageScripting only.

pub unsafe fn setAttributeRuns(&self, attribute_runs: &NSArray<NSTextStorage>)

Available on crate feature NSTextStorageScripting only.

Setter for attributeRuns.

pub unsafe fn paragraphs(&self) -> Retained<NSArray<NSTextStorage>>

Available on crate feature NSTextStorageScripting only.

pub unsafe fn setParagraphs(&self, paragraphs: &NSArray<NSTextStorage>)

Available on crate feature NSTextStorageScripting only.

Setter for paragraphs.

pub unsafe fn words(&self) -> Retained<NSArray<NSTextStorage>>

Available on crate feature NSTextStorageScripting only.

pub unsafe fn setWords(&self, words: &NSArray<NSTextStorage>)

Available on crate feature NSTextStorageScripting only.

Setter for words.

pub unsafe fn characters(&self) -> Retained<NSArray<NSTextStorage>>

Available on crate feature NSTextStorageScripting only.

pub unsafe fn setCharacters(&self, characters: &NSArray<NSTextStorage>)

Available on crate feature NSTextStorageScripting only.

Setter for characters.

pub unsafe fn font(&self) -> Option<Retained<NSFont>>

Available on crate features NSTextStorageScripting and NSFont only.

pub unsafe fn setFont(&self, font: Option<&NSFont>)

Available on crate features NSTextStorageScripting and NSFont only.

Setter for font.

pub unsafe fn foregroundColor(&self) -> Option<Retained<NSColor>>

Available on crate features NSTextStorageScripting and NSColor only.

pub unsafe fn setForegroundColor(&self, foreground_color: Option<&NSColor>)

Available on crate features NSTextStorageScripting and NSColor only.

Setter for foregroundColor.

Methods from Deref<Target = NSMutableAttributedString>

pub unsafe fn replaceCharactersInRange_withString( &self, range: NSRange, str: &NSString, )

pub unsafe fn setAttributes_range( &self, attrs: Option<&NSDictionary<NSString>>, range: NSRange, )

pub unsafe fn mutableString(&self) -> Retained<NSMutableString>

pub unsafe fn addAttribute_value_range( &self, name: &NSString, value: &AnyObject, range: NSRange, )

pub unsafe fn addAttributes_range( &self, attrs: &NSDictionary<NSString>, range: NSRange, )

pub unsafe fn removeAttribute_range(&self, name: &NSString, range: NSRange)

pub unsafe fn replaceCharactersInRange_withAttributedString( &self, range: NSRange, attr_string: &NSAttributedString, )

pub unsafe fn insertAttributedString_atIndex( &self, attr_string: &NSAttributedString, loc: usize, )

pub unsafe fn appendAttributedString(&self, attr_string: &NSAttributedString)

pub unsafe fn deleteCharactersInRange(&self, range: NSRange)

pub fn setAttributedString(&self, attr_string: &NSAttributedString)

pub unsafe fn beginEditing(&self)

pub unsafe fn endEditing(&self)

Methods from Deref<Target = NSAttributedString>

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

pub unsafe fn attributesAtIndex_effectiveRange( &self, location: usize, range: *mut NSRange, ) -> Retained<NSDictionary<NSString>>

pub fn length(&self) -> usize

pub unsafe fn attribute_atIndex_effectiveRange( &self, attr_name: &NSString, location: usize, range: *mut NSRange, ) -> Option<Retained<AnyObject>>

pub unsafe fn attributedSubstringFromRange( &self, range: NSRange, ) -> Retained<NSAttributedString>

pub unsafe fn attributesAtIndex_longestEffectiveRange_inRange( &self, location: usize, range: *mut NSRange, range_limit: NSRange, ) -> Retained<NSDictionary<NSString>>

pub unsafe fn attribute_atIndex_longestEffectiveRange_inRange( &self, attr_name: &NSString, location: usize, range: *mut NSRange, range_limit: NSRange, ) -> Option<Retained<AnyObject>>

pub unsafe fn isEqualToAttributedString( &self, other: &NSAttributedString, ) -> bool

pub unsafe fn attributedStringByInflectingString( &self, ) -> Retained<NSAttributedString>

If the string has portions tagged with NSInflectionRuleAttributeName that have no format specifiers, create a new string with those portions inflected by following the rule in the attribute.

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 NSTextStorage

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSAttributedString> for NSTextStorage

fn as_ref(&self) -> &NSAttributedString

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

impl AsRef<NSMutableAttributedString> for NSTextStorage

fn as_ref(&self) -> &NSMutableAttributedString

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

impl AsRef<NSObject> for NSTextStorage

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSTextStorage> for NSTextStorage

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSTextStorage

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSAttributedString> for NSTextStorage

fn borrow(&self) -> &NSAttributedString

Immutably borrows from an owned value.

impl Borrow<NSMutableAttributedString> for NSTextStorage

fn borrow(&self) -> &NSMutableAttributedString

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSTextStorage

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSTextStorage

const NAME: &'static str = "NSTextStorage"

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

type Super = NSMutableAttributedString

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSTextStorage

type Target = NSMutableAttributedString

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSTextStorage

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 NSTextStorage

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSTextStorage

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for NSTextStorage

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 NSTextStorage

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSTextStorage

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 NSTextStorage

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

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

impl DowncastTarget for NSTextStorage

impl Eq for NSTextStorage