#[repr(C)]pub struct NSToolbarItemGroup { /* private fields */ }
NSToolbarItem
and NSToolbarItemGroup
only.Expand description
Implementations§
Source§impl NSToolbarItemGroup
impl NSToolbarItemGroup
Sourcepub 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.
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>
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.
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>
NSImage
and NSToolbar
only.Sourcepub unsafe fn subitems(&self) -> Retained<NSArray<NSToolbarItem>>
pub unsafe 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.
Sourcepub unsafe fn setSubitems(&self, subitems: &NSArray<NSToolbarItem>)
pub unsafe fn setSubitems(&self, subitems: &NSArray<NSToolbarItem>)
Setter for subitems
.
Sourcepub unsafe fn controlRepresentation(
&self,
) -> NSToolbarItemGroupControlRepresentation
pub unsafe fn controlRepresentation( &self, ) -> NSToolbarItemGroupControlRepresentation
The style in which this item will be represented to the user.
Defaults to NSToolbarItemGroupControlRepresentationAutomatic
.
Sourcepub unsafe fn setControlRepresentation(
&self,
control_representation: NSToolbarItemGroupControlRepresentation,
)
pub unsafe fn setControlRepresentation( &self, control_representation: NSToolbarItemGroupControlRepresentation, )
Setter for controlRepresentation
.
Sourcepub unsafe fn selectionMode(&self) -> NSToolbarItemGroupSelectionMode
pub unsafe 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.
Sourcepub unsafe fn setSelectionMode(
&self,
selection_mode: NSToolbarItemGroupSelectionMode,
)
pub unsafe fn setSelectionMode( &self, selection_mode: NSToolbarItemGroupSelectionMode, )
Setter for selectionMode
.
Sourcepub unsafe fn selectedIndex(&self) -> NSInteger
pub unsafe fn selectedIndex(&self) -> NSInteger
The most recently selected item of the group, or -1 if nothing is selected.
Sourcepub unsafe fn setSelectedIndex(&self, selected_index: NSInteger)
pub unsafe fn setSelectedIndex(&self, selected_index: NSInteger)
Setter for selectedIndex
.
Sourcepub unsafe fn setSelected_atIndex(&self, selected: bool, index: NSInteger)
pub unsafe fn setSelected_atIndex(&self, selected: bool, index: NSInteger)
Get and set selection of individual subitems of the group item.
pub unsafe fn isSelectedAtIndex(&self, index: NSInteger) -> bool
Source§impl NSToolbarItemGroup
Methods declared on superclass NSToolbarItem
.
impl NSToolbarItemGroup
Methods declared on superclass NSToolbarItem
.
Sourcepub unsafe fn initWithItemIdentifier(
this: Allocated<Self>,
item_identifier: &NSToolbarItemIdentifier,
) -> Retained<Self>
Available on crate feature NSToolbar
only.
pub unsafe fn initWithItemIdentifier( this: Allocated<Self>, item_identifier: &NSToolbarItemIdentifier, ) -> Retained<Self>
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.
Methods from Deref<Target = NSToolbarItem>§
pub unsafe fn itemIdentifier(&self) -> Retained<NSToolbarItemIdentifier>
NSToolbar
only.Sourcepub unsafe fn toolbar(&self) -> Option<Retained<NSToolbar>>
Available on crate feature NSToolbar
only.
pub unsafe fn toolbar(&self) -> Option<Retained<NSToolbar>>
NSToolbar
only.Use this to determine the toolbar in which an item is currently displayed.
Sourcepub unsafe fn label(&self) -> Retained<NSString>
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.
Sourcepub unsafe fn paletteLabel(&self) -> Retained<NSString>
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.
Sourcepub unsafe fn setPaletteLabel(&self, palette_label: &NSString)
pub unsafe fn setPaletteLabel(&self, palette_label: &NSString)
Setter for paletteLabel
.
Sourcepub unsafe fn possibleLabels(&self) -> Retained<NSSet<NSString>>
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.
Sourcepub unsafe fn setPossibleLabels(&self, possible_labels: &NSSet<NSString>)
pub unsafe fn setPossibleLabels(&self, possible_labels: &NSSet<NSString>)
Setter for possibleLabels
.
Sourcepub unsafe fn toolTip(&self) -> Option<Retained<NSString>>
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)
Sourcepub unsafe fn setToolTip(&self, tool_tip: Option<&NSString>)
pub unsafe fn setToolTip(&self, tool_tip: Option<&NSString>)
Setter for toolTip
.
Available on crate feature NSMenuItem
only.
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.
Sourcepub unsafe fn setMenuFormRepresentation(
&self,
menu_form_representation: Option<&NSMenuItem>,
)
Available on crate feature NSMenuItem
only.
pub unsafe fn setMenuFormRepresentation( &self, menu_form_representation: Option<&NSMenuItem>, )
NSMenuItem
only.Setter for menuFormRepresentation
.
Sourcepub unsafe fn tag(&self) -> NSInteger
pub unsafe fn tag(&self) -> NSInteger
Tag for your own custom purpose. (forwards to -view
if it responds)
Sourcepub unsafe fn target(&self) -> Option<Retained<AnyObject>>
pub unsafe fn target(&self) -> Option<Retained<AnyObject>>
Set and get the action of an item. (forwards to -view
if it responds)
Sourcepub unsafe fn setTarget(&self, target: Option<&AnyObject>)
pub unsafe fn setTarget(&self, target: Option<&AnyObject>)
This is a weak property.
Setter for target
.
Sourcepub unsafe fn action(&self) -> Option<Sel>
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)
Sourcepub unsafe fn isEnabled(&self) -> bool
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)
Sourcepub unsafe fn setEnabled(&self, enabled: bool)
pub unsafe fn setEnabled(&self, enabled: bool)
Setter for isEnabled
.
pub unsafe fn image(&self) -> Option<Retained<NSImage>>
NSImage
only.Sourcepub unsafe fn setImage(&self, image: Option<&NSImage>)
Available on crate feature NSImage
only.
pub unsafe fn setImage(&self, image: Option<&NSImage>)
NSImage
only.Setter for image
.
Sourcepub unsafe fn title(&self) -> Retained<NSString>
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)
Sourcepub unsafe fn isBordered(&self) -> bool
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.
Sourcepub unsafe fn setBordered(&self, bordered: bool)
pub unsafe fn setBordered(&self, bordered: bool)
Setter for isBordered
.
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.
Setter for isNavigational
.
Sourcepub unsafe fn view(&self) -> Option<Retained<NSView>>
Available on crate features NSResponder
and NSView
only.
pub unsafe fn view(&self) -> Option<Retained<NSView>>
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.
Sourcepub unsafe fn setView(&self, view: Option<&NSView>)
Available on crate features NSResponder
and NSView
only.
pub unsafe fn setView(&self, view: Option<&NSView>)
NSResponder
and NSView
only.Setter for view
.
Sourcepub unsafe fn isVisible(&self) -> bool
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.
Sourcepub unsafe fn isHidden(&self) -> bool
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.
Sourcepub 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.
pub unsafe fn minSize(&self) -> NSSize
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.
Sourcepub 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.
pub unsafe fn setMinSize(&self, min_size: NSSize)
Setter for minSize
.
pub unsafe fn maxSize(&self) -> NSSize
Sourcepub 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.
pub unsafe fn setMaxSize(&self, max_size: NSSize)
Setter for maxSize
.
Sourcepub unsafe fn visibilityPriority(&self) -> NSToolbarItemVisibilityPriority
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.
Sourcepub unsafe fn setVisibilityPriority(
&self,
visibility_priority: NSToolbarItemVisibilityPriority,
)
pub unsafe fn setVisibilityPriority( &self, visibility_priority: NSToolbarItemVisibilityPriority, )
Setter for visibilityPriority
.
Sourcepub unsafe fn validate(&self)
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.
Sourcepub unsafe fn autovalidates(&self) -> bool
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.
Sourcepub unsafe fn setAutovalidates(&self, autovalidates: bool)
pub unsafe fn setAutovalidates(&self, autovalidates: bool)
Setter for autovalidates
.
Sourcepub unsafe fn allowsDuplicatesInToolbar(&self) -> bool
👎Deprecated: Duplicates are no longer supported.
pub unsafe fn allowsDuplicatesInToolbar(&self) -> bool
Duplicate items outside of spaces are not allowed.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
Available on crate feature NSAccessibilityConstants
only.
pub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.Available on crate feature NSAccessibilityConstants
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Available on crate feature NSAccessibilityConstants
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§impl AsRef<AnyObject> for NSToolbarItemGroup
impl AsRef<AnyObject> for NSToolbarItemGroup
Source§impl AsRef<NSObject> for NSToolbarItemGroup
impl AsRef<NSObject> for NSToolbarItemGroup
Source§impl AsRef<NSToolbarItem> for NSToolbarItemGroup
impl AsRef<NSToolbarItem> for NSToolbarItemGroup
Source§fn as_ref(&self) -> &NSToolbarItem
fn as_ref(&self) -> &NSToolbarItem
Source§impl AsRef<NSToolbarItemGroup> for NSToolbarItemGroup
impl AsRef<NSToolbarItemGroup> for NSToolbarItemGroup
Source§impl Borrow<AnyObject> for NSToolbarItemGroup
impl Borrow<AnyObject> for NSToolbarItemGroup
Source§impl Borrow<NSObject> for NSToolbarItemGroup
impl Borrow<NSObject> for NSToolbarItemGroup
Source§impl Borrow<NSToolbarItem> for NSToolbarItemGroup
impl Borrow<NSToolbarItem> for NSToolbarItemGroup
Source§fn borrow(&self) -> &NSToolbarItem
fn borrow(&self) -> &NSToolbarItem
Source§impl ClassType for NSToolbarItemGroup
impl ClassType for NSToolbarItemGroup
Source§const NAME: &'static str = "NSToolbarItemGroup"
const NAME: &'static str = "NSToolbarItemGroup"
Source§type Super = NSToolbarItem
type Super = NSToolbarItem
Source§type ThreadKind = <<NSToolbarItemGroup as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSToolbarItemGroup as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for NSToolbarItemGroup
impl CopyingHelper for NSToolbarItemGroup
Source§type Result = NSToolbarItemGroup
type Result = NSToolbarItemGroup
Self
if the type has no
immutable counterpart. Read moreSource§impl Debug for NSToolbarItemGroup
impl Debug for NSToolbarItemGroup
Source§impl Deref for NSToolbarItemGroup
impl Deref for NSToolbarItemGroup
Source§impl Hash for NSToolbarItemGroup
impl Hash for NSToolbarItemGroup
Source§impl Message for NSToolbarItemGroup
impl Message for NSToolbarItemGroup
Source§impl NSCopying for NSToolbarItemGroup
impl NSCopying for NSToolbarItemGroup
Source§impl NSObjectProtocol for NSToolbarItemGroup
impl NSObjectProtocol for NSToolbarItemGroup
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref
Source§fn isMemberOfClass(&self, cls: &AnyClass) -> bool
fn isMemberOfClass(&self, cls: &AnyClass) -> bool
Source§fn respondsToSelector(&self, aSelector: Sel) -> bool
fn respondsToSelector(&self, aSelector: Sel) -> bool
Source§fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
Source§fn debugDescription(&self) -> Retained<NSObject>
fn debugDescription(&self) -> Retained<NSObject>
Source§impl PartialEq for NSToolbarItemGroup
impl PartialEq for NSToolbarItemGroup
Source§impl RefEncode for NSToolbarItemGroup
impl RefEncode for NSToolbarItemGroup
Source§const ENCODING_REF: Encoding = <NSToolbarItem as ::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <NSToolbarItem as ::objc2::RefEncode>::ENCODING_REF
impl DowncastTarget for NSToolbarItemGroup
impl Eq for NSToolbarItemGroup
Auto Trait Implementations§
impl !Freeze for NSToolbarItemGroup
impl !RefUnwindSafe for NSToolbarItemGroup
impl !Send for NSToolbarItemGroup
impl !Sync for NSToolbarItemGroup
impl !Unpin for NSToolbarItemGroup
impl !UnwindSafe for NSToolbarItemGroup
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<'a, T> MainThreadOnly for T
impl<'a, T> MainThreadOnly for T
Source§fn mtm(&self) -> MainThreadMarker
fn mtm(&self) -> MainThreadMarker
MainThreadMarker
from the main-thread-only object. Read more