Struct NSFontManager

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

Available on crate feature NSFontManager only.

Apple’s documentation

Implementations

impl NSFontManager

pub unsafe fn setFontPanelFactory( factory_id: Option<&AnyClass>, mtm: MainThreadMarker, )

pub unsafe fn setFontManagerFactory( factory_id: Option<&AnyClass>, mtm: MainThreadMarker, )

pub unsafe fn sharedFontManager( mtm: MainThreadMarker, ) -> Retained<NSFontManager>

pub unsafe fn isMultiple(&self) -> bool

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

Available on crate feature NSFont only.

pub unsafe fn setSelectedFont_isMultiple(&self, font_obj: &NSFont, flag: bool)

Available on crate feature NSFont only.

pub unsafe fn setFontMenu(&self, new_menu: &NSMenu)

Available on crate feature NSMenu only.

pub unsafe fn fontMenu(&self, create: bool) -> Option<Retained<NSMenu>>

Available on crate feature NSMenu only.

pub unsafe fn fontPanel(&self, create: bool) -> Option<Retained<NSFontPanel>>

Available on crate features NSFontPanel and NSPanel and NSResponder and NSWindow only.

pub unsafe fn fontWithFamily_traits_weight_size( &self, family: &NSString, traits: NSFontTraitMask, weight: NSInteger, size: CGFloat, ) -> Option<Retained<NSFont>>

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

pub unsafe fn traitsOfFont(&self, font_obj: &NSFont) -> NSFontTraitMask

Available on crate feature NSFont only.

pub unsafe fn weightOfFont(&self, font_obj: &NSFont) -> NSInteger

Available on crate feature NSFont only.

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

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

pub unsafe fn availableMembersOfFontFamily( &self, fam: &NSString, ) -> Option<Retained<NSArray<NSArray>>>

pub unsafe fn convertFont(&self, font_obj: &NSFont) -> Retained<NSFont>

Available on crate feature NSFont only.

pub unsafe fn convertFont_toSize( &self, font_obj: &NSFont, size: CGFloat, ) -> Retained<NSFont>

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

pub unsafe fn convertFont_toFace( &self, font_obj: &NSFont, typeface: &NSString, ) -> Option<Retained<NSFont>>

Available on crate feature NSFont only.

pub unsafe fn convertFont_toFamily( &self, font_obj: &NSFont, family: &NSString, ) -> Retained<NSFont>

Available on crate feature NSFont only.

pub unsafe fn convertFont_toHaveTrait( &self, font_obj: &NSFont, trait: NSFontTraitMask, ) -> Retained<NSFont>

Available on crate feature NSFont only.

pub unsafe fn convertFont_toNotHaveTrait( &self, font_obj: &NSFont, trait: NSFontTraitMask, ) -> Retained<NSFont>

Available on crate feature NSFont only.

pub unsafe fn convertWeight_ofFont( &self, up_flag: bool, font_obj: &NSFont, ) -> Retained<NSFont>

Available on crate feature NSFont only.

pub unsafe fn isEnabled(&self) -> bool

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub unsafe fn action(&self) -> Sel

pub unsafe fn setAction(&self, action: Sel)

Setter for action.

pub unsafe fn delegate(&self) -> Option<Retained<AnyObject>>

👎Deprecated: NSFontManager doesn’t have any delegate method. This property should not be used.

pub unsafe fn setDelegate(&self, delegate: Option<&AnyObject>)

👎Deprecated: NSFontManager doesn’t have any delegate method. This property should not be used.

Setter for delegate.

pub unsafe fn sendAction(&self) -> bool

pub unsafe fn localizedNameForFamily_face( &self, family: &NSString, face_key: Option<&NSString>, ) -> Retained<NSString>

pub unsafe fn setSelectedAttributes_isMultiple( &self, attributes: &NSDictionary<NSString, AnyObject>, flag: bool, )

pub unsafe fn convertAttributes( &self, attributes: &NSDictionary<NSString, AnyObject>, ) -> Retained<NSDictionary<NSString, AnyObject>>

pub unsafe fn availableFontNamesMatchingFontDescriptor( &self, descriptor: &NSFontDescriptor, ) -> Option<Retained<NSArray>>

👎Deprecated: Use -[NSFontDescriptor matchingFontDescriptorsWithMandatoryKeys:] instead

Available on crate feature NSFontDescriptor only.

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

👎Deprecated: Use +[NSFontCollection allFontCollectionNames] instead

pub unsafe fn fontDescriptorsInCollection( &self, collection_names: &NSString, ) -> Option<Retained<NSArray>>

👎Deprecated: Use -[NSFontCollection matchingDescriptors] instead

pub unsafe fn addCollection_options( &self, collection_name: &NSString, collection_options: NSFontCollectionOptions, ) -> bool

👎Deprecated: Use +[NSFontCollection showFontCollection:withName:visibility:name:] instead

pub unsafe fn removeCollection(&self, collection_name: &NSString) -> bool

👎Deprecated: Use +[NSFontCollection hideFontCollectionWithName:visibility:error:] instead

pub unsafe fn addFontDescriptors_toCollection( &self, descriptors: &NSArray, collection_name: &NSString, )

👎Deprecated: Use -[NSMutableFontCollection addQueryForDescriptors:] instead

pub unsafe fn removeFontDescriptor_fromCollection( &self, descriptor: &NSFontDescriptor, collection: &NSString, )

👎Deprecated: Use -[NSMutableFontCollection removeQueryForDescriptors:] instead

Available on crate feature NSFontDescriptor only.

pub unsafe fn currentFontAction(&self) -> NSFontAction

pub unsafe fn convertFontTraits( &self, traits: NSFontTraitMask, ) -> NSFontTraitMask

pub unsafe fn target(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setTarget(&self, target: Option<&AnyObject>)

This is a weak property. Setter for target.

impl NSFontManager

Methods declared on superclass NSObject.

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

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

impl NSFontManager

NSFontManagerMenuActionMethods.

pub unsafe fn fontNamed_hasTraits( &self, f_name: &NSString, some_traits: NSFontTraitMask, ) -> bool

pub unsafe fn availableFontNamesWithTraits( &self, some_traits: NSFontTraitMask, ) -> Option<Retained<NSArray<NSString>>>

pub unsafe fn addFontTrait(&self, sender: Option<&AnyObject>)

pub unsafe fn removeFontTrait(&self, sender: Option<&AnyObject>)

pub unsafe fn modifyFontViaPanel(&self, sender: Option<&AnyObject>)

pub unsafe fn modifyFont(&self, sender: Option<&AnyObject>)

pub unsafe fn orderFrontFontPanel(&self, sender: Option<&AnyObject>)

pub unsafe fn orderFrontStylesPanel(&self, sender: Option<&AnyObject>)

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 NSFontManager

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSFontManager> for NSFontManager

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSFontManager

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSFontManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSFontManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSFontManager

const NAME: &'static str = "NSFontManager"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 NSFontManager

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

Formats the value using the given formatter.

impl Deref for NSFontManager

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSFontManager

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 NSFontManager

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSMenuItemValidation for NSFontManager

unsafe fn validateMenuItem(&self, menu_item: &NSMenuItem) -> bool

where Self: Sized + Message,

Available on crate features NSMenu and NSMenuItem only.

impl NSObjectProtocol for NSFontManager

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 NSFontManager

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 NSFontManager

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

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

impl DowncastTarget for NSFontManager

impl Eq for NSFontManager