Struct NSSliderTouchBarItem

Source

pub struct NSSliderTouchBarItem { /* private fields */ }

Available on crate features NSSliderTouchBarItem and NSTouchBarItem only.

Expand description

Apple’s documentation

Implementations§

Source §

impl NSSliderTouchBarItem

Source

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

Available on crate features NSResponder and NSUserInterfaceCompression and NSView only.

Source

pub 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.

Source

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

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

Setter for slider.

Source

pub fn doubleValue(&self) -> c_double

The double value of the control

Source

pub fn setDoubleValue(&self, double_value: c_double)

Setter for doubleValue.

Source

pub 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

Source

pub fn setMinimumSliderWidth(&self, minimum_slider_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumSliderWidth.

Source

pub fn maximumSliderWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setMaximumSliderWidth(&self, maximum_slider_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for maximumSliderWidth.

Source

pub 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.

Source

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

Setter for label.

This is copied when set.

Source

pub 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

Source

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

Available on crate feature NSSliderAccessory only.

Setter for minimumValueAccessory.

Source

pub 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

Source

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

Available on crate feature NSSliderAccessory only.

Setter for maximumValueAccessory.

Source

pub 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.

Source

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

Available on crate feature objc2-core-foundation only.

Setter for valueAccessoryWidth.

Source

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

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

Source

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

Setter for target.

This is a weak property.

§Safety

target should be of the correct type.

Source

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

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

Source

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

Setter for action.

§Safety

action must be a valid selector.

Source

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

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

Source

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

Setter for customizationLabel.

This is copied when set.

Source §

impl NSSliderTouchBarItem

Methods declared on superclass NSTouchBarItem.

Source

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

Source

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

§Safety

coder possibly has further requirements.

Source

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

Source §

impl NSSliderTouchBarItem

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = NSTouchBarItem>§

Source

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

Source

pub fn visibilityPriority(&self) -> NSTouchBarItemPriority

Source

pub fn setVisibilityPriority(&self, visibility_priority: NSTouchBarItemPriority)

Setter for visibilityPriority.

Source

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

Available on crate features NSResponder and NSView only.

Source

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

Available on crate features NSResponder and NSViewController only.

Source

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

Source

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