Struct NSTypesetter 

pub struct NSTypesetter { /* private fields */ }

Available on crate feature NSTypesetter only.

Apple’s documentation

Implementations

impl NSTypesetter

pub fn usesFontLeading(&self) -> bool

pub fn setUsesFontLeading(&self, uses_font_leading: bool)

Setter for usesFontLeading.

pub fn typesetterBehavior(&self) -> NSTypesetterBehavior

Available on crate feature NSLayoutManager only.

pub fn setTypesetterBehavior(&self, typesetter_behavior: NSTypesetterBehavior)

Available on crate feature NSLayoutManager only.

Setter for typesetterBehavior.

pub fn hyphenationFactor(&self) -> c_float

pub fn setHyphenationFactor(&self, hyphenation_factor: c_float)

Setter for hyphenationFactor.

pub fn lineFragmentPadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setLineFragmentPadding(&self, line_fragment_padding: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for lineFragmentPadding.

pub fn substituteFontForFont(&self, original_font: &NSFont) -> Retained<NSFont>

Available on crate feature NSFont only.

pub fn textTabForGlyphLocation_writingDirection_maxLocation( &self, glyph_location: CGFloat, direction: NSWritingDirection, max_location: CGFloat, ) -> Option<Retained<NSTextTab>>

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

pub fn bidiProcessingEnabled(&self) -> bool

pub fn setBidiProcessingEnabled(&self, bidi_processing_enabled: bool)

Setter for bidiProcessingEnabled.

pub unsafe fn attributedString(&self) -> Option<Retained<NSAttributedString>>

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn setAttributedString( &self, attributed_string: Option<&NSAttributedString>, )

Setter for attributedString.

Safety

This is unretained, you must ensure the object is kept alive while in use.

pub fn setParagraphGlyphRange_separatorGlyphRange( &self, paragraph_range: NSRange, paragraph_separator_range: NSRange, )

pub fn paragraphGlyphRange(&self) -> NSRange

pub fn paragraphSeparatorGlyphRange(&self) -> NSRange

pub fn paragraphCharacterRange(&self) -> NSRange

pub fn paragraphSeparatorCharacterRange(&self) -> NSRange

pub unsafe fn layoutParagraphAtPoint( &self, line_fragment_origin: NSPointPointer, ) -> NSUInteger

Safety

line_fragment_origin must be a valid pointer.

pub fn beginParagraph(&self)

pub fn endParagraph(&self)

pub fn beginLineWithGlyphAtIndex(&self, glyph_index: NSUInteger)

pub fn endLineWithGlyphRange(&self, line_glyph_range: NSRange)

pub fn lineSpacingAfterGlyphAtIndex_withProposedLineFragmentRect( &self, glyph_index: NSUInteger, rect: NSRect, ) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn paragraphSpacingBeforeGlyphAtIndex_withProposedLineFragmentRect( &self, glyph_index: NSUInteger, rect: NSRect, ) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn paragraphSpacingAfterGlyphAtIndex_withProposedLineFragmentRect( &self, glyph_index: NSUInteger, rect: NSRect, ) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn getLineFragmentRect_usedRect_forParagraphSeparatorGlyphRange_atProposedOrigin( &self, line_fragment_rect: NSRectPointer, line_fragment_used_rect: NSRectPointer, paragraph_separator_glyph_range: NSRange, line_origin: NSPoint, )

Safety

• line_fragment_rect must be a valid pointer.
• line_fragment_used_rect must be a valid pointer.

pub fn attributesForExtraLineFragment( &self, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

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

Available on crate feature NSLayoutManager only.

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn textContainers( &self, ) -> Option<Retained<NSArray<NSTextContainer>>>

Available on crate feature NSTextContainer only.

Safety

This is not retained internally, you must ensure the object is still alive.

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

Available on crate feature NSTextContainer only.

Safety

This is not retained internally, you must ensure the object is still alive.

pub fn currentParagraphStyle(&self) -> Option<Retained<NSParagraphStyle>>

Available on crate feature NSParagraphStyle only.

pub fn setHardInvalidation_forGlyphRange( &self, flag: bool, glyph_range: NSRange, )

pub unsafe fn layoutGlyphsInLayoutManager_startingAtGlyphIndex_maxNumberOfLineFragments_nextGlyphIndex( &self, layout_manager: &NSLayoutManager, start_glyph_index: NSUInteger, max_num_lines: NSUInteger, next_glyph: NonNull<NSUInteger>, )

Available on crate feature NSLayoutManager only.

Safety

next_glyph must be a valid pointer.

pub fn layoutCharactersInRange_forLayoutManager_maximumNumberOfLineFragments( &self, character_range: NSRange, layout_manager: &NSLayoutManager, max_num_lines: NSUInteger, ) -> NSRange

Available on crate feature NSLayoutManager only.

pub unsafe fn printingAdjustmentInLayoutManager_forNominallySpacedGlyphRange_packedGlyphs_count( layout_mgr: &NSLayoutManager, nominally_spaced_glyphs_range: NSRange, packed_glyphs: NonNull<c_uchar>, packed_glyphs_count: NSUInteger, ) -> NSSize

Available on crate feature NSLayoutManager only.

Safety

packed_glyphs must be a valid pointer.

pub fn baselineOffsetInLayoutManager_glyphIndex( &self, layout_mgr: &NSLayoutManager, glyph_index: NSUInteger, ) -> CGFloat

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

pub fn sharedSystemTypesetter() -> Retained<NSTypesetter>

pub fn sharedSystemTypesetterForBehavior( behavior: NSTypesetterBehavior, ) -> Retained<AnyObject>

Available on crate feature NSLayoutManager only.

pub fn defaultTypesetterBehavior() -> NSTypesetterBehavior

Available on crate feature NSLayoutManager only.

impl NSTypesetter

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

impl NSTypesetter

NSLayoutPhaseInterface.

pub unsafe fn willSetLineFragmentRect_forGlyphRange_usedRect_baselineOffset( &self, line_rect: NSRectPointer, glyph_range: NSRange, used_rect: NSRectPointer, baseline_offset: NonNull<CGFloat>, )

Available on crate feature objc2-core-foundation only.

Safety

• line_rect must be a valid pointer.
• used_rect must be a valid pointer.
• baseline_offset must be a valid pointer.

pub fn shouldBreakLineByWordBeforeCharacterAtIndex( &self, char_index: NSUInteger, ) -> bool

pub fn shouldBreakLineByHyphenatingBeforeCharacterAtIndex( &self, char_index: NSUInteger, ) -> bool

pub fn hyphenationFactorForGlyphAtIndex( &self, glyph_index: NSUInteger, ) -> c_float

pub fn hyphenCharacterForGlyphAtIndex(&self, glyph_index: NSUInteger) -> u32

pub fn boundingBoxForControlGlyphAtIndex_forTextContainer_proposedLineFragment_glyphPosition_characterIndex( &self, glyph_index: NSUInteger, text_container: &NSTextContainer, proposed_rect: NSRect, glyph_position: NSPoint, char_index: NSUInteger, ) -> NSRect

Available on crate feature NSTextContainer only.

impl NSTypesetter

NSGlyphStorageInterface.

pub unsafe fn characterRangeForGlyphRange_actualGlyphRange( &self, glyph_range: NSRange, actual_glyph_range: NSRangePointer, ) -> NSRange

Safety

actual_glyph_range must be a valid pointer or null.

pub unsafe fn glyphRangeForCharacterRange_actualCharacterRange( &self, char_range: NSRange, actual_char_range: NSRangePointer, ) -> NSRange

Safety

actual_char_range must be a valid pointer or null.

pub unsafe fn getLineFragmentRect_usedRect_remainingRect_forStartingGlyphAtIndex_proposedRect_lineSpacing_paragraphSpacingBefore_paragraphSpacingAfter( &self, line_fragment_rect: NSRectPointer, line_fragment_used_rect: NSRectPointer, remaining_rect: NSRectPointer, starting_glyph_index: NSUInteger, proposed_rect: NSRect, line_spacing: CGFloat, paragraph_spacing_before: CGFloat, paragraph_spacing_after: CGFloat, )

Available on crate feature objc2-core-foundation only.

Safety

• line_fragment_rect must be a valid pointer.
• line_fragment_used_rect must be a valid pointer.
• remaining_rect must be a valid pointer.

pub fn setLineFragmentRect_forGlyphRange_usedRect_baselineOffset( &self, fragment_rect: NSRect, glyph_range: NSRange, used_rect: NSRect, baseline_offset: CGFloat, )

Available on crate feature objc2-core-foundation only.

pub fn setNotShownAttribute_forGlyphRange( &self, flag: bool, glyph_range: NSRange, )

pub fn setDrawsOutsideLineFragment_forGlyphRange( &self, flag: bool, glyph_range: NSRange, )

pub unsafe fn setLocation_withAdvancements_forStartOfGlyphRange( &self, location: NSPoint, advancements: *const CGFloat, glyph_range: NSRange, )

Available on crate feature objc2-core-foundation only.

Safety

advancements must be a valid pointer.

pub fn setAttachmentSize_forGlyphRange( &self, attachment_size: NSSize, glyph_range: NSRange, )

pub unsafe fn setBidiLevels_forGlyphRange( &self, levels: *const u8, glyph_range: NSRange, )

Safety

levels must be a valid pointer.

impl NSTypesetter

NSTypesetter_Deprecated.

pub fn actionForControlCharacterAtIndex( &self, char_index: NSUInteger, ) -> NSTypesetterControlCharacterAction

pub unsafe fn getGlyphsInRange_glyphs_characterIndexes_glyphInscriptions_elasticBits_bidiLevels( &self, glyphs_range: NSRange, glyph_buffer: *mut NSGlyph, char_index_buffer: *mut NSUInteger, inscribe_buffer: *mut NSGlyphInscription, elastic_buffer: *mut Bool, bidi_level_buffer: *mut c_uchar, ) -> NSUInteger

👎Deprecated

Available on crate features NSFont and NSLayoutManager only.

Safety

• glyph_buffer must be a valid pointer.
• char_index_buffer must be a valid pointer.
• inscribe_buffer must be a valid pointer.
• elastic_buffer must be a valid pointer.
• bidi_level_buffer must be a valid pointer.

pub unsafe fn substituteGlyphsInRange_withGlyphs( &self, glyph_range: NSRange, glyphs: *mut NSGlyph, )

👎Deprecated

Available on crate feature NSFont only.

Safety

glyphs must be a valid pointer.

pub fn insertGlyph_atGlyphIndex_characterIndex( &self, glyph: NSGlyph, glyph_index: NSUInteger, character_index: NSUInteger, )

👎Deprecated

Available on crate feature NSFont only.

pub fn deleteGlyphsInRange(&self, glyph_range: NSRange)

👎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 NSTypesetter

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSTypesetter

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSTypesetter> for NSATSTypesetter

Available on crate feature NSATSTypesetter only.

fn as_ref(&self) -> &NSTypesetter

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

impl AsRef<NSTypesetter> for NSTypesetter

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSTypesetter

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSTypesetter

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSTypesetter> for NSATSTypesetter

Available on crate feature NSATSTypesetter only.

fn borrow(&self) -> &NSTypesetter

Immutably borrows from an owned value.

impl ClassType for NSTypesetter

const NAME: &'static str = "NSTypesetter"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl DefaultRetained for NSTypesetter

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSTypesetter

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSTypesetter

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 NSTypesetter

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSTypesetter

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 PartialEq for NSTypesetter

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 NSTypesetter

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

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

impl DowncastTarget for NSTypesetter

impl Eq for NSTypesetter