Struct NSStepperTouchBarItem

Source

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

Available on crate features NSStepperTouchBarItem and NSTouchBarItem only.

Expand description

Apple’s documentation

Implementations§

Source §

impl NSStepperTouchBarItem

Source

pub unsafe fn stepperTouchBarItemWithIdentifier_formatter( identifier: &NSTouchBarItemIdentifier, formatter: &NSFormatter, mtm: MainThreadMarker, ) -> Retained<Self>

Creates an NSStepperTouchBarItem with a formatter to display the stepper’s value as text

Parameter formatter: A formatter used to display a textual representation of the stepper’s value

Source

pub unsafe fn stepperTouchBarItemWithIdentifier_drawingHandler( identifier: &NSTouchBarItemIdentifier, drawing_handler: &DynBlock<dyn Fn(NSRect, c_double)>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate feature block2 only.

Creates an NSStepperTouchBarItem using the result of drawingHandler to display the stepper’s value as an image

Parameter drawingHandler: A block that draws a graphical representation of the stepper’s value in the specified rectangle. The coordinates of this rectangle are specified in points.

Source

pub unsafe fn maxValue(&self) -> c_double

The stepper’s maximum value. The default is 59.0.

Source

pub unsafe fn setMaxValue(&self, max_value: c_double)

Setter for maxValue.

Source

pub unsafe fn minValue(&self) -> c_double

The stepper’s minimum value. The default is 0.0.

Source

pub unsafe fn setMinValue(&self, min_value: c_double)

Setter for minValue.

Source

pub unsafe fn increment(&self) -> c_double

The stepper’s increment value. The default is 1.0.

Source

pub unsafe fn setIncrement(&self, increment: c_double)

Setter for increment.

Source

pub unsafe fn value(&self) -> c_double

The current value of the stepper.

Source

pub unsafe fn setValue(&self, value: c_double)

Setter for value.

Source

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

The target object that receives action messages from the stepper.

Source

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

This is a weak property. Setter for target.

Source

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

The action-message selector associated with the stepper.

Source

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

Setter for action.

Source

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

The localized string labelling this item during user customization. The default value is empty string.

Source

pub unsafe fn setCustomizationLabel( &self, customization_label: Option<&NSString>, )

Setter for customizationLabel.

Source §

impl NSStepperTouchBarItem

Methods declared on superclass NSTouchBarItem.

Source

pub unsafe fn initWithIdentifier( this: Allocated<Self>, identifier: &NSTouchBarItemIdentifier, ) -> Retained<Self>

Source

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

Source

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

Source §

impl NSStepperTouchBarItem

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = NSTouchBarItem>§

Source

pub unsafe fn identifier(&self) -> Retained<NSTouchBarItemIdentifier>

Source

pub unsafe fn visibilityPriority(&self) -> NSTouchBarItemPriority

Source

pub unsafe fn setVisibilityPriority( &self, visibility_priority: NSTouchBarItemPriority, )

Setter for visibilityPriority.

Source

pub unsafe fn view(&self) -> Option<Retained<NSView>>

Available on crate features NSResponder and NSView only.

Source

pub unsafe fn viewController(&self) -> Option<Retained<NSViewController>>

Available on crate features NSResponder and NSViewController only.

Source

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

Source

pub unsafe fn isVisible(&self) -> bool

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`
    }
}