Struct NSToolbarItemGroup 

pub struct NSToolbarItemGroup { /* private fields */ }

Available on crate features NSToolbarItem and NSToolbarItemGroup only.

Apple’s documentation

Implementations

impl NSToolbarItemGroup

pub unsafe fn groupWithItemIdentifier_titles_selectionMode_labels_target_action( item_identifier: &NSToolbarItemIdentifier, titles: &NSArray<NSString>, selection_mode: NSToolbarItemGroupSelectionMode, labels: Option<&NSArray<NSString>>, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate feature NSToolbar only.

Convenience constructors for creating segmented control based toolbar items with images or text. The item returned will have a custom view for representing the control and automatically create subitems for the group. The labels array, if not nil, will be used to provide individual labels under the item for each segment of the control. When space in the toolbar is tight, the control may switch to a smaller alternate representation as necessary to remain in the toolbar.

Safety

• target should be of the correct type.
• action must be a valid selector.

pub unsafe fn groupWithItemIdentifier_images_selectionMode_labels_target_action( item_identifier: &NSToolbarItemIdentifier, images: &NSArray<NSImage>, selection_mode: NSToolbarItemGroupSelectionMode, labels: Option<&NSArray<NSString>>, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate features NSImage and NSToolbar only.

Safety

• target should be of the correct type.
• action must be a valid selector.

pub fn subitems(&self) -> Retained<NSArray<NSToolbarItem>>

Set or get the array of subitems for the toolbar item. By default, a NSToolbarItemGroup has an empty array of subitems. You should call this to set the subitems before returning the item to the toolbar. NSToolbarItemGroups may not contain other NSToolbarItemGroups as subitems.

pub fn setSubitems(&self, subitems: &NSArray<NSToolbarItem>)

Setter for subitems.

This is copied when set.

pub fn controlRepresentation(&self) -> NSToolbarItemGroupControlRepresentation

The style in which this item will be represented to the user. Defaults to NSToolbarItemGroupControlRepresentationAutomatic.

pub fn setControlRepresentation( &self, control_representation: NSToolbarItemGroupControlRepresentation, )

Setter for controlRepresentation.

pub fn selectionMode(&self) -> NSToolbarItemGroupSelectionMode

Get and set how selection is handled by the control. Only applies when using one of the constructors to create the item with a system defined control representation.

pub fn setSelectionMode(&self, selection_mode: NSToolbarItemGroupSelectionMode)

Setter for selectionMode.

pub fn selectedIndex(&self) -> NSInteger

The most recently selected item of the group, or -1 if nothing is selected.

pub fn setSelectedIndex(&self, selected_index: NSInteger)

Setter for selectedIndex.

pub fn setSelected_atIndex(&self, selected: bool, index: NSInteger)

Get and set selection of individual subitems of the group item.

pub fn isSelectedAtIndex(&self, index: NSInteger) -> bool

impl NSToolbarItemGroup

Methods declared on superclass NSToolbarItem.

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

impl NSToolbarItemGroup

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NSToolbarItem>

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

Available on crate feature NSToolbar only.

pub fn toolbar(&self) -> Option<Retained<NSToolbar>>

Available on crate feature NSToolbar only.

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

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

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

Setter for label.

This is copied when set.

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

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

Setter for paletteLabel.

This is copied when set.

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

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

Setter for possibleLabels.

This is copied when set.

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

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

Setter for toolTip.

This is copied when set.

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

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

Available on crate feature NSMenuItem only.

Setter for menuFormRepresentation.

pub fn tag(&self) -> NSInteger

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

pub fn setTag(&self, tag: NSInteger)

Setter for tag.

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

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

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

Setter for target.

This is a weak property.

Safety

target should be of the correct type.

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

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

Setter for action.

Safety

action must be a valid selector.

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

pub fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

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

Available on crate feature NSImage only.

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

Available on crate feature NSImage only.

Setter for image.

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

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

Setter for title.

This is copied when set.

pub fn isBordered(&self) -> bool

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

pub fn setBordered(&self, bordered: bool)

Setter for isBordered.

pub fn backgroundTintColor(&self) -> Option<Retained<NSColor>>

Available on crate feature NSColor only.

pub fn setBackgroundTintColor(&self, background_tint_color: Option<&NSColor>)

Available on crate feature NSColor only.

Setter for backgroundTintColor.

This is copied when set.

pub fn style(&self) -> NSToolbarItemStyle

Defines the toolbar item’s appearance. The default style is plain. Prominent style tints the background. If a background tint color is set, it uses it; otherwise, it uses the app’s or system’s accent color. If grouped with other items, it moves to its own to avoid tinting other items’ background.

pub fn setStyle(&self, style: NSToolbarItemStyle)

Setter for style.

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

pub fn setNavigational(&self, navigational: bool)

Setter for isNavigational.

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

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

Available on crate features NSResponder and NSView only.

Setter for view.

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

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

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

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

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

pub fn maxSize(&self) -> NSSize

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

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

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

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

Setter for visibilityPriority.

pub fn badge(&self) -> Option<Retained<NSItemBadge>>

Available on crate feature NSItemBadge only.

A badge that can be attached to an NSToolbarItem. This provides a way to display small visual indicators that can be used to highlight important information, such as unread notifications or status indicators.

pub fn setBadge(&self, badge: Option<&NSItemBadge>)

Available on crate feature NSItemBadge only.

Setter for badge.

This is copied when set.

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

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

pub fn setAutovalidates(&self, autovalidates: bool)

Setter for autovalidates.

pub fn allowsDuplicatesInToolbar(&self) -> bool

👎Deprecated: Duplicates are no longer supported.

Duplicate items outside of spaces are not allowed.

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 NSToolbarItemGroup

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSToolbarItemGroup

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSToolbarItem> for NSToolbarItemGroup

fn as_ref(&self) -> &NSToolbarItem

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

impl AsRef<NSToolbarItemGroup> for NSToolbarItemGroup

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSToolbarItemGroup

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSToolbarItemGroup

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSToolbarItem> for NSToolbarItemGroup

fn borrow(&self) -> &NSToolbarItem

Immutably borrows from an owned value.

impl ClassType for NSToolbarItemGroup

const NAME: &'static str = "NSToolbarItemGroup"

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

type Super = NSToolbarItem

The superclass of this class.

type ThreadKind = <<NSToolbarItemGroup 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 CopyingHelper for NSToolbarItemGroup

type Result = NSToolbarItemGroup

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NSToolbarItemGroup

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

Formats the value using the given formatter.

impl Deref for NSToolbarItemGroup

type Target = NSToolbarItem

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSToolbarItemGroup

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 NSToolbarItemGroup

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for NSToolbarItemGroup

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSToolbarItemGroup

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 NSToolbarItemGroup

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 NSToolbarItemGroup

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

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

impl DowncastTarget for NSToolbarItemGroup

impl Eq for NSToolbarItemGroup