Struct NSStatusItem

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

Available on crate feature NSStatusItem only.

Apple’s documentation

Implementations

impl NSStatusItem

pub unsafe fn statusBar(&self) -> Option<Retained<NSStatusBar>>

Available on crate feature NSStatusBar only.

pub unsafe fn length(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setLength(&self, length: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for length.

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

Available on crate feature NSMenu only.

pub unsafe fn setMenu(&self, menu: Option<&NSMenu>)

Available on crate feature NSMenu only.

Setter for menu.

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

Available on crate features NSButton and NSControl and NSResponder and NSStatusBarButton and NSView only.

pub unsafe fn behavior(&self) -> NSStatusItemBehavior

pub unsafe fn setBehavior(&self, behavior: NSStatusItemBehavior)

Setter for behavior.

pub unsafe fn isVisible(&self) -> bool

pub unsafe fn setVisible(&self, visible: bool)

Setter for isVisible.

pub unsafe fn autosaveName(&self) -> Retained<NSStatusItemAutosaveName>

pub unsafe fn setAutosaveName( &self, autosave_name: Option<&NSStatusItemAutosaveName>, )

Setter for autosaveName.

impl NSStatusItem

Methods declared on superclass NSObject.

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

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

impl NSStatusItem

NSStatusItemDeprecated.

pub unsafe fn action(&self) -> Option<Sel>

👎Deprecated: Use the receiver’s button.action instead

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

👎Deprecated: Use the receiver’s button.action instead

Setter for action.

pub unsafe fn doubleAction(&self) -> Option<Sel>

👎Deprecated: Use the receiver’s button.doubleAction instead

pub unsafe fn setDoubleAction(&self, double_action: Option<Sel>)

👎Deprecated: Use the receiver’s button.doubleAction instead

Setter for doubleAction.

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

👎Deprecated: Use the receiver’s button.target instead

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

👎Deprecated: Use the receiver’s button.target instead

This is a weak property. Setter for target.

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

👎Deprecated: Use the receiver’s button.title instead

pub unsafe fn setTitle(&self, title: Option<&NSString>)

👎Deprecated: Use the receiver’s button.title instead

Setter for title.

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

👎Deprecated: Use the receiver’s button.attributedTitle instead

pub unsafe fn setAttributedTitle( &self, attributed_title: Option<&NSAttributedString>, )

👎Deprecated: Use the receiver’s button.attributedTitle instead

Setter for attributedTitle.

pub unsafe fn image(&self) -> Option<Retained<NSImage>>

👎Deprecated: Use the receiver’s button.image instead

Available on crate feature NSImage only.

pub unsafe fn setImage(&self, image: Option<&NSImage>)

👎Deprecated: Use the receiver’s button.image instead

Available on crate feature NSImage only.

Setter for image.

pub unsafe fn alternateImage(&self) -> Option<Retained<NSImage>>

👎Deprecated: Use the receiver’s button.alternateImage instead

Available on crate feature NSImage only.

pub unsafe fn setAlternateImage(&self, alternate_image: Option<&NSImage>)

👎Deprecated: Use the receiver’s button.alternateImage instead

Available on crate feature NSImage only.

Setter for alternateImage.

pub unsafe fn isEnabled(&self) -> bool

👎Deprecated: Use the receiver’s button.enabled instead

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

👎Deprecated: Use the receiver’s button.enabled instead

Setter for isEnabled.

pub unsafe fn highlightMode(&self) -> bool

👎Deprecated: Use the receiver’s button.cell.highlightsBy instead

pub unsafe fn setHighlightMode(&self, highlight_mode: bool)

👎Deprecated: Use the receiver’s button.cell.highlightsBy instead

Setter for highlightMode.

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

👎Deprecated: Use the receiver’s button.toolTip instead

pub unsafe fn setToolTip(&self, tool_tip: Option<&NSString>)

👎Deprecated: Use the receiver’s button.toolTip instead

Setter for toolTip.

pub unsafe fn sendActionOn(&self, mask: NSEventMask) -> NSInteger

👎Deprecated: Use the receiver’s button’s -sendActionOn: instead

Available on crate feature NSEvent only.

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

👎Deprecated: Use the standard button property instead

Available on crate features NSResponder and NSView only.

pub unsafe fn setView(&self, view: Option<&NSView>)

👎Deprecated: Use the standard button property instead

Available on crate features NSResponder and NSView only.

Setter for view.

pub unsafe fn drawStatusBarBackgroundInRect_withHighlight( &self, rect: NSRect, highlight: bool, )

👎Deprecated: Use the standard button instead which handles highlight drawing, making this method obsolete

pub unsafe fn popUpStatusItemMenu(&self, menu: &NSMenu)

👎Deprecated: Use the menu property instead

Available on crate feature NSMenu 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.

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 NSStatusItem

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSStatusItem

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSStatusItem> for NSStatusItem

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSStatusItem

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSStatusItem

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSStatusItem

const NAME: &'static str = "NSStatusItem"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSStatusItem

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSStatusItem

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 NSStatusItem

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSStatusItem

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 NSStatusItem

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 NSStatusItem

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

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

impl DowncastTarget for NSStatusItem

impl Eq for NSStatusItem