Struct UITabBarControllerSidebar

Source

pub struct UITabBarControllerSidebar { /* private fields */ }

Available on crate feature UITabBarControllerSidebar only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UITabBarControllerSidebar

Source

pub fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn UITabBarControllerSidebarDelegate>>>

The object managing the delegate of the sidebar.

Source

pub fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn UITabBarControllerSidebarDelegate>>, )

Setter for delegate.

This is a weak property.

Source

pub fn isHidden(&self) -> bool

Determines if the sidebar is currently hidden.

Source

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

Source

pub fn preferredLayout(&self) -> UITabBarControllerSidebarLayout

The preferred layout for how the sidebar lays out with the tab bar controller’s content. Default is .automatic

Source

pub fn setPreferredLayout( &self, preferred_layout: UITabBarControllerSidebarLayout, )

Setter for preferredLayout.

Source

pub fn navigationOverflowItems(&self) -> Option<Retained<UIDeferredMenuElement>>

Available on crate features UIDeferredMenuElement and UIMenuElement only.

Additional items to add to the overflow menu in the sidebar’s navigation bar. Setting this property to a non-nil value will force the overflow button to appear, regardless of if you provide any content in the element’s callback. Items returned are displayed directly in the presented menu. When set, the “Edit Sidebar” action will also be moved into the overflow menu after the app-provided items.

Source

pub fn setNavigationOverflowItems( &self, navigation_overflow_items: Option<&UIDeferredMenuElement>, )

Available on crate features UIDeferredMenuElement and UIMenuElement only.

Setter for navigationOverflowItems.

Source

pub fn headerContentConfiguration( &self, ) -> Option<Retained<ProtocolObject<dyn UIContentConfiguration>>>

Available on crate feature UIContentConfiguration only.

Content configuration for an optional header to display in the sidebar. The header is displayed above all tab content in the sidebar.

Source

pub fn setHeaderContentConfiguration( &self, header_content_configuration: Option<&ProtocolObject<dyn UIContentConfiguration>>, )

Available on crate feature UIContentConfiguration only.

Setter for headerContentConfiguration.

This is copied when set.

Source

pub fn footerContentConfiguration( &self, ) -> Option<Retained<ProtocolObject<dyn UIContentConfiguration>>>

Available on crate feature UIContentConfiguration only.

Content configuration for an optional header to display in the sidebar. The footer is displayed below all tab content in the sidebar.

Source

pub fn setFooterContentConfiguration( &self, footer_content_configuration: Option<&ProtocolObject<dyn UIContentConfiguration>>, )

Available on crate feature UIContentConfiguration only.

Setter for footerContentConfiguration.

This is copied when set.

Source

pub fn bottomBarView(&self) -> Option<Retained<UIView>>

Available on crate features UIResponder and UIView only.

A view to display at the bottom of the sidebar, like a UIToolbar. The width of this view will be managed by the sidebar itself, and its height will be set to the value it returns from systemLayoutSizeFittingSize:withHorizontalFittingPriority:verticalFittingPriority: Default is nil.

Source

pub fn setBottomBarView(&self, bottom_bar_view: Option<&UIView>)

Available on crate features UIResponder and UIView only.

Setter for bottomBarView.

Source

pub fn scrollToTarget_animated( &self, target: &UITabSidebarScrollTarget, animated: bool, )

Scrolls to the specified target in the sidebar with an option to animate the change.

Source

pub fn reconfigureItemForTab(&self, tab: &UITab)

Available on crate feature UITab only.

Requests the sidebar reconfigure the item representing the specified tab. This method has no effect if the tab is not currently displayed in the sidebar.

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