Struct NSPresentationIntent

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

Available on crate feature NSAttributedString only.

Apple’s documentation

Implementations

impl NSPresentationIntent

pub unsafe fn intentKind(&self) -> NSPresentationIntentKind

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

pub unsafe fn parentIntent(&self) -> Option<Retained<NSPresentationIntent>>

pub unsafe fn paragraphIntentWithIdentity_nestedInsideIntent( identity: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn headerIntentWithIdentity_level_nestedInsideIntent( identity: NSInteger, level: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn codeBlockIntentWithIdentity_languageHint_nestedInsideIntent( identity: NSInteger, language_hint: Option<&NSString>, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

Available on crate feature NSString only.

pub unsafe fn thematicBreakIntentWithIdentity_nestedInsideIntent( identity: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn orderedListIntentWithIdentity_nestedInsideIntent( identity: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn unorderedListIntentWithIdentity_nestedInsideIntent( identity: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn listItemIntentWithIdentity_ordinal_nestedInsideIntent( identity: NSInteger, ordinal: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn blockQuoteIntentWithIdentity_nestedInsideIntent( identity: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn tableIntentWithIdentity_columnCount_alignments_nestedInsideIntent( identity: NSInteger, column_count: NSInteger, alignments: &NSArray<NSNumber>, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

Available on crate features NSArray and NSValue only.

pub unsafe fn tableHeaderRowIntentWithIdentity_nestedInsideIntent( identity: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn tableRowIntentWithIdentity_row_nestedInsideIntent( identity: NSInteger, row: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn tableCellIntentWithIdentity_column_nestedInsideIntent( identity: NSInteger, column: NSInteger, parent: Option<&NSPresentationIntent>, ) -> Retained<NSPresentationIntent>

pub unsafe fn identity(&self) -> NSInteger

An integer value which uniquely identifies this intent in the document. Identity disambiguates attributes which apply to contiguous text – for example, two headers in a row with the same level. It can also be used to track the location in an attributed string of a particular part of a document, even after mutation.

pub unsafe fn ordinal(&self) -> NSInteger

If the intent is not a list, this value is 0.

pub unsafe fn columnAlignments(&self) -> Option<Retained<NSArray<NSNumber>>>

Available on crate features NSArray and NSValue only.

If the intent is not a table, this value is nil.

pub unsafe fn columnCount(&self) -> NSInteger

If the intent is not a table, this value is 0.

pub unsafe fn headerLevel(&self) -> NSInteger

If the intent is not a header, this value is 0.

pub unsafe fn languageHint(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

If the intent is not a code block, this value is nil.

pub unsafe fn column(&self) -> NSInteger

The column to which this cell belongs (0-based). If the intent is not a cell, this value is 0.

pub unsafe fn row(&self) -> NSInteger

The row to which this cell belongs (0-based). If the intent is not a row, this value is 0. Header rows are always row 0. If the table has more rows, those start at row 1.

pub unsafe fn indentationLevel(&self) -> NSInteger

The indentation level of this intent. Each nested list increases the indentation level by one; all elements within the same list (and not then nested into a child list intent) have the same indentation level. Text outside list intents has an indentation level of 0.

pub unsafe fn isEquivalentToPresentationIntent( &self, other: &NSPresentationIntent, ) -> bool

Returns YES if this intent is equivalent to the other presentation intent. Equivalence is the same as equality except that identity is not taken into account.

impl NSPresentationIntent

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

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.

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,

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 NSPresentationIntent

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSPresentationIntent

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSPresentationIntent> for NSPresentationIntent

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSPresentationIntent

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSPresentationIntent

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSPresentationIntent

const NAME: &'static str = "NSPresentationIntent"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSPresentationIntent 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 CopyingHelper for NSPresentationIntent

Available on crate feature NSObject only.

type Result = NSPresentationIntent

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NSPresentationIntent

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

Formats the value using the given formatter.

impl Deref for NSPresentationIntent

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSPresentationIntent

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 NSPresentationIntent

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSPresentationIntent

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

impl NSCopying for NSPresentationIntent

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSPresentationIntent

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 NSPresentationIntent

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl PartialEq for NSPresentationIntent

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 NSPresentationIntent

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

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

impl DowncastTarget for NSPresentationIntent

impl Eq for NSPresentationIntent