Contents

NSToolbarItemGroup

A group of subitems in a toolbar item.

Declaration

class NSToolbarItemGroup

Overview

An NSToolbarItemGroup represents a collection set of subitems in a toolbar that the system displays based on available space and settings that you specify. The system uses the views and labels of the subitems, but the parent’s attributes take precedence. This differs from other NSToolbarItem objects because they’re attached — the user drags them together as a single item rather than separately.

If a subitem of the group has an action set on it, the group uses that action instead of its own when the user clicks or taps on that item. The system prefers the subitem’s action if it exists, otherwise it uses the group’s action.

To configure an instance of NSToolbarItemGroup, you first create the individual toolbar subitems:

NSToolbarItem *item1 = [[NSToolbarItem alloc] initWithItemIdentifier:@"Item1"];
NSToolbarItem *item2 = [[NSToolbarItem alloc] initWithItemIdentifier:@"Item2"];
[item1 setImage:[NSImage imageNamed:@"LeftArrow"]];
[item2 setImage:[NSImage imageNamed:@"RightArrow"]];
[item1 setLabel:@"Prev"];
[item2 setLabel:@"Next"];

Then, you put them in a grouped item:

NSToolbarItemGroup *group = [[NSToolbarItemGroup alloc] initWithItemIdentifier:@"GroupItem"];
[group setSubitems:[NSArray arrayWithObjects:item1, item2, nil]];

In this configuration, you get two grouped items, and two labels.

If you set a label on the parent item, you get two grouped items with one shared label:

[group setLabel:@"Navigate"];

If instead you set a view on the parent item, you get two labels with one shared view:

[group setView:someSegmentedControl];

Topics

Creating grouped toolbar items

Working with subitems

Configuring grouped toolbar items

See Also

Items