Struct UITabGroup

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

Available on crate features UITab and UITabGroup only.

Apple’s documentation

Implementations

impl UITabGroup

pub unsafe fn selectedChild(&self) -> Option<Retained<UITab>>

The currently selected tab. The tab must be part of children.

pub unsafe fn setSelectedChild(&self, selected_child: Option<&UITab>)

Setter for selectedChild.

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

The default child tab to select for when a selection is required and selectedChild is nil. If this is nil, then the default selected element is the first element of children. Default is nil.

pub unsafe fn setDefaultChildIdentifier( &self, default_child_identifier: Option<&NSString>, )

Setter for defaultChildIdentifier.

pub unsafe fn children(&self) -> Retained<NSArray<UITab>>

Child tabs of the tab group. Default is an empty array.

pub unsafe fn setChildren(&self, children: &NSArray<UITab>)

Setter for children.

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

The display order of the children, represented by the identifiers. Default is empty. Any tab in children not contained in displayOrderIdentifiers will be appended after sorted items. Identifiers that do not match tabs in children will be ignored.

pub unsafe fn setDisplayOrderIdentifiers( &self, display_order_identifiers: &NSArray<NSString>, )

Setter for displayOrderIdentifiers.

pub unsafe fn allowsReordering(&self) -> bool

Determines if elements in children can be reordered from the sidebar. Default is NO. Changes in the display order are notified via tabBarController:didCustomizeDisplayOrderForGroup: in UITabBarControllerDelegate.

pub unsafe fn setAllowsReordering(&self, allows_reordering: bool)

Setter for allowsReordering.

pub unsafe fn displayOrder(&self) -> Retained<NSArray<UITab>>

Returns the children array sorted by displayOrderIdentifiers if it is specified. Any tab in children not contained in the identifiers will be appended after sorted items. Identifiers that do not match tabs in children will be ignored.

pub unsafe fn tabForIdentifier( &self, identifier: &NSString, ) -> Option<Retained<UITab>>

Returns the tab matching the specified identifier in the group’s children and its descendants. Returns nil if no tab is found matching the identifier.

pub unsafe fn managingNavigationController( &self, ) -> Option<Retained<UINavigationController>>

Available on crate features UINavigationController and UIResponder and UIViewController only.

A navigation controller used to automatically manage the view controller hierarchy of the group. Set a UINavigationController to allow the tab group to manage the hierarchy automatically. The navigation stack of the managing navigation controller will be managed by the tab group based on the selected tab of the group. When multiple navigation controllers are set on nested groups, the rootmost controller is used. Default is nil.

By default, the navigation stack is represented by the view controller of each tab of the selected tree, if a view controller is provided for that level. If no view controller is provided for that level, then it will be ignored.

To customize the displayed view controllers per tab level of selection, implement the delegate method tabBarController:displayedViewControllersForTab:proposedViewControllers: on UITabBarControllerDelegate, which will propose a set of view controllers per level.

pub unsafe fn setManagingNavigationController( &self, managing_navigation_controller: Option<&UINavigationController>, )

Available on crate features UINavigationController and UIResponder and UIViewController only.

Setter for managingNavigationController.

pub unsafe fn sidebarActions(&self) -> Retained<NSArray<UIAction>>

Available on crate features UIAction and UIMenuElement only.

Actions to display in the sidebar, after all tabs. Default is nil.

pub unsafe fn setSidebarActions(&self, sidebar_actions: &NSArray<UIAction>)

Available on crate features UIAction and UIMenuElement only.

Setter for sidebarActions.

pub unsafe fn sidebarAppearance(&self) -> UITabGroupSidebarAppearance

The preferred appearance of the group and its children in the sidebar. Default is automatic

pub unsafe fn setSidebarAppearance( &self, sidebar_appearance: UITabGroupSidebarAppearance, )

Setter for sidebarAppearance.

pub unsafe fn initWithTitle_image_identifier_children_viewControllerProvider( this: Allocated<Self>, title: &NSString, image: Option<&UIImage>, identifier: &NSString, children: &NSArray<UITab>, view_controller_provider: Option<&DynBlock<dyn Fn(NonNull<UITab>) -> NonNull<UIViewController>>>, ) -> Retained<Self>

Available on crate features UIImage and UIResponder and UIViewController and block2 only.

Creates a UITabGroup using the specified parameters.

impl UITabGroup

Methods declared on superclass UITab.

pub unsafe fn initWithTitle_image_identifier_viewControllerProvider( this: Allocated<Self>, title: &NSString, image: Option<&UIImage>, identifier: &NSString, view_controller_provider: Option<&DynBlock<dyn Fn(NonNull<UITab>) -> NonNull<UIViewController>>>, ) -> Retained<Self>

Available on crate features UIImage and UIResponder and UIViewController and block2 only.

Creates a tab with the specified identifier, title, image, and view controller provider. The view controller provider is called when a view controller is requested and is currently nil. For root level tabs on UITabBarController, the resolved view controller must be non-nil.

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

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

Methods from Deref<Target = UITab>

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

The identifier associated with the tab, must be unique across the tab bar controller.

pub unsafe fn isEnabled(&self) -> bool

Determines if the tab is enabled. When NO, tabs will have a disabled appearance and cannot be selected by the user. Default is YES.

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

Setter for isEnabled.

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

The title of the tab.

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

Setter for title.

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

Available on crate feature UIImage only.

The image of the tab. Default is nil.

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

Available on crate feature UIImage only.

Setter for image.

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

The subtitle of the tab. This is displayed only in certain contexts, like the sidebar. Default is nil.

pub unsafe fn setSubtitle(&self, subtitle: Option<&NSString>)

Setter for subtitle.

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

The badge value of the tab. Default is nil.

pub unsafe fn setBadgeValue(&self, badge_value: Option<&NSString>)

Setter for badgeValue.

pub unsafe fn preferredPlacement(&self) -> UITabPlacement

The preferred placement for the tab in the contexts that allow for different tab placements. Default is UITabPlacementAutomatic which resolves its placement based on context.

pub unsafe fn setPreferredPlacement(&self, preferred_placement: UITabPlacement)

Setter for preferredPlacement.

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

A custom object associated with the tab. Default is nil.

pub unsafe fn setUserInfo(&self, user_info: Option<&AnyObject>)

Setter for userInfo.

pub unsafe fn parent(&self) -> Option<Retained<UITabGroup>>

The parent group of the tab. This is only non-nil if the tab is part of a parent group, and returns nil otherwise.

pub unsafe fn tabBarController(&self) -> Option<Retained<UITabBarController>>

Available on crate features UIResponder and UITabBarController and UIViewController only.

The tab bar controller managing the tab. This is non-nil when the tab or any of its ancestors is added to a UITabBarController; and is nil otherwise.

pub unsafe fn viewController(&self) -> Option<Retained<UIViewController>>

Available on crate features UIResponder and UIViewController only.

The view controller owned by the tab. The view controller provider is used to resolve the view controller if it is currently nil. For root level tabs, the view controller for the tab must be non-nil.

pub unsafe fn managingTabGroup(&self) -> Option<Retained<UITabGroup>>

The managing tab group for the tab. This returns the rootmost UITabGroup in the tab’s parent hierarchy with an active managingNavigationController. This can be different to parent if the tab is nested in multiple levels of tab groups. If the tab does not belong to a hierarchy with a managing navigation controller, then this will return nil. Default is nil.

pub unsafe fn isHidden(&self) -> bool

Determines if the tab is currently hidden. Default is NO. Hidden tabs cannot be accessed from the sidebar.

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

Setter for isHidden.

pub unsafe fn isHiddenByDefault(&self) -> bool

The default hidden state. When the user resets their customization, UITab.hidden will be set to the value of this property. Default is NO.

pub unsafe fn setHiddenByDefault(&self, hidden_by_default: bool)

Setter for isHiddenByDefault.

pub unsafe fn allowsHiding(&self) -> bool

Determines if the tab’s visibility can be changed by the user while editing. Default is NO.

pub unsafe fn setAllowsHiding(&self, allows_hiding: bool)

Setter for allowsHiding.

pub unsafe fn hasVisiblePlacement(&self) -> bool

Determines if the tab has a visible placement. Returns YES if the tab is visible in a tab bar that supports different tab placements. Otherwise returns NO.

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 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());

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.

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

Trait Implementations

impl AsRef<AnyObject> for UITabGroup

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UITabGroup

fn as_ref(&self) -> &NSObject

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

impl AsRef<UITab> for UITabGroup

fn as_ref(&self) -> &UITab

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

impl AsRef<UITabGroup> for UITabGroup

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UITabGroup

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UITabGroup

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UITab> for UITabGroup

fn borrow(&self) -> &UITab

Immutably borrows from an owned value.

impl ClassType for UITabGroup

const NAME: &'static str = "UITabGroup"

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

type Super = UITab

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 Debug for UITabGroup

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

Formats the value using the given formatter.

impl Deref for UITabGroup

type Target = UITab

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UITabGroup

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 UITabGroup

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for UITabGroup

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 UITabGroup

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 UITabGroup

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

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

impl DowncastTarget for UITabGroup

impl Eq for UITabGroup