Struct NSFont

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

Available on crate feature NSFont only.

Apple’s documentation

Implementations

impl NSFont

pub unsafe fn fontWithName_size( font_name: &NSString, font_size: CGFloat, ) -> Option<Retained<NSFont>>

Available on crate feature objc2-core-foundation only.

******* Factory ********

pub unsafe fn fontWithName_matrix( font_name: &NSString, font_matrix: NonNull<CGFloat>, ) -> Option<Retained<NSFont>>

Available on crate feature objc2-core-foundation only.

pub unsafe fn fontWithDescriptor_size( font_descriptor: &NSFontDescriptor, font_size: CGFloat, ) -> Option<Retained<NSFont>>

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

pub unsafe fn fontWithDescriptor_textTransform( font_descriptor: &NSFontDescriptor, text_transform: Option<&NSAffineTransform>, ) -> Option<Retained<NSFont>>

Available on crate feature NSFontDescriptor only.

pub unsafe fn userFontOfSize(font_size: CGFloat) -> Option<Retained<NSFont>>

Available on crate feature objc2-core-foundation only.

******* Meta Font ********

pub unsafe fn userFixedPitchFontOfSize( font_size: CGFloat, ) -> Option<Retained<NSFont>>

Available on crate feature objc2-core-foundation only.

pub unsafe fn setUserFont(font: Option<&NSFont>)

pub unsafe fn setUserFixedPitchFont(font: Option<&NSFont>)

pub unsafe fn systemFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn boldSystemFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn labelFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn titleBarFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn menuFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn menuBarFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn messageFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn paletteFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn toolTipsFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn controlContentFontOfSize(font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn systemFontOfSize_weight( font_size: CGFloat, weight: NSFontWeight, ) -> Retained<NSFont>

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

pub unsafe fn monospacedDigitSystemFontOfSize_weight( font_size: CGFloat, weight: NSFontWeight, ) -> Retained<NSFont>

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

pub unsafe fn systemFontOfSize_weight_width( font_size: CGFloat, weight: NSFontWeight, width: NSFontWidth, ) -> Retained<NSFont>

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

pub unsafe fn monospacedSystemFontOfSize_weight( font_size: CGFloat, weight: NSFontWeight, ) -> Retained<NSFont>

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

pub unsafe fn fontWithSize(&self, font_size: CGFloat) -> Retained<NSFont>

Available on crate feature objc2-core-foundation only.

pub unsafe fn systemFontSize() -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn smallSystemFontSize() -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn labelFontSize() -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn systemFontSizeForControlSize( control_size: NSControlSize, ) -> CGFloat

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

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

******* Core font attribute ********

pub unsafe fn pointSize(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn matrix(&self) -> NonNull<CGFloat>

Available on crate feature objc2-core-foundation only.

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

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

pub unsafe fn fontDescriptor(&self) -> Retained<NSFontDescriptor>

Available on crate feature NSFontDescriptor only.

pub unsafe fn textTransform(&self) -> Retained<NSAffineTransform>

pub unsafe fn numberOfGlyphs(&self) -> NSUInteger

******* Glyph coverage ********

pub unsafe fn mostCompatibleStringEncoding(&self) -> NSStringEncoding

pub unsafe fn coveredCharacterSet(&self) -> Retained<NSCharacterSet>

pub unsafe fn boundingRectForFont(&self) -> NSRect

pub unsafe fn maximumAdvancement(&self) -> NSSize

pub unsafe fn ascender(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn descender(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn leading(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn underlinePosition(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn underlineThickness(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn italicAngle(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn capHeight(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn xHeight(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn isFixedPitch(&self) -> bool

pub unsafe fn set(&self)

******* NSGraphicsContext-related ********

pub unsafe fn setInContext(&self, graphics_context: &NSGraphicsContext)

Available on crate feature NSGraphicsContext only.

pub unsafe fn verticalFont(&self) -> Retained<NSFont>

******* Vertical mode ********

pub unsafe fn isVertical(&self) -> bool

impl NSFont

Methods declared on superclass NSObject.

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

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

impl NSFont

NSFont_Deprecated.

pub unsafe fn glyphWithName(&self, name: &NSString) -> NSGlyph

pub unsafe fn boundingRectForGlyph(&self, glyph: NSGlyph) -> NSRect

pub unsafe fn advancementForGlyph(&self, glyph: NSGlyph) -> NSSize

pub unsafe fn getBoundingRects_forGlyphs_count( &self, bounds: NSRectArray, glyphs: NonNull<NSGlyph>, glyph_count: NSUInteger, )

pub unsafe fn getAdvancements_forGlyphs_count( &self, advancements: NSSizeArray, glyphs: NonNull<NSGlyph>, glyph_count: NSUInteger, )

pub unsafe fn getAdvancements_forPackedGlyphs_length( &self, advancements: NSSizeArray, packed_glyphs: NonNull<c_void>, length: NSUInteger, )

pub unsafe fn printerFont(&self) -> Retained<NSFont>

******* Rendering mode ********

pub unsafe fn screenFont(&self) -> Retained<NSFont>

pub unsafe fn screenFontWithRenderingMode( &self, rendering_mode: NSFontRenderingMode, ) -> Retained<NSFont>

pub unsafe fn renderingMode(&self) -> NSFontRenderingMode

impl NSFont

NSFont_TextStyles.

pub unsafe fn preferredFontForTextStyle_options( style: &NSFontTextStyle, options: &NSDictionary<NSFontTextStyleOptionKey, AnyObject>, ) -> Retained<NSFont>

Available on crate feature NSFontDescriptor 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 NSAccessibilityConstants only.

Dynamically find the class of this object.

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 NSFont

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSFont> for NSFont

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSFont

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSFont

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSFont

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSFont

const NAME: &'static str = "NSFont"

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

type Super = NSObject

The superclass of this class.

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

type Result = NSFont

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

impl Debug for NSFont

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

Formats the value using the given formatter.

impl Deref for NSFont

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSFont

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 NSFont

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSFont

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for NSFont

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 NSObjectProtocol for NSFont

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 NSFont

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSFont

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 NSFont

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

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

impl DowncastTarget for NSFont

impl Eq for NSFont