Struct NSTextLayoutManager

Source
#[repr(C)]
pub struct NSTextLayoutManager { /* private fields */ }
Available on crate feature NSTextLayoutManager only.
Expand description

Implementations§

Source§

impl NSTextLayoutManager

Source

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

Source

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

Source

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

Source

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

This is a weak property. Setter for delegate.

Source

pub unsafe fn usesFontLeading(&self) -> bool

Source

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

Setter for usesFontLeading.

Source

pub unsafe fn limitsLayoutForSuspiciousContents(&self) -> bool

Source

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

Source

pub unsafe fn usesHyphenation(&self) -> bool

Source

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

Setter for usesHyphenation.

Source

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

Available on crate feature NSTextContentManager only.
Source

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

Available on crate feature NSTextContentManager only.
Source

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

Available on crate feature NSTextContainer only.
Source

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

Available on crate feature NSTextContainer only.

Setter for textContainer.

Source

pub unsafe fn usageBoundsForTextContainer(&self) -> CGRect

Available on crate feature objc2-core-foundation only.
Source

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

Available on crate feature NSTextViewportLayoutController only.
Source

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

Source

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

Setter for layoutQueue.

Source

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

Available on crate feature NSTextRange only.
Source

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

Available on crate feature objc2-core-foundation only.
Source

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

Available on crate feature NSTextRange only.
Source

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

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

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

Available on crate features NSTextLayoutFragment and NSTextRange only.
Source

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

Available on crate features NSTextLayoutFragment and NSTextRange and block2 only.
Source

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

Available on crate feature NSTextSelection only.
Source

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

Available on crate feature NSTextSelection only.

Setter for textSelections.

Source

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

Available on crate feature NSTextSelectionNavigation only.
Source

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

Available on crate feature NSTextSelectionNavigation only.
Source

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

Available on crate features NSTextRange and block2 only.
Source

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

Available on crate feature NSTextRange only.
Source

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

Available on crate feature NSTextRange only.
Source

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

Available on crate feature NSTextRange only.
Source

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

Available on crate feature NSTextRange only.
Source

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

Available on crate features NSTextLayoutFragment and block2 only.
Source

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

Available on crate features NSTextLayoutFragment and block2 only.
Source

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

Available on crate feature NSTextRange only.
Source

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

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

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

Available on crate features NSTextElement and NSTextRange only.
Source

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

Available on crate feature NSTextRange only.
Source§

impl NSTextLayoutManager

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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

Available on crate feature UIIndirectScribbleInteraction 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());
Source

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

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Available on crate feature UIIndirectScribbleInteraction 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§

Source§

impl AsRef<AnyObject> for NSTextLayoutManager

Source§

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSTextLayoutManager

Source§

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSTextLayoutManager> for NSTextLayoutManager

Source§

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSTextLayoutManager

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSObject> for NSTextLayoutManager

Source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
Source§

impl ClassType for NSTextLayoutManager

Source§

const NAME: &'static str = "NSTextLayoutManager"

The name of the Objective-C class that this type represents. Read more
Source§

type Super = NSObject

The superclass of this class. Read more
Source§

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

Whether the type can be used from any thread, or from only the main thread. Read more
Source§

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more
Source§

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

Get an immutable reference to the superclass.
Source§

impl Debug for NSTextLayoutManager

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for NSTextLayoutManager

Source§

type Target = NSObject

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl Hash for NSTextLayoutManager

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for NSTextLayoutManager

Source§

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

impl NSCoding for NSTextLayoutManager

Source§

unsafe fn encodeWithCoder(&self, coder: &NSCoder)
where Self: Sized + Message,

Source§

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

Source§

impl NSObjectProtocol for NSTextLayoutManager

Source§

fn isEqual(&self, other: Option<&AnyObject>) -> bool
where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object. Read more
Source§

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more
Source§

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. Read more
Source§

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. Read more
Source§

fn isMemberOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

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

fn respondsToSelector(&self, aSelector: Sel) -> bool
where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector. Read more
Source§

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
where Self: Sized + Message,

Check whether the object conforms to a given protocol. Read more
Source§

fn description(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object. Read more
Source§

fn debugDescription(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object to use when debugging. Read more
Source§

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. Read more
Source§

fn retainCount(&self) -> usize
where Self: Sized + Message,

The reference count of the object. Read more
Source§

impl NSSecureCoding for NSTextLayoutManager

Source§

unsafe fn supportsSecureCoding() -> bool
where Self: Sized + ClassType,

Source§

impl NSTextSelectionDataSource for NSTextLayoutManager

Source§

unsafe fn documentRange(&self) -> Retained<NSTextRange>
where Self: Sized + Message,

Available on crate features NSTextSelectionNavigation and NSTextRange only.
Source§

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

Available on crate features NSTextRange and block2 and NSTextSelectionNavigation only.
Source§

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 and NSTextSelectionNavigation only.
Source§

unsafe fn locationFromLocation_withOffset( &self, location: &ProtocolObject<dyn NSTextLocation>, offset: NSInteger, ) -> Option<Retained<ProtocolObject<dyn NSTextLocation>>>
where Self: Sized + Message,

Available on crate features NSTextSelectionNavigation and NSTextRange only.
Source§

unsafe fn offsetFromLocation_toLocation( &self, from: &ProtocolObject<dyn NSTextLocation>, to: &ProtocolObject<dyn NSTextLocation>, ) -> NSInteger
where Self: Sized + Message,

Available on crate features NSTextSelectionNavigation and NSTextRange only.
Source§

unsafe fn baseWritingDirectionAtLocation( &self, location: &ProtocolObject<dyn NSTextLocation>, ) -> NSTextSelectionNavigationWritingDirection
where Self: Sized + Message,

Available on crate features NSTextSelectionNavigation and NSTextRange only.
Source§

unsafe fn enumerateCaretOffsetsInLineFragmentAtLocation_usingBlock( &self, location: &ProtocolObject<dyn NSTextLocation>, block: &DynBlock<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 and NSTextSelectionNavigation only.
Source§

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 and NSTextSelectionNavigation only.
Source§

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

Available on crate features NSTextRange and block2 and NSTextSelectionNavigation only.
Source§

unsafe fn textLayoutOrientationAtLocation( &self, location: &ProtocolObject<dyn NSTextLocation>, ) -> NSTextSelectionNavigationLayoutOrientation
where Self: Sized + Message,

Available on crate features NSTextSelectionNavigation and NSTextRange only.
Source§

impl PartialEq for NSTextLayoutManager

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RefEncode for NSTextLayoutManager

Source§

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

The Objective-C type-encoding for a reference of this type. Read more
Source§

impl DowncastTarget for NSTextLayoutManager

Source§

impl Eq for NSTextLayoutManager

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T> AnyThread for T
where T: ClassType<ThreadKind = dyn AnyThread + 'a> + ?Sized,

Source§

fn alloc() -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,