Struct NSTextContainer

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

Available on crate feature NSTextContainer only.

Apple’s documentation

Implementations

impl NSTextContainer

pub unsafe fn initWithSize( this: Allocated<Self>, size: CGSize, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

************************** Initialization ***************************

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

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

Available on crate feature NSTextLayoutManager only.

pub unsafe fn size(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

*********************** Container shape properties ************************

pub unsafe fn setSize(&self, size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for size.

pub unsafe fn lineBreakMode(&self) -> NSLineBreakMode

Available on crate feature NSParagraphStyle only.

pub unsafe fn setLineBreakMode(&self, line_break_mode: NSLineBreakMode)

Available on crate feature NSParagraphStyle only.

Setter for lineBreakMode.

pub unsafe fn lineFragmentPadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

*********************** Layout constraint properties ************************

pub unsafe fn setLineFragmentPadding(&self, line_fragment_padding: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for lineFragmentPadding.

pub unsafe fn maximumNumberOfLines(&self) -> NSUInteger

pub unsafe fn setMaximumNumberOfLines( &self, maximum_number_of_lines: NSUInteger, )

Setter for maximumNumberOfLines.

pub unsafe fn lineFragmentRectForProposedRect_atIndex_writingDirection_remainingRect( &self, proposed_rect: CGRect, character_index: NSUInteger, base_writing_direction: NSWritingDirection, remaining_rect: *mut CGRect, ) -> CGRect

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

************************** Line fragments ***************************

pub unsafe fn isSimpleRectangularTextContainer(&self) -> bool

pub unsafe fn widthTracksTextView(&self) -> bool

************************** View synchronization ***************************

pub unsafe fn setWidthTracksTextView(&self, width_tracks_text_view: bool)

Setter for widthTracksTextView.

pub unsafe fn heightTracksTextView(&self) -> bool

pub unsafe fn setHeightTracksTextView(&self, height_tracks_text_view: bool)

Setter for heightTracksTextView.

impl NSTextContainer

Methods declared on superclass NSObject.

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

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

impl NSTextContainer

pub unsafe fn layoutManager(&self) -> Option<Retained<NSLayoutManager>>

Available on crate feature NSLayoutManager only.

pub unsafe fn setLayoutManager(&self, layout_manager: Option<&NSLayoutManager>)

Available on crate feature NSLayoutManager only.

Setter for layoutManager.

pub unsafe fn replaceLayoutManager(&self, new_layout_manager: &NSLayoutManager)

Available on crate feature NSLayoutManager only.

pub unsafe fn exclusionPaths(&self) -> Retained<NSArray<NSBezierPath>>

Available on crate feature NSBezierPath only.

pub unsafe fn setExclusionPaths(&self, exclusion_paths: &NSArray<NSBezierPath>)

Available on crate feature NSBezierPath only.

Setter for exclusionPaths.

pub unsafe fn textView( &self, mtm: MainThreadMarker, ) -> Option<Retained<NSTextView>>

Available on crate features NSResponder and NSText and NSTextView and NSView only.

pub unsafe fn setTextView(&self, text_view: Option<&NSTextView>)

Available on crate features NSResponder and NSText and NSTextView and NSView only.

This is a weak property. Setter for textView.

impl NSTextContainer

NSTextContainerDeprecated.

pub unsafe fn initWithContainerSize( this: Allocated<Self>, a_container_size: NSSize, ) -> Retained<Self>

pub unsafe fn containerSize(&self) -> NSSize

pub unsafe fn setContainerSize(&self, container_size: NSSize)

Setter for containerSize.

pub unsafe fn lineFragmentRectForProposedRect_sweepDirection_movementDirection_remainingRect( &self, proposed_rect: NSRect, sweep_direction: NSLineSweepDirection, movement_direction: NSLineMovementDirection, remaining_rect: NSRectPointer, ) -> NSRect

pub unsafe fn containsPoint(&self, point: NSPoint) -> bool

👎Deprecated

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 NSTextContainer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSTextContainer

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSTextContainer> for NSTextContainer

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSTextContainer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSTextContainer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSTextContainer

const NAME: &'static str = "NSTextContainer"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSTextContainer

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSTextContainer

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 NSTextContainer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSTextContainer

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 NSTextContainer

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 NSTextContainer

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl NSTextLayoutOrientationProvider for NSTextContainer

unsafe fn layoutOrientation(&self) -> NSTextLayoutOrientation

where Self: Sized + Message,

Available on crate feature NSLayoutManager only.

impl PartialEq for NSTextContainer

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 NSTextContainer

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

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

impl DowncastTarget for NSTextContainer

impl Eq for NSTextContainer