Struct NSLayoutManager 

pub struct NSLayoutManager { /* private fields */ }

Available on crate feature NSLayoutManager only.

Apple’s documentation

Implementations

impl NSLayoutManager

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

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

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

Safety

coder possibly has further requirements.

pub unsafe fn textStorage(&self) -> Option<Retained<NSTextStorage>>

Available on crate feature NSTextStorage only.

************************* Text storage **************************

Safety

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

pub unsafe fn setTextStorage(&self, text_storage: Option<&NSTextStorage>)

Available on crate feature NSTextStorage only.

Setter for textStorage.

Safety

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

pub fn replaceTextStorage(&self, new_text_storage: &NSTextStorage)

Available on crate feature NSTextStorage only.

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

Available on crate feature NSTextContainer only.

************************** Text containers ***************************

pub fn addTextContainer(&self, container: &NSTextContainer)

Available on crate feature NSTextContainer only.

pub fn insertTextContainer_atIndex( &self, container: &NSTextContainer, index: NSUInteger, )

Available on crate feature NSTextContainer only.

pub fn removeTextContainerAtIndex(&self, index: NSUInteger)

pub fn textContainerChangedGeometry(&self, container: &NSTextContainer)

Available on crate feature NSTextContainer only.

pub fn textContainerChangedTextView(&self, container: &NSTextContainer)

Available on crate feature NSTextContainer only.

pub fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSLayoutManagerDelegate>>>

************************** Delegate ***************************

pub fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSLayoutManagerDelegate>>, )

Setter for delegate.

This is a weak property.

pub fn showsInvisibleCharacters(&self) -> bool

********************* Global layout manager options **********************

pub fn setShowsInvisibleCharacters(&self, shows_invisible_characters: bool)

Setter for showsInvisibleCharacters.

pub fn showsControlCharacters(&self) -> bool

pub fn setShowsControlCharacters(&self, shows_control_characters: bool)

Setter for showsControlCharacters.

pub fn usesDefaultHyphenation(&self) -> bool

pub fn setUsesDefaultHyphenation(&self, uses_default_hyphenation: bool)

Setter for usesDefaultHyphenation.

pub fn usesFontLeading(&self) -> bool

pub fn setUsesFontLeading(&self, uses_font_leading: bool)

Setter for usesFontLeading.

pub fn allowsNonContiguousLayout(&self) -> bool

pub fn setAllowsNonContiguousLayout(&self, allows_non_contiguous_layout: bool)

Setter for allowsNonContiguousLayout.

pub fn hasNonContiguousLayout(&self) -> bool

pub fn limitsLayoutForSuspiciousContents(&self) -> bool

pub fn setLimitsLayoutForSuspiciousContents( &self, limits_layout_for_suspicious_contents: bool, )

Setter for limitsLayoutForSuspiciousContents.

pub fn backgroundLayoutEnabled(&self) -> bool

pub fn setBackgroundLayoutEnabled(&self, background_layout_enabled: bool)

Setter for backgroundLayoutEnabled.

pub fn defaultAttachmentScaling(&self) -> NSImageScaling

Available on crate feature NSCell only.

pub fn setDefaultAttachmentScaling( &self, default_attachment_scaling: NSImageScaling, )

Available on crate feature NSCell only.

Setter for defaultAttachmentScaling.

pub fn typesetter(&self) -> Retained<NSTypesetter>

Available on crate feature NSTypesetter only.

********************* Typesetter **********************

pub fn setTypesetter(&self, typesetter: &NSTypesetter)

Available on crate feature NSTypesetter only.

Setter for typesetter.

pub fn typesetterBehavior(&self) -> NSTypesetterBehavior

pub fn setTypesetterBehavior(&self, typesetter_behavior: NSTypesetterBehavior)

Setter for typesetterBehavior.

pub unsafe fn invalidateGlyphsForCharacterRange_changeInLength_actualCharacterRange( &self, char_range: NSRange, delta: NSInteger, actual_char_range: NSRangePointer, )

************************ Invalidation *************************

Safety

actual_char_range must be a valid pointer or null.

pub unsafe fn invalidateLayoutForCharacterRange_actualCharacterRange( &self, char_range: NSRange, actual_char_range: NSRangePointer, )

Safety

actual_char_range must be a valid pointer or null.

pub fn invalidateDisplayForCharacterRange(&self, char_range: NSRange)

pub fn invalidateDisplayForGlyphRange(&self, glyph_range: NSRange)

pub fn processEditingForTextStorage_edited_range_changeInLength_invalidatedRange( &self, text_storage: &NSTextStorage, edit_mask: NSTextStorageEditActions, new_char_range: NSRange, delta: NSInteger, invalidated_char_range: NSRange, )

Available on crate feature NSTextStorage only.

pub fn ensureGlyphsForCharacterRange(&self, char_range: NSRange)

********************** Causing glyph generation and layout ***********************

pub fn ensureGlyphsForGlyphRange(&self, glyph_range: NSRange)

pub fn ensureLayoutForCharacterRange(&self, char_range: NSRange)

pub fn ensureLayoutForGlyphRange(&self, glyph_range: NSRange)

pub fn ensureLayoutForTextContainer(&self, container: &NSTextContainer)

Available on crate feature NSTextContainer only.

pub fn ensureLayoutForBoundingRect_inTextContainer( &self, bounds: NSRect, container: &NSTextContainer, )

Available on crate feature NSTextContainer only.

pub fn numberOfGlyphs(&self) -> NSUInteger

********************** Get glyphs and glyph properties ***********************

pub fn isValidGlyphIndex(&self, glyph_index: NSUInteger) -> bool

pub fn propertyForGlyphAtIndex( &self, glyph_index: NSUInteger, ) -> NSGlyphProperty

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

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

pub fn setTextContainer_forGlyphRange( &self, container: &NSTextContainer, glyph_range: NSRange, )

Available on crate feature NSTextContainer only.

pub fn setLineFragmentRect_forGlyphRange_usedRect( &self, fragment_rect: NSRect, glyph_range: NSRange, used_rect: NSRect, )

pub fn setExtraLineFragmentRect_usedRect_textContainer( &self, fragment_rect: NSRect, used_rect: NSRect, container: &NSTextContainer, )

Available on crate feature NSTextContainer only.

pub fn setLocation_forStartOfGlyphRange( &self, location: NSPoint, glyph_range: NSRange, )

pub fn setNotShownAttribute_forGlyphAtIndex( &self, flag: bool, glyph_index: NSUInteger, )

pub fn setDrawsOutsideLineFragment_forGlyphAtIndex( &self, flag: bool, glyph_index: NSUInteger, )

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

pub unsafe fn getFirstUnlaidCharacterIndex_glyphIndex( &self, char_index: *mut NSUInteger, glyph_index: *mut NSUInteger, )

********************** Get layout information ***********************

Safety

• char_index must be a valid pointer or null.
• glyph_index must be a valid pointer or null.

pub fn firstUnlaidCharacterIndex(&self) -> NSUInteger

pub fn firstUnlaidGlyphIndex(&self) -> NSUInteger

pub unsafe fn textContainerForGlyphAtIndex_effectiveRange( &self, glyph_index: NSUInteger, effective_glyph_range: NSRangePointer, ) -> Option<Retained<NSTextContainer>>

Available on crate feature NSTextContainer only.

Safety

effective_glyph_range must be a valid pointer or null.

pub unsafe fn textContainerForGlyphAtIndex_effectiveRange_withoutAdditionalLayout( &self, glyph_index: NSUInteger, effective_glyph_range: NSRangePointer, flag: bool, ) -> Option<Retained<NSTextContainer>>

Available on crate feature NSTextContainer only.

Safety

effective_glyph_range must be a valid pointer or null.

pub fn usedRectForTextContainer(&self, container: &NSTextContainer) -> NSRect

Available on crate feature NSTextContainer only.

pub unsafe fn lineFragmentRectForGlyphAtIndex_effectiveRange( &self, glyph_index: NSUInteger, effective_glyph_range: NSRangePointer, ) -> NSRect

Safety

effective_glyph_range must be a valid pointer or null.

pub unsafe fn lineFragmentRectForGlyphAtIndex_effectiveRange_withoutAdditionalLayout( &self, glyph_index: NSUInteger, effective_glyph_range: NSRangePointer, flag: bool, ) -> NSRect

Safety

effective_glyph_range must be a valid pointer or null.

pub unsafe fn lineFragmentUsedRectForGlyphAtIndex_effectiveRange( &self, glyph_index: NSUInteger, effective_glyph_range: NSRangePointer, ) -> NSRect

Safety

effective_glyph_range must be a valid pointer or null.

pub unsafe fn lineFragmentUsedRectForGlyphAtIndex_effectiveRange_withoutAdditionalLayout( &self, glyph_index: NSUInteger, effective_glyph_range: NSRangePointer, flag: bool, ) -> NSRect

Safety

effective_glyph_range must be a valid pointer or null.

pub fn extraLineFragmentRect(&self) -> NSRect

pub fn extraLineFragmentUsedRect(&self) -> NSRect

pub fn extraLineFragmentTextContainer( &self, ) -> Option<Retained<NSTextContainer>>

Available on crate feature NSTextContainer only.

pub fn locationForGlyphAtIndex(&self, glyph_index: NSUInteger) -> NSPoint

pub fn notShownAttributeForGlyphAtIndex(&self, glyph_index: NSUInteger) -> bool

pub fn drawsOutsideLineFragmentForGlyphAtIndex( &self, glyph_index: NSUInteger, ) -> bool

pub fn attachmentSizeForGlyphAtIndex(&self, glyph_index: NSUInteger) -> NSSize

pub fn truncatedGlyphRangeInLineFragmentForGlyphAtIndex( &self, glyph_index: NSUInteger, ) -> NSRange

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

********************** More sophisticated queries ***********************

Safety

actual_char_range must be a valid pointer or null.

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 fn glyphRangeForTextContainer(&self, container: &NSTextContainer) -> NSRange

Available on crate feature NSTextContainer only.

pub fn rangeOfNominallySpacedGlyphsContainingIndex( &self, glyph_index: NSUInteger, ) -> NSRange

pub fn boundingRectForGlyphRange_inTextContainer( &self, glyph_range: NSRange, container: &NSTextContainer, ) -> NSRect

Available on crate feature NSTextContainer only.

pub fn glyphRangeForBoundingRect_inTextContainer( &self, bounds: NSRect, container: &NSTextContainer, ) -> NSRange

Available on crate feature NSTextContainer only.

pub fn glyphRangeForBoundingRectWithoutAdditionalLayout_inTextContainer( &self, bounds: NSRect, container: &NSTextContainer, ) -> NSRange

Available on crate feature NSTextContainer only.

pub unsafe fn glyphIndexForPoint_inTextContainer_fractionOfDistanceThroughGlyph( &self, point: NSPoint, container: &NSTextContainer, partial_fraction: *mut CGFloat, ) -> NSUInteger

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

Safety

partial_fraction must be a valid pointer or null.

pub fn glyphIndexForPoint_inTextContainer( &self, point: NSPoint, container: &NSTextContainer, ) -> NSUInteger

Available on crate feature NSTextContainer only.

pub fn fractionOfDistanceThroughGlyphForPoint_inTextContainer( &self, point: NSPoint, container: &NSTextContainer, ) -> CGFloat

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

pub unsafe fn characterIndexForPoint_inTextContainer_fractionOfDistanceBetweenInsertionPoints( &self, point: NSPoint, container: &NSTextContainer, partial_fraction: *mut CGFloat, ) -> NSUInteger

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

Safety

partial_fraction must be a valid pointer or null.

pub unsafe fn getLineFragmentInsertionPointsForCharacterAtIndex_alternatePositions_inDisplayOrder_positions_characterIndexes( &self, char_index: NSUInteger, a_flag: bool, d_flag: bool, positions: *mut CGFloat, char_indexes: *mut NSUInteger, ) -> NSUInteger

Available on crate feature objc2-core-foundation only.

Safety

• positions must be a valid pointer or null.
• char_indexes must be a valid pointer or null.

pub fn enumerateLineFragmentsForGlyphRange_usingBlock( &self, glyph_range: NSRange, block: &DynBlock<dyn Fn(NSRect, NSRect, NonNull<NSTextContainer>, NSRange, NonNull<Bool>)>, )

Available on crate features NSTextContainer and block2 only.

pub fn enumerateEnclosingRectsForGlyphRange_withinSelectedGlyphRange_inTextContainer_usingBlock( &self, glyph_range: NSRange, selected_range: NSRange, text_container: &NSTextContainer, block: &DynBlock<dyn Fn(NSRect, NonNull<Bool>)>, )

Available on crate features NSTextContainer and block2 only.

pub fn drawBackgroundForGlyphRange_atPoint( &self, glyphs_to_show: NSRange, origin: NSPoint, )

********************** Drawing support ***********************

pub fn drawGlyphsForGlyphRange_atPoint( &self, glyphs_to_show: NSRange, origin: NSPoint, )

pub unsafe fn fillBackgroundRectArray_count_forCharacterRange_color( &self, rect_array: NonNull<NSRect>, rect_count: NSUInteger, char_range: NSRange, color: &NSColor, )

Available on crate feature NSColor only.

Safety

rect_array must be a valid pointer.

pub fn drawUnderlineForGlyphRange_underlineType_baselineOffset_lineFragmentRect_lineFragmentGlyphRange_containerOrigin( &self, glyph_range: NSRange, underline_val: NSUnderlineStyle, baseline_offset: CGFloat, line_rect: NSRect, line_glyph_range: NSRange, container_origin: NSPoint, )

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

pub fn underlineGlyphRange_underlineType_lineFragmentRect_lineFragmentGlyphRange_containerOrigin( &self, glyph_range: NSRange, underline_val: NSUnderlineStyle, line_rect: NSRect, line_glyph_range: NSRange, container_origin: NSPoint, )

Available on crate feature NSAttributedString only.

pub fn drawStrikethroughForGlyphRange_strikethroughType_baselineOffset_lineFragmentRect_lineFragmentGlyphRange_containerOrigin( &self, glyph_range: NSRange, strikethrough_val: NSUnderlineStyle, baseline_offset: CGFloat, line_rect: NSRect, line_glyph_range: NSRange, container_origin: NSPoint, )

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

pub fn strikethroughGlyphRange_strikethroughType_lineFragmentRect_lineFragmentGlyphRange_containerOrigin( &self, glyph_range: NSRange, strikethrough_val: NSUnderlineStyle, line_rect: NSRect, line_glyph_range: NSRange, container_origin: NSPoint, )

Available on crate feature NSAttributedString only.

pub fn showAttachmentCell_inRect_characterIndex( &self, cell: &NSCell, rect: NSRect, attachment_index: NSUInteger, )

Available on crate feature NSCell only.

pub fn setLayoutRect_forTextBlock_glyphRange( &self, rect: NSRect, block: &NSTextBlock, glyph_range: NSRange, )

Available on crate feature NSTextTable only.

************************ Block information *************************

pub fn setBoundsRect_forTextBlock_glyphRange( &self, rect: NSRect, block: &NSTextBlock, glyph_range: NSRange, )

Available on crate feature NSTextTable only.

pub fn layoutRectForTextBlock_glyphRange( &self, block: &NSTextBlock, glyph_range: NSRange, ) -> NSRect

Available on crate feature NSTextTable only.

pub fn boundsRectForTextBlock_glyphRange( &self, block: &NSTextBlock, glyph_range: NSRange, ) -> NSRect

Available on crate feature NSTextTable only.

pub unsafe fn layoutRectForTextBlock_atIndex_effectiveRange( &self, block: &NSTextBlock, glyph_index: NSUInteger, effective_glyph_range: NSRangePointer, ) -> NSRect

Available on crate feature NSTextTable only.

Safety

effective_glyph_range must be a valid pointer or null.

pub unsafe fn boundsRectForTextBlock_atIndex_effectiveRange( &self, block: &NSTextBlock, glyph_index: NSUInteger, effective_glyph_range: NSRangePointer, ) -> NSRect

Available on crate feature NSTextTable only.

Safety

effective_glyph_range must be a valid pointer or null.

pub unsafe fn temporaryAttributesAtCharacterIndex_effectiveRange( &self, char_index: NSUInteger, effective_char_range: NSRangePointer, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

********************** Temporary attribute support ***********************

Safety

effective_char_range must be a valid pointer or null.

pub unsafe fn setTemporaryAttributes_forCharacterRange( &self, attrs: &NSDictionary<NSAttributedStringKey, AnyObject>, char_range: NSRange, )

Safety

attrs generic should be of the correct type.

pub unsafe fn addTemporaryAttributes_forCharacterRange( &self, attrs: &NSDictionary<NSAttributedStringKey, AnyObject>, char_range: NSRange, )

Safety

attrs generic should be of the correct type.

pub fn removeTemporaryAttribute_forCharacterRange( &self, attr_name: &NSAttributedStringKey, char_range: NSRange, )

pub unsafe fn temporaryAttribute_atCharacterIndex_effectiveRange( &self, attr_name: &NSAttributedStringKey, location: NSUInteger, range: NSRangePointer, ) -> Option<Retained<AnyObject>>

Safety

range must be a valid pointer or null.

pub unsafe fn temporaryAttribute_atCharacterIndex_longestEffectiveRange_inRange( &self, attr_name: &NSAttributedStringKey, location: NSUInteger, range: NSRangePointer, range_limit: NSRange, ) -> Option<Retained<AnyObject>>

Safety

range must be a valid pointer or null.

pub unsafe fn temporaryAttributesAtCharacterIndex_longestEffectiveRange_inRange( &self, location: NSUInteger, range: NSRangePointer, range_limit: NSRange, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

Safety

range must be a valid pointer or null.

pub unsafe fn addTemporaryAttribute_value_forCharacterRange( &self, attr_name: &NSAttributedStringKey, value: &AnyObject, char_range: NSRange, )

Safety

value should be of the correct type.

pub fn defaultLineHeightForFont(&self, the_font: &NSFont) -> CGFloat

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

***************************** Font metrics *****************************

pub fn defaultBaselineOffsetForFont(&self, the_font: &NSFont) -> CGFloat

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

impl NSLayoutManager

Methods declared on superclass NSObject.

pub fn new() -> Retained<Self>

impl NSLayoutManager

NSTextViewSupport.

pub fn rulerMarkersForTextView_paragraphStyle_ruler( &self, view: &NSTextView, style: &NSParagraphStyle, ruler: &NSRulerView, ) -> Retained<NSArray<NSRulerMarker>>

Available on crate features NSParagraphStyle and NSResponder and NSRulerMarker and NSRulerView and NSText and NSTextView and NSView only.

*************************** Ruler support ****************************

pub fn rulerAccessoryViewForTextView_paragraphStyle_ruler_enabled( &self, view: &NSTextView, style: &NSParagraphStyle, ruler: &NSRulerView, is_enabled: bool, ) -> Option<Retained<NSView>>

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

pub fn layoutManagerOwnsFirstResponderInWindow(&self, window: &NSWindow) -> bool

Available on crate features NSResponder and NSWindow only.

********************** First responder support ***********************

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

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

Safety

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

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

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

Safety

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

impl NSLayoutManager

NSLayoutManagerDeprecated.

pub unsafe fn glyphAtIndex_isValidIndex( &self, glyph_index: NSUInteger, is_valid_index: *mut Bool, ) -> NSGlyph

Available on crate feature NSFont only.

Safety

is_valid_index must be a valid pointer or null.

pub fn glyphAtIndex(&self, glyph_index: NSUInteger) -> NSGlyph

Available on crate feature NSFont only.

pub unsafe fn rectArrayForCharacterRange_withinSelectedCharacterRange_inTextContainer_rectCount( &self, char_range: NSRange, sel_char_range: NSRange, container: &NSTextContainer, rect_count: NonNull<NSUInteger>, ) -> NSRectArray

Available on crate feature NSTextContainer only.

Safety

rect_count must be a valid pointer.

pub unsafe fn rectArrayForGlyphRange_withinSelectedGlyphRange_inTextContainer_rectCount( &self, glyph_range: NSRange, sel_glyph_range: NSRange, container: &NSTextContainer, rect_count: NonNull<NSUInteger>, ) -> NSRectArray

Available on crate feature NSTextContainer only.

Safety

rect_count must be a valid pointer.

pub fn usesScreenFonts(&self) -> bool

👎Deprecated

pub fn setUsesScreenFonts(&self, uses_screen_fonts: bool)

👎Deprecated

Setter for usesScreenFonts.

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

👎Deprecated

Available on crate feature NSFont only.

pub unsafe fn insertGlyphs_length_forStartingGlyphAtIndex_characterIndex( &self, glyphs: NonNull<NSGlyph>, length: NSUInteger, glyph_index: NSUInteger, char_index: NSUInteger, )

👎Deprecated: Use -setGlyphs:properties:characterIndexes:font:forGlyphRange instead

Available on crate feature NSFont only.

Safety

glyphs must be a valid pointer.

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

👎Deprecated: Use -setGlyphs:properties:characterIndexes:font:forGlyphRange instead

Available on crate feature NSFont only.

pub fn replaceGlyphAtIndex_withGlyph( &self, glyph_index: NSUInteger, new_glyph: NSGlyph, )

👎Deprecated: Use -setGlyphs:properties:characterIndexes:font:forGlyphRange instead

Available on crate feature NSFont only.

pub fn deleteGlyphsInRange(&self, glyph_range: NSRange)

👎Deprecated: Use -setGlyphs:properties:characterIndexes:font:forGlyphRange instead

pub fn setCharacterIndex_forGlyphAtIndex( &self, char_index: NSUInteger, glyph_index: NSUInteger, )

👎Deprecated: Use -setGlyphs:properties:characterIndexes:font:forGlyphRange instead

pub fn setIntAttribute_value_forGlyphAtIndex( &self, attribute_tag: NSInteger, val: NSInteger, glyph_index: NSUInteger, )

👎Deprecated: Use -setGlyphs:properties:characterIndexes:font:forGlyphRange instead

pub fn invalidateGlyphsOnLayoutInvalidationForGlyphRange( &self, glyph_range: NSRange, )

👎Deprecated: Use -setGlyphs:properties:characterIndexes:font:forGlyphRange instead

pub fn intAttribute_forGlyphAtIndex( &self, attribute_tag: NSInteger, glyph_index: NSUInteger, ) -> NSInteger

👎Deprecated: Use -getGlyphsInRange:glyphs:properties:characterIndexes:bidiLevels: instead

pub unsafe fn getGlyphsInRange_glyphs_characterIndexes_glyphInscriptions_elasticBits( &self, glyph_range: NSRange, glyph_buffer: *mut NSGlyph, char_index_buffer: *mut NSUInteger, inscribe_buffer: *mut NSGlyphInscription, elastic_buffer: *mut Bool, ) -> NSUInteger

👎Deprecated: Use -getGlyphsInRange:glyphs:properties:characterIndexes:bidiLevels: instead

Available on crate feature NSFont only.

Safety

• glyph_buffer must be a valid pointer or null.
• char_index_buffer must be a valid pointer or null.
• inscribe_buffer must be a valid pointer or null.
• elastic_buffer must be a valid pointer or null.

pub unsafe fn getGlyphsInRange_glyphs_characterIndexes_glyphInscriptions_elasticBits_bidiLevels( &self, glyph_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: Use -getGlyphsInRange:glyphs:properties:characterIndexes:bidiLevels: instead

Available on crate feature NSFont only.

Safety

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

pub unsafe fn getGlyphs_range( &self, glyph_array: *mut NSGlyph, glyph_range: NSRange, ) -> NSUInteger

👎Deprecated: Use -getGlyphsInRange:glyphs:properties:characterIndexes:bidiLevels: instead

Available on crate feature NSFont only.

Safety

glyph_array must be a valid pointer or null.

pub unsafe fn invalidateLayoutForCharacterRange_isSoft_actualCharacterRange( &self, char_range: NSRange, flag: bool, actual_char_range: NSRangePointer, )

👎Deprecated: Use -invalidateLayoutForCharacterRange:actualCharacterRange: instead

Safety

actual_char_range must be a valid pointer or null.

pub fn textStorage_edited_range_changeInLength_invalidatedRange( &self, str: &NSTextStorage, edited_mask: NSTextStorageEditedOptions, new_char_range: NSRange, delta: NSInteger, invalidated_char_range: NSRange, )

👎Deprecated: Use -processEditingForTextStorage:edited:range:changeInLength:invalidatedRange: instead

Available on crate feature NSTextStorage only.

pub unsafe fn setLocations_startingGlyphIndexes_count_forGlyphRange( &self, locations: NSPointArray, glyph_indexes: NonNull<NSUInteger>, count: NSUInteger, glyph_range: NSRange, )

👎Deprecated: Use -setLocation:forStartOfGlyphRange: instead

Safety

• locations must be a valid pointer.
• glyph_indexes must be a valid pointer.

pub unsafe fn showPackedGlyphs_length_glyphRange_atPoint_font_color_printingAdjustment( &self, glyphs: NonNull<c_char>, glyph_len: NSUInteger, glyph_range: NSRange, point: NSPoint, font: &NSFont, color: &NSColor, printing_adjustment: NSSize, )

👎Deprecated: Use -showCGGlyphs:positions:count:font:matrix:attributes:inContext: instead

Available on crate features NSColor and NSFont only.

Safety

glyphs must be a valid pointer.

pub fn hyphenationFactor(&self) -> c_float

👎Deprecated: Please use usesDefaultHyphenation or -[NSParagraphStyle hyphenationFactor] instead.

pub fn setHyphenationFactor(&self, hyphenation_factor: c_float)

👎Deprecated: Please use usesDefaultHyphenation or -[NSParagraphStyle hyphenationFactor] instead.

Setter for hyphenationFactor.

impl NSLayoutManager

NSGlyphGeneration.

pub fn glyphGenerator(&self) -> Retained<NSGlyphGenerator>

Available on crate feature NSGlyphGenerator only.

pub fn setGlyphGenerator(&self, glyph_generator: &NSGlyphGenerator)

Available on crate feature NSGlyphGenerator only.

Setter for glyphGenerator.

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 NSLayoutManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSLayoutManager> for NSLayoutManager

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSLayoutManager

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSLayoutManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSLayoutManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSLayoutManager

const NAME: &'static str = "NSLayoutManager"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl DefaultRetained for NSLayoutManager

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSLayoutManager

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSLayoutManager

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 NSLayoutManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSLayoutManager

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSGlyphStorage for NSLayoutManager

unsafe fn insertGlyphs_length_forStartingGlyphAtIndex_characterIndex( &self, glyphs: NonNull<NSGlyph>, length: NSUInteger, glyph_index: NSUInteger, char_index: NSUInteger, )

where Self: Sized + Message,

Available on crate features NSGlyphGenerator and NSFont only.

Safety

fn setIntAttribute_value_forGlyphAtIndex( &self, attribute_tag: NSInteger, val: NSInteger, glyph_index: NSUInteger, )

where Self: Sized + Message,

Available on crate feature NSGlyphGenerator only.

fn attributedString(&self) -> Retained<NSAttributedString>

where Self: Sized + Message,

Available on crate feature NSGlyphGenerator only.

fn layoutOptions(&self) -> NSUInteger

where Self: Sized + Message,

Available on crate feature NSGlyphGenerator only.

impl NSObjectProtocol for NSLayoutManager

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 NSLayoutManager

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSLayoutManager

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 NSLayoutManager

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

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

impl DowncastTarget for NSLayoutManager

impl Eq for NSLayoutManager