Struct UIBarButtonItemGroup

Source

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

Available on crate feature UIBarButtonItemGroup only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIBarButtonItemGroup

Source

pub unsafe fn initWithBarButtonItems_representativeItem( this: Allocated<Self>, bar_button_items: &NSArray<UIBarButtonItem>, representative_item: Option<&UIBarButtonItem>, ) -> Retained<Self>

Available on crate features UIBarButtonItem and UIBarItem only.

Create a new bar button item group with the given items. When bar button item layout is done, either the group’s barButtonItems or its representativeItem is displayed (if it exists).

Source

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

Source

pub unsafe fn fixedGroupWithRepresentativeItem_items( representative_item: Option<&UIBarButtonItem>, items: &NSArray<UIBarButtonItem>, mtm: MainThreadMarker, ) -> Retained<UIBarButtonItemGroup>

Available on crate features UIBarButtonItem and UIBarItem only.

Construct a UIBarButtonItemGroup that cannot be moved or removed under UINavigationBar customization.

Source

pub unsafe fn movableGroupWithCustomizationIdentifier_representativeItem_items( customization_identifier: &NSString, representative_item: Option<&UIBarButtonItem>, items: &NSArray<UIBarButtonItem>, mtm: MainThreadMarker, ) -> Retained<UIBarButtonItemGroup>

Available on crate features UIBarButtonItem and UIBarItem only.

Construct a UIBarButtonItemGroup that can be moved but cannot be removed under UINavigationBar customization.

Source

pub unsafe fn optionalGroupWithCustomizationIdentifier_inDefaultCustomization_representativeItem_items( customization_identifier: &NSString, in_default_customization: bool, representative_item: Option<&UIBarButtonItem>, items: &NSArray<UIBarButtonItem>, mtm: MainThreadMarker, ) -> Retained<UIBarButtonItemGroup>

Available on crate features UIBarButtonItem and UIBarItem only.

Construct a UIBarButtonItemGroup that can be moved or added/removed under UINavigationBar customization.

Source

pub unsafe fn barButtonItems(&self) -> Retained<NSArray<UIBarButtonItem>>

Available on crate features UIBarButtonItem and UIBarItem only.

The bar button items associated with this group. Changing these items will affect the bar displaying these items without needing to re-set the groups that are in that bar. Any UIBarButtonItems that are already in group will be removed from that group.

Source

pub unsafe fn setBarButtonItems( &self, bar_button_items: &NSArray<UIBarButtonItem>, )

Available on crate features UIBarButtonItem and UIBarItem only.

Setter for barButtonItems.

Source

pub unsafe fn representativeItem(&self) -> Option<Retained<UIBarButtonItem>>

Available on crate features UIBarButtonItem and UIBarItem only.

In order to display as many items as possible, bars that support UIBarButtonItemGroup may choose to collapse items associated with groups to the representativeItem specified by the group. A bar will only collapse groups that have a representativeItem set, but may still choose to use an alternate presentation of these items. A UIBarButtonItem may only be either the representativeItem or a member of the barButtonItems of a single UIBarButtonItemGroup and may only represent a single group. If the representativeItem has an action, then that action will be invoked, otherwise the bar will present a standard UI to allow selection of the barButtonItems in the representedItem’s group.

Source

pub unsafe fn setRepresentativeItem( &self, representative_item: Option<&UIBarButtonItem>, )

Available on crate features UIBarButtonItem and UIBarItem only.

Setter for representativeItem.

Source

pub unsafe fn isDisplayingRepresentativeItem(&self) -> bool

Returns YES if the representativeItem of this group is currently being displayed, rather than its barButtonItems.

Source

pub unsafe fn alwaysAvailable(&self) -> bool

Instructs UIKit to ensure that the functionality in this group is made available to the user regardless of customization status. On iPhone and iPad idioms, UIKit currently places these items in the overflow menu; this property has no effect on macOS idiom.

Source

pub unsafe fn setAlwaysAvailable(&self, always_available: bool)

Setter for alwaysAvailable.

Source

pub unsafe fn menuRepresentation(&self) -> Option<Retained<UIMenuElement>>

Available on crate feature UIMenuElement only.

A UIMenuElement that should substitute for the UIBarButtonItemGroup when displayed in a menu.

Source

pub unsafe fn setMenuRepresentation( &self, menu_representation: Option<&UIMenuElement>, )

Available on crate feature UIMenuElement only.

Setter for menuRepresentation.

Source

pub unsafe fn isHidden(&self) -> bool

If the group should be hidden from display.

Source

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

Setter for isHidden.

Source §

impl UIBarButtonItemGroup

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