Struct NSToolbarItem

Source

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

Available on crate feature NSToolbarItem only.

Expand description

Apple’s documentation

Implementations§

Source §

impl NSToolbarItem

Source

pub unsafe fn initWithItemIdentifier( this: Allocated<Self>, item_identifier: &NSToolbarItemIdentifier, ) -> Retained<Self>

Available on crate feature NSToolbar only.

Initialize the toolbar item with an identifier which is a development language string used by the toolbar and its delegate for identification purposes.

Source

pub unsafe fn itemIdentifier(&self) -> Retained<NSToolbarItemIdentifier>

Available on crate feature NSToolbar only.

Use this to determine the toolbar in which an item is currently displayed.

Source

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

Use this to set the item’s label that appears in the toolbar. The label may also be used for the default menuFormRepresentation of the item. Also, developers should make sure the length of the label is appropriate and not too long.

Source

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

Setter for label.

Source

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

Use this to set the item’s label that appears when the item is in the customization palette. All Items must have a palette label, and for most things it is reasonable to set them to the same string as the label used in the toolbar.

Source

pub unsafe fn setPaletteLabel(&self, palette_label: &NSString)

Setter for paletteLabel.

Source

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

An array of all alternate labels this item may display. The item will use the size of the longest label to prevent resizing when the label is changed.

Source

pub unsafe fn setPossibleLabels(&self, possible_labels: &NSSet<NSString>)

Setter for possibleLabels.

Source

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

Use this to set a tooltip to be used when the item is displayed in the toolbar. (forwards to -view if it responds)

Source

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

Setter for toolTip.

Source

pub unsafe fn menuFormRepresentation(&self) -> Option<Retained<NSMenuItem>>

Available on crate feature NSMenuItem only.

The menu form of a toolbar item’s purpose is twofold. First, when the window is too small to display an item, it will be clipped but remain accessible from a “clipped items” menu containing the menu item returned here. Second, in text only mode, the menu returned will be used to create the displayed items. Singleton menu items will be clickable, while submenu items will be represented as a pull down. For instance, say you want a button that allows you to switch between modes A, B, and C. You could represent this as a menu by: a menu item “mode” with three submenu items “A”, “B”, and “C”. By default, this method returns a singleton menu item with item label as the title. For standard items, the target, action is set.

Source

pub unsafe fn setMenuFormRepresentation( &self, menu_form_representation: Option<&NSMenuItem>, )

Available on crate feature NSMenuItem only.

Setter for menuFormRepresentation.

Source

pub unsafe fn tag(&self) -> NSInteger

Tag for your own custom purpose. (forwards to -view if it responds)

Source

pub unsafe fn setTag(&self, tag: NSInteger)

Setter for tag.

Source

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

Set and get the action of an item. (forwards to -view if it responds)

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>

Set and get the action of an item. For custom views, this method will call -setAction: on the view if it responds. (forwards to -view if it responds)

Source

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

Setter for action.

Source

pub unsafe fn isEnabled(&self) -> bool

Set and get the enabled flag of an item. For custom views, this method will call -setEnabled: on the view if it responds. (forwards to -view if it responds)

Source

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

Setter for isEnabled.

Source

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

Available on crate feature NSImage only.

Source

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

Available on crate feature NSImage only.

Setter for image.

Source

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

Set and get the title of an item. For custom views, this method will call -setTitle: on the view if it responds. (forwards to -view if it responds)

Source

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

Setter for title.

Source

pub unsafe fn isBordered(&self) -> bool

When set on an item without a custom view, the button produced will have a bordered style. Defaults to NO.

Source

pub unsafe fn setBordered(&self, bordered: bool)

Setter for isBordered.

Source

pub unsafe fn isNavigational(&self) -> bool

Whether or not the item behaves as a navigation item (i.e. back/forward) in the toolbar. Navigation items may be specially positioned by the system outside the normal list of items of the toolbar in the order specified by -toolbarDefaultItemIdentifiers:. Defaults to NO.

Source

pub unsafe fn setNavigational(&self, navigational: bool)

Setter for isNavigational.

Source

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

Available on crate features NSResponder and NSView only.

Items with automatically generated views will return nil from this getter. Custom views may be provided but not all NSToolbarItem subclasses support custom views. Note that, by default, many of the set/get methods will be implemented by calls forwarded to the view you set, if it responds to it.

Source

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

Available on crate features NSResponder and NSView only.

Setter for view.

Source

pub unsafe fn isVisible(&self) -> bool

An item is visible if it is present in the NSToolbar and not in the overflow menu. This property is key value observable.

Source

pub unsafe fn isHidden(&self) -> bool

When an item is hidden it will not be visible in the toolbar. The item will still be visible in the customization panel. Because hidden items may be visible during user customization, use the visible property to determine if an item is currently displayed. Note that even hidden toolbar items are sync’d to other toolbars with a shared identifier, but its hidden state can be unique to each instance. Use this property to show a toolbar item in one toolbar instance but not another.

Source

pub unsafe fn setHidden(&self, hidden: bool)

Setter for isHidden.

Source

pub unsafe fn minSize(&self) -> NSSize

👎Deprecated: This property is no longer recommended. Instead, let the system automatically measure the size of the view using constraints.

Unless you have already set your own custom view, you should not call these methods. The min size should be small enough to look nice in all display modes. If you do not set a min/max size, the view’s size properties will be calculated using constraints. Apps linked before 10.14 will use the view’s current size. In general, apps should rely on the automatic measurements and constraints to define min/max sizes rather than setting these properties since this will account for localizations.

Source

pub unsafe fn setMinSize(&self, min_size: NSSize)

👎Deprecated: This property is no longer recommended. Instead, let the system automatically measure the size of the view using constraints.

Setter for minSize.

Source

pub unsafe fn maxSize(&self) -> NSSize

👎Deprecated: This property is no longer recommended. Instead, let the system automatically measure the size of the view using constraints.

Source

pub unsafe fn setMaxSize(&self, max_size: NSSize)

👎Deprecated: This property is no longer recommended. Instead, let the system automatically measure the size of the view using constraints.

Setter for maxSize.

Source

pub unsafe fn visibilityPriority(&self) -> NSToolbarItemVisibilityPriority

When a toolbar does not have enough space to fit all its items, it must push some into the overflow menu. Items with the highest visibilityPriority level are chosen last for the overflow menu. The default visibilityPriority value is NSToolbarItemVisibilityPriorityStandard. To suggest that an item always remain visible, give it a value greater than NSToolbarItemVisibilityPriorityStandard, but less than NSToolbarItemVisibilityPriorityUser. In 10.7, users can no longer modify the toolbar item visibility priority.

Source

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

Setter for visibilityPriority.

Source

pub unsafe fn validate(&self)

Typically you should not invoke this method. This method is called by its toolbar during validation. Standard items validate themselves by sending the -validateToolbarItem: validate message to the current validator. Since items with custom views don’t always have meaningful target/actions, they do nothing. So for your custom items it may be useful to override this method and invent your own validation.

Source

pub unsafe fn autovalidates(&self) -> bool

This property only affects automatic validation performed by NSToolbar. Explicit validation requests, such as the -[NSToolbar validateVisibleItems] method, will invoke the -validate method even if autovalidates is NO. Defaults to YES.

Source

pub unsafe fn setAutovalidates(&self, autovalidates: bool)

Setter for autovalidates.

Source

pub unsafe fn allowsDuplicatesInToolbar(&self) -> bool

👎Deprecated: Duplicates are no longer supported.

Duplicate items outside of spaces are not allowed.

Source §

impl NSToolbarItem

Methods declared on superclass NSObject.

Source

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

Source

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

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

Trait Implementations§

Source §