Struct NSSliderTouchBarItem

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

Available on crate features NSSliderTouchBarItem and NSTouchBarItem only.

Apple’s documentation

Implementations

impl NSSliderTouchBarItem

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

Available on crate features NSResponder and NSUserInterfaceCompression and NSView only.

pub unsafe fn slider(&self) -> Retained<NSSlider>

Available on crate features NSControl and NSResponder and NSSlider and NSView only.

The slider displayed by the bar item. It is automatically created, but can be set to a custom subclass. doubleValue, minValue, maxValue, etc can all be read and set through the slider.

pub unsafe fn setSlider(&self, slider: &NSSlider)

Available on crate features NSControl and NSResponder and NSSlider and NSView only.

Setter for slider.

pub unsafe fn doubleValue(&self) -> c_double

The double value of the control

pub unsafe fn setDoubleValue(&self, double_value: c_double)

Setter for doubleValue.

pub unsafe fn minimumSliderWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The width boundaries of the slider track of this item. The system defines the default minimum. The maximum defaults to MAXFLOAT

pub unsafe fn setMinimumSliderWidth(&self, minimum_slider_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumSliderWidth.

pub unsafe fn maximumSliderWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setMaximumSliderWidth(&self, maximum_slider_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for maximumSliderWidth.

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

The text label displayed along with the slider. If set to nil, the label will not have space reserved in the item.

pub unsafe fn setLabel(&self, label: Option<&NSString>)

Setter for label.

pub unsafe fn minimumValueAccessory( &self, ) -> Option<Retained<NSSliderAccessory>>

Available on crate feature NSSliderAccessory only.

The accessory that appears on the end of the slider with the minimum value

pub unsafe fn setMinimumValueAccessory( &self, minimum_value_accessory: Option<&NSSliderAccessory>, )

Available on crate feature NSSliderAccessory only.

Setter for minimumValueAccessory.

pub unsafe fn maximumValueAccessory( &self, ) -> Option<Retained<NSSliderAccessory>>

Available on crate feature NSSliderAccessory only.

The accessory that appears on the end of the slider with the maximum value

pub unsafe fn setMaximumValueAccessory( &self, maximum_value_accessory: Option<&NSSliderAccessory>, )

Available on crate feature NSSliderAccessory only.

Setter for maximumValueAccessory.

pub unsafe fn valueAccessoryWidth(&self) -> NSSliderAccessoryWidth

Available on crate feature objc2-core-foundation only.

The width of the value accessories. Defaults to .default, but can be set to .wide or a custom value.

pub unsafe fn setValueAccessoryWidth( &self, value_accessory_width: NSSliderAccessoryWidth, )

Available on crate feature objc2-core-foundation only.

Setter for valueAccessoryWidth.

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

The target of the item, notified when the slider or accessories receive user interaction.

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

This is a weak property. Setter for target.

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

The action of the item, called when the slider or accessories receive user interaction.

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

Setter for action.

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

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

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

Setter for customizationLabel.

impl NSSliderTouchBarItem

Methods declared on superclass NSTouchBarItem.

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

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

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

impl NSSliderTouchBarItem

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSTouchBarItem>

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

pub unsafe fn visibilityPriority(&self) -> NSTouchBarItemPriority

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

Setter for visibilityPriority.

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

Available on crate features NSResponder and NSView only.

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

Available on crate features NSResponder and NSViewController only.

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

pub unsafe fn isVisible(&self) -> bool

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 NSSliderTouchBarItem

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSSliderTouchBarItem

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSSliderTouchBarItem> for NSSliderTouchBarItem

fn as_ref(&self) -> &Self

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

impl AsRef<NSTouchBarItem> for NSSliderTouchBarItem

fn as_ref(&self) -> &NSTouchBarItem

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

impl Borrow<AnyObject> for NSSliderTouchBarItem

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSSliderTouchBarItem

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSTouchBarItem> for NSSliderTouchBarItem

fn borrow(&self) -> &NSTouchBarItem

Immutably borrows from an owned value.

impl ClassType for NSSliderTouchBarItem

const NAME: &'static str = "NSSliderTouchBarItem"

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

type Super = NSTouchBarItem

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSSliderTouchBarItem

type Target = NSTouchBarItem

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSSliderTouchBarItem

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 NSSliderTouchBarItem

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSSliderTouchBarItem

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for NSSliderTouchBarItem

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 NSSliderTouchBarItem

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 NSSliderTouchBarItem

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

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

impl DowncastTarget for NSSliderTouchBarItem

impl Eq for NSSliderTouchBarItem