Struct NSTextLayoutManager

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

Available on crate feature NSTextLayoutManager only.

Apple’s documentation

Implementations

impl NSTextLayoutManager

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

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

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

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

This is a weak property. Setter for delegate.

pub unsafe fn usesFontLeading(&self) -> bool

pub unsafe fn setUsesFontLeading(&self, uses_font_leading: bool)

Setter for usesFontLeading.

pub unsafe fn limitsLayoutForSuspiciousContents(&self) -> bool

pub unsafe fn setLimitsLayoutForSuspiciousContents( &self, limits_layout_for_suspicious_contents: bool, )

Setter for limitsLayoutForSuspiciousContents.

pub unsafe fn usesHyphenation(&self) -> bool

pub unsafe fn setUsesHyphenation(&self, uses_hyphenation: bool)

Setter for usesHyphenation.

pub unsafe fn textContentManager( &self, ) -> Option<Retained<NSTextContentManager>>

Available on crate feature NSTextContentManager only.

pub unsafe fn replaceTextContentManager( &self, text_content_manager: &NSTextContentManager, )

Available on crate feature NSTextContentManager only.

pub unsafe fn textContainer(&self) -> Option<Retained<NSTextContainer>>

Available on crate feature NSTextContainer only.

pub unsafe fn setTextContainer(&self, text_container: Option<&NSTextContainer>)

Available on crate feature NSTextContainer only.

Setter for textContainer.

pub unsafe fn usageBoundsForTextContainer(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn textViewportLayoutController( &self, ) -> Retained<NSTextViewportLayoutController>

Available on crate feature NSTextViewportLayoutController only.

pub unsafe fn layoutQueue(&self) -> Option<Retained<NSOperationQueue>>

pub unsafe fn setLayoutQueue(&self, layout_queue: Option<&NSOperationQueue>)

Setter for layoutQueue.

pub unsafe fn ensureLayoutForRange(&self, range: &NSTextRange)

Available on crate feature NSTextRange only.

pub unsafe fn ensureLayoutForBounds(&self, bounds: CGRect)

Available on crate feature objc2-core-foundation only.

pub unsafe fn invalidateLayoutForRange(&self, range: &NSTextRange)

Available on crate feature NSTextRange only.

pub unsafe fn textLayoutFragmentForPosition( &self, position: CGPoint, ) -> Option<Retained<NSTextLayoutFragment>>

Available on crate features NSTextLayoutFragment and objc2-core-foundation only.

pub unsafe fn textLayoutFragmentForLocation( &self, location: &ProtocolObject<dyn NSTextLocation>, ) -> Option<Retained<NSTextLayoutFragment>>

Available on crate features NSTextLayoutFragment and NSTextRange only.

pub unsafe fn enumerateTextLayoutFragmentsFromLocation_options_usingBlock( &self, location: Option<&ProtocolObject<dyn NSTextLocation>>, options: NSTextLayoutFragmentEnumerationOptions, block: &Block<dyn Fn(NonNull<NSTextLayoutFragment>) -> Bool + '_>, ) -> Option<Retained<ProtocolObject<dyn NSTextLocation>>>

Available on crate features NSTextLayoutFragment and NSTextRange and block2 only.

pub unsafe fn textSelections(&self) -> Retained<NSArray<NSTextSelection>>

Available on crate feature NSTextSelection only.

pub unsafe fn setTextSelections( &self, text_selections: &NSArray<NSTextSelection>, )

Available on crate feature NSTextSelection only.

Setter for textSelections.

pub unsafe fn textSelectionNavigation( &self, ) -> Retained<NSTextSelectionNavigation>

Available on crate feature NSTextSelectionNavigation only.

pub unsafe fn setTextSelectionNavigation( &self, text_selection_navigation: &NSTextSelectionNavigation, )

Available on crate feature NSTextSelectionNavigation only.

Setter for textSelectionNavigation.

pub unsafe fn enumerateRenderingAttributesFromLocation_reverse_usingBlock( &self, location: &ProtocolObject<dyn NSTextLocation>, reverse: bool, block: &Block<dyn Fn(NonNull<NSTextLayoutManager>, NonNull<NSDictionary<NSAttributedStringKey, AnyObject>>, NonNull<NSTextRange>) -> Bool + '_>, )

Available on crate features NSTextRange and block2 only.

pub unsafe fn setRenderingAttributes_forTextRange( &self, rendering_attributes: &NSDictionary<NSAttributedStringKey, AnyObject>, text_range: &NSTextRange, )

Available on crate feature NSTextRange only.

pub unsafe fn addRenderingAttribute_value_forTextRange( &self, rendering_attribute: &NSAttributedStringKey, value: Option<&AnyObject>, text_range: &NSTextRange, )

Available on crate feature NSTextRange only.

pub unsafe fn removeRenderingAttribute_forTextRange( &self, rendering_attribute: &NSAttributedStringKey, text_range: &NSTextRange, )

Available on crate feature NSTextRange only.

pub unsafe fn invalidateRenderingAttributesForTextRange( &self, text_range: &NSTextRange, )

Available on crate feature NSTextRange only.

pub unsafe fn renderingAttributesValidator( &self, ) -> *mut Block<dyn Fn(NonNull<NSTextLayoutManager>, NonNull<NSTextLayoutFragment>)>

Available on crate features NSTextLayoutFragment and block2 only.

pub unsafe fn setRenderingAttributesValidator( &self, rendering_attributes_validator: Option<&Block<dyn Fn(NonNull<NSTextLayoutManager>, NonNull<NSTextLayoutFragment>)>>, )

Available on crate features NSTextLayoutFragment and block2 only.

Setter for renderingAttributesValidator.

pub unsafe fn linkRenderingAttributes() -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

pub unsafe fn renderingAttributesForLink_atLocation( &self, link: &AnyObject, location: &ProtocolObject<dyn NSTextLocation>, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

Available on crate feature NSTextRange only.

pub unsafe fn enumerateTextSegmentsInRange_type_options_usingBlock( &self, text_range: &NSTextRange, type: NSTextLayoutManagerSegmentType, options: NSTextLayoutManagerSegmentOptions, block: &Block<dyn Fn(*mut NSTextRange, CGRect, CGFloat, NonNull<NSTextContainer>) -> Bool + '_>, )

Available on crate features NSTextContainer and NSTextRange and block2 and objc2-core-foundation only.

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

Available on crate features NSTextElement and NSTextRange only.

pub unsafe fn replaceContentsInRange_withAttributedString( &self, range: &NSTextRange, attributed_string: &NSAttributedString, )

Available on crate feature NSTextRange only.

impl NSTextLayoutManager

Methods declared on superclass NSObject.

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

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.

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 NSTextLayoutManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSTextLayoutManager

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSTextLayoutManager> for NSTextLayoutManager

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSTextLayoutManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSTextLayoutManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSTextLayoutManager

const NAME: &'static str = "NSTextLayoutManager"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSTextLayoutManager

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSTextLayoutManager

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 NSTextLayoutManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSTextLayoutManager

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for NSTextLayoutManager

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 NSTextLayoutManager

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl NSTextSelectionDataSource for NSTextLayoutManager

Available on crate feature NSTextSelectionNavigation only.

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

where Self: Sized + Message,

Available on crate feature NSTextRange only.

unsafe fn enumerateSubstringsFromLocation_options_usingBlock( &self, location: &ProtocolObject<dyn NSTextLocation>, options: NSStringEnumerationOptions, block: &Block<dyn Fn(*mut NSString, NonNull<NSTextRange>, *mut NSTextRange, NonNull<Bool>) + '_>, )

where Self: Sized + Message,

Available on crate features NSTextRange and block2 only.

unsafe fn textRangeForSelectionGranularity_enclosingLocation( &self, selection_granularity: NSTextSelectionGranularity, location: &ProtocolObject<dyn NSTextLocation>, ) -> Option<Retained<NSTextRange>>

where Self: Sized + Message,

Available on crate features NSTextRange and NSTextSelection only.

unsafe 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.

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

where Self: Sized + Message,

Available on crate feature NSTextRange only.

unsafe fn baseWritingDirectionAtLocation( &self, location: &ProtocolObject<dyn NSTextLocation>, ) -> NSTextSelectionNavigationWritingDirection

where Self: Sized + Message,

Available on crate feature NSTextRange only.

unsafe fn enumerateCaretOffsetsInLineFragmentAtLocation_usingBlock( &self, location: &ProtocolObject<dyn NSTextLocation>, block: &Block<dyn Fn(CGFloat, NonNull<ProtocolObject<dyn NSTextLocation>>, Bool, NonNull<Bool>) + '_>, )

where Self: Sized + Message,

Available on crate features NSTextRange and block2 and objc2-core-foundation only.

unsafe fn lineFragmentRangeForPoint_inContainerAtLocation( &self, point: CGPoint, location: &ProtocolObject<dyn NSTextLocation>, ) -> Option<Retained<NSTextRange>>

where Self: Sized + Message,

Available on crate features NSTextRange and objc2-core-foundation only.

unsafe fn enumerateContainerBoundariesFromLocation_reverse_usingBlock( &self, location: &ProtocolObject<dyn NSTextLocation>, reverse: bool, block: &Block<dyn Fn(NonNull<ProtocolObject<dyn NSTextLocation>>, NonNull<Bool>) + '_>, )

where Self: Sized + Message,

Available on crate features NSTextRange and block2 only.

unsafe fn textLayoutOrientationAtLocation( &self, location: &ProtocolObject<dyn NSTextLocation>, ) -> NSTextSelectionNavigationLayoutOrientation

where Self: Sized + Message,

Available on crate feature NSTextRange only.

impl PartialEq for NSTextLayoutManager

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 NSTextLayoutManager

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

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

impl DowncastTarget for NSTextLayoutManager

impl Eq for NSTextLayoutManager