Struct NSTypesetter

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

Implementations§

Source§

impl NSTypesetter

Source

pub unsafe fn usesFontLeading(&self) -> bool

Source

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

Setter for usesFontLeading.

Source

pub unsafe fn typesetterBehavior(&self) -> NSTypesetterBehavior

Available on crate feature NSLayoutManager only.
Source

pub unsafe fn setTypesetterBehavior( &self, typesetter_behavior: NSTypesetterBehavior, )

Available on crate feature NSLayoutManager only.

Setter for typesetterBehavior.

Source

pub unsafe fn hyphenationFactor(&self) -> c_float

Source

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

Setter for hyphenationFactor.

Source

pub unsafe fn lineFragmentPadding(&self) -> CGFloat

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

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

Available on crate feature objc2-core-foundation only.

Setter for lineFragmentPadding.

Source

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

Available on crate feature NSFont only.
Source

pub unsafe 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.
Source

pub unsafe fn bidiProcessingEnabled(&self) -> bool

Source

pub unsafe fn setBidiProcessingEnabled(&self, bidi_processing_enabled: bool)

Source

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

Source

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

Setter for attributedString.

Source

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

Source

pub unsafe fn paragraphGlyphRange(&self) -> NSRange

Source

pub unsafe fn paragraphSeparatorGlyphRange(&self) -> NSRange

Source

pub unsafe fn paragraphCharacterRange(&self) -> NSRange

Source

pub unsafe fn paragraphSeparatorCharacterRange(&self) -> NSRange

Source

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

Source

pub unsafe fn beginParagraph(&self)

Source

pub unsafe fn endParagraph(&self)

Source

pub unsafe fn beginLineWithGlyphAtIndex(&self, glyph_index: NSUInteger)

Source

pub unsafe fn endLineWithGlyphRange(&self, line_glyph_range: NSRange)

Source

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

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

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

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

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

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

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, )

Source

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

Source

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

Available on crate feature NSLayoutManager only.
Source

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

Available on crate feature NSTextContainer only.
Source

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

Available on crate feature NSTextContainer only.
Source

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

Available on crate feature NSParagraphStyle only.
Source

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

Source

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

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

Available on crate feature NSLayoutManager only.
Source

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

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

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

pub unsafe fn sharedSystemTypesetter() -> Retained<NSTypesetter>

Source

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

Available on crate feature NSLayoutManager only.
Source

pub unsafe fn defaultTypesetterBehavior() -> NSTypesetterBehavior

Available on crate feature NSLayoutManager only.
Source§

impl NSTypesetter

Methods declared on superclass NSObject.

Source

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

Source

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

Source§

impl NSTypesetter

NSLayoutPhaseInterface.

Source

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

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

Source

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

Source

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

Source

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

Source

pub unsafe 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.
Source§

impl NSTypesetter

NSGlyphStorageInterface.

Source

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

Source

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

Source

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

pub unsafe 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.
Source

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

Source

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

Source

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

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

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

Source

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

Source§

impl NSTypesetter

NSTypesetter_Deprecated.

Source

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

Source

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

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

👎Deprecated
Available on crate feature NSFont only.
Source

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

👎Deprecated
Available on crate feature NSFont only.
Source

pub unsafe fn deleteGlyphsInRange(&self, glyph_range: NSRange)

👎Deprecated

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

Source

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§

Source§

impl AsRef<AnyObject> for NSTypesetter

Source§

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSTypesetter

Source§

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSTypesetter> for NSATSTypesetter

Available on crate feature NSATSTypesetter only.
Source§

fn as_ref(&self) -> &NSTypesetter

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

impl AsRef<NSTypesetter> for NSTypesetter

Source§

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSTypesetter

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSObject> for NSTypesetter

Source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSTypesetter> for NSATSTypesetter

Available on crate feature NSATSTypesetter only.
Source§

fn borrow(&self) -> &NSTypesetter

Immutably borrows from an owned value. Read more
Source§

impl ClassType for NSTypesetter

Source§

const NAME: &'static str = "NSTypesetter"

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

Source§

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

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

impl Deref for NSTypesetter

Source§

type Target = NSObject

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl Hash for NSTypesetter

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 NSTypesetter

Source§

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

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

impl NSObjectProtocol for NSTypesetter

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

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 NSTypesetter

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 NSTypesetter

Source§

impl Eq for NSTypesetter

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,