Struct NSMutableParagraphStyle

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

Available on crate feature NSParagraphStyle only.

Apple’s documentation

Implementations

impl NSMutableParagraphStyle

pub unsafe fn lineSpacing(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setLineSpacing(&self, line_spacing: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for lineSpacing.

pub unsafe fn paragraphSpacing(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setParagraphSpacing(&self, paragraph_spacing: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for paragraphSpacing.

pub unsafe fn firstLineHeadIndent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setFirstLineHeadIndent(&self, first_line_head_indent: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for firstLineHeadIndent.

pub unsafe fn headIndent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setHeadIndent(&self, head_indent: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for headIndent.

pub unsafe fn tailIndent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setTailIndent(&self, tail_indent: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for tailIndent.

pub unsafe fn lineBreakMode(&self) -> NSLineBreakMode

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

Setter for lineBreakMode.

pub unsafe fn minimumLineHeight(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setMinimumLineHeight(&self, minimum_line_height: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumLineHeight.

pub unsafe fn maximumLineHeight(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setMaximumLineHeight(&self, maximum_line_height: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for maximumLineHeight.

pub unsafe fn baseWritingDirection(&self) -> NSWritingDirection

Available on crate feature NSText only.

pub unsafe fn setBaseWritingDirection( &self, base_writing_direction: NSWritingDirection, )

Available on crate feature NSText only.

Setter for baseWritingDirection.

pub unsafe fn lineHeightMultiple(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setLineHeightMultiple(&self, line_height_multiple: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for lineHeightMultiple.

pub unsafe fn paragraphSpacingBefore(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setParagraphSpacingBefore( &self, paragraph_spacing_before: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for paragraphSpacingBefore.

pub unsafe fn hyphenationFactor(&self) -> c_float

pub unsafe fn setHyphenationFactor(&self, hyphenation_factor: c_float)

Setter for hyphenationFactor.

pub unsafe fn usesDefaultHyphenation(&self) -> bool

pub unsafe fn setUsesDefaultHyphenation(&self, uses_default_hyphenation: bool)

Setter for usesDefaultHyphenation.

pub unsafe fn tabStops(&self) -> Retained<NSArray<NSTextTab>>

pub unsafe fn setTabStops(&self, tab_stops: Option<&NSArray<NSTextTab>>)

Setter for tabStops.

pub unsafe fn defaultTabInterval(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setDefaultTabInterval(&self, default_tab_interval: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for defaultTabInterval.

pub unsafe fn allowsDefaultTighteningForTruncation(&self) -> bool

pub unsafe fn setAllowsDefaultTighteningForTruncation( &self, allows_default_tightening_for_truncation: bool, )

Setter for allowsDefaultTighteningForTruncation.

pub unsafe fn lineBreakStrategy(&self) -> NSLineBreakStrategy

pub unsafe fn setLineBreakStrategy( &self, line_break_strategy: NSLineBreakStrategy, )

Setter for lineBreakStrategy.

pub unsafe fn textLists(&self) -> Retained<NSArray<NSTextList>>

Available on crate feature NSTextList only.

pub unsafe fn setTextLists(&self, text_lists: &NSArray<NSTextList>)

Available on crate feature NSTextList only.

Setter for textLists.

pub unsafe fn addTabStop(&self, an_object: &NSTextTab)

pub unsafe fn removeTabStop(&self, an_object: &NSTextTab)

pub unsafe fn setParagraphStyle(&self, obj: &NSParagraphStyle)

impl NSMutableParagraphStyle

Methods declared on superclass NSObject.

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

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

impl NSMutableParagraphStyle

pub unsafe fn alignment(&self) -> NSTextAlignment

Available on crate feature NSText only.

pub unsafe fn setAlignment(&self, alignment: NSTextAlignment)

Available on crate feature NSText only.

Setter for alignment.

Methods from Deref<Target = NSParagraphStyle>

pub unsafe fn lineSpacing(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn paragraphSpacing(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn headIndent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn tailIndent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn firstLineHeadIndent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn minimumLineHeight(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn maximumLineHeight(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn lineBreakMode(&self) -> NSLineBreakMode

pub unsafe fn baseWritingDirection(&self) -> NSWritingDirection

Available on crate feature NSText only.

pub unsafe fn lineHeightMultiple(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn paragraphSpacingBefore(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn hyphenationFactor(&self) -> c_float

pub unsafe fn usesDefaultHyphenation(&self) -> bool

pub unsafe fn tabStops(&self) -> Retained<NSArray<NSTextTab>>

pub unsafe fn defaultTabInterval(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn textLists(&self) -> Retained<NSArray<NSTextList>>

Available on crate feature NSTextList only.

pub unsafe fn allowsDefaultTighteningForTruncation(&self) -> bool

pub unsafe fn lineBreakStrategy(&self) -> NSLineBreakStrategy

pub unsafe fn alignment(&self) -> NSTextAlignment

Available on crate feature NSText only.

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 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());

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.

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

impl AsRef<AnyObject> for NSMutableParagraphStyle

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSMutableParagraphStyle> for NSMutableParagraphStyle

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSMutableParagraphStyle

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSParagraphStyle> for NSMutableParagraphStyle

fn as_ref(&self) -> &NSParagraphStyle

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

impl Borrow<AnyObject> for NSMutableParagraphStyle

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSMutableParagraphStyle

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSParagraphStyle> for NSMutableParagraphStyle

fn borrow(&self) -> &NSParagraphStyle

Immutably borrows from an owned value.

impl ClassType for NSMutableParagraphStyle

const NAME: &'static str = "NSMutableParagraphStyle"

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

type Super = NSParagraphStyle

The superclass of this class.

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

type Result = NSParagraphStyle

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

impl Debug for NSMutableParagraphStyle

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

Formats the value using the given formatter.

impl Deref for NSMutableParagraphStyle

type Target = NSParagraphStyle

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSMutableParagraphStyle

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 NSMutableParagraphStyle

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

where Self: Sized,

Increment the reference count of the receiver.

impl MutableCopyingHelper for NSMutableParagraphStyle

type Result = NSMutableParagraphStyle

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

impl NSCoding for NSMutableParagraphStyle

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 NSCopying for NSMutableParagraphStyle

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

where Self: Sized + Message + CopyingHelper,

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,

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

impl NSMutableCopying for NSMutableParagraphStyle

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

where Self: Sized + Message + MutableCopyingHelper,

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

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

where Self: Sized + Message + MutableCopyingHelper,

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

impl NSObjectProtocol for NSMutableParagraphStyle

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 NSMutableParagraphStyle

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSMutableParagraphStyle

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 NSMutableParagraphStyle

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

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

impl DowncastTarget for NSMutableParagraphStyle

impl Eq for NSMutableParagraphStyle