Struct objc2_ui_kit::UINavigationItem

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

Available on crate feature UINavigationItem only.

Implementations

impl UINavigationItem

pub unsafe fn initWithTitle( this: Allocated<Self>, title: &NSString ) -> Retained<Self>

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

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

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

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

Available on crate features UIResponder and UIView only.

pub unsafe fn setTitleView(&self, title_view: Option<&UIView>)

Available on crate features UIResponder and UIView only.

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

pub unsafe fn setPrompt(&self, prompt: Option<&NSString>)

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

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setBackBarButtonItem( &self, back_bar_button_item: Option<&UIBarButtonItem> )

Available on crate features UIBarButtonItem and UIBarItem only.

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

pub unsafe fn setBackButtonTitle(&self, back_button_title: Option<&NSString>)

pub unsafe fn hidesBackButton(&self) -> bool

pub unsafe fn setHidesBackButton(&self, hides_back_button: bool)

pub unsafe fn setHidesBackButton_animated( &self, hides_back_button: bool, animated: bool )

pub unsafe fn backButtonDisplayMode( &self ) -> UINavigationItemBackButtonDisplayMode

pub unsafe fn setBackButtonDisplayMode( &self, back_button_display_mode: UINavigationItemBackButtonDisplayMode )

pub unsafe fn backAction(&self) -> Option<Retained<UIAction>>

Available on crate features UIAction and UIMenuElement only.

pub unsafe fn setBackAction(&self, back_action: Option<&UIAction>)

Available on crate features UIAction and UIMenuElement only.

pub unsafe fn titleMenuProvider( &self ) -> *mut Block<dyn Fn(NonNull<NSArray<UIMenuElement>>) -> *mut UIMenu>

Available on crate features UIMenu and UIMenuElement and block2 only.

pub unsafe fn setTitleMenuProvider( &self, title_menu_provider: Option<&Block<dyn Fn(NonNull<NSArray<UIMenuElement>>) -> *mut UIMenu>> )

Available on crate features UIMenu and UIMenuElement and block2 only.

pub unsafe fn renameDelegate( &self ) -> Option<Retained<ProtocolObject<dyn UINavigationItemRenameDelegate>>>

pub unsafe fn setRenameDelegate( &self, rename_delegate: Option<&ProtocolObject<dyn UINavigationItemRenameDelegate>> )

pub unsafe fn documentProperties( &self ) -> Option<Retained<UIDocumentProperties>>

Available on crate feature UIDocumentProperties only.

pub unsafe fn setDocumentProperties( &self, document_properties: Option<&UIDocumentProperties> )

Available on crate feature UIDocumentProperties only.

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

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setLeftBarButtonItems( &self, left_bar_button_items: Option<&NSArray<UIBarButtonItem>> )

Available on crate features UIBarButtonItem and UIBarItem only.

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

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setRightBarButtonItems( &self, right_bar_button_items: Option<&NSArray<UIBarButtonItem>> )

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setLeftBarButtonItems_animated( &self, items: Option<&NSArray<UIBarButtonItem>>, animated: bool )

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setRightBarButtonItems_animated( &self, items: Option<&NSArray<UIBarButtonItem>>, animated: bool )

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn leftItemsSupplementBackButton(&self) -> bool

pub unsafe fn setLeftItemsSupplementBackButton( &self, left_items_supplement_back_button: bool )

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

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setLeftBarButtonItem( &self, left_bar_button_item: Option<&UIBarButtonItem> )

Available on crate features UIBarButtonItem and UIBarItem only.

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

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setRightBarButtonItem( &self, right_bar_button_item: Option<&UIBarButtonItem> )

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setLeftBarButtonItem_animated( &self, item: Option<&UIBarButtonItem>, animated: bool )

Available on crate features UIBarButtonItem and UIBarItem only.

pub unsafe fn setRightBarButtonItem_animated( &self, item: Option<&UIBarButtonItem>, animated: bool )

Available on crate features UIBarButtonItem and UIBarItem only.

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

pub unsafe fn setCustomizationIdentifier( &self, customization_identifier: Option<&NSString> )

pub unsafe fn leadingItemGroups( &self ) -> Retained<NSArray<UIBarButtonItemGroup>>

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn setLeadingItemGroups( &self, leading_item_groups: &NSArray<UIBarButtonItemGroup> )

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn centerItemGroups(&self) -> Retained<NSArray<UIBarButtonItemGroup>>

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn setCenterItemGroups( &self, center_item_groups: &NSArray<UIBarButtonItemGroup> )

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn trailingItemGroups( &self ) -> Retained<NSArray<UIBarButtonItemGroup>>

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn setTrailingItemGroups( &self, trailing_item_groups: &NSArray<UIBarButtonItemGroup> )

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn pinnedTrailingGroup( &self ) -> Option<Retained<UIBarButtonItemGroup>>

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn setPinnedTrailingGroup( &self, pinned_trailing_group: Option<&UIBarButtonItemGroup> )

Available on crate feature UIBarButtonItemGroup only.

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

Available on crate features UIDeferredMenuElement and UIMenuElement only.

pub unsafe fn setAdditionalOverflowItems( &self, additional_overflow_items: Option<&UIDeferredMenuElement> )

Available on crate features UIDeferredMenuElement and UIMenuElement only.

pub unsafe fn overflowPresentationSource( &self ) -> Option<Retained<ProtocolObject<dyn UIPopoverPresentationControllerSourceItem>>>

Available on crate feature UIPopoverPresentationControllerSourceItem only.

pub unsafe fn largeTitleDisplayMode( &self ) -> UINavigationItemLargeTitleDisplayMode

pub unsafe fn setLargeTitleDisplayMode( &self, large_title_display_mode: UINavigationItemLargeTitleDisplayMode )

pub unsafe fn style(&self) -> UINavigationItemStyle

pub unsafe fn setStyle(&self, style: UINavigationItemStyle)

pub unsafe fn searchController(&self) -> Option<Retained<UISearchController>>

Available on crate features UIResponder and UISearchController and UIViewController only.

pub unsafe fn setSearchController( &self, search_controller: Option<&UISearchController> )

Available on crate features UIResponder and UISearchController and UIViewController only.

pub unsafe fn hidesSearchBarWhenScrolling(&self) -> bool

pub unsafe fn setHidesSearchBarWhenScrolling( &self, hides_search_bar_when_scrolling: bool )

pub unsafe fn preferredSearchBarPlacement( &self ) -> UINavigationItemSearchBarPlacement

pub unsafe fn setPreferredSearchBarPlacement( &self, preferred_search_bar_placement: UINavigationItemSearchBarPlacement )

pub unsafe fn searchBarPlacement(&self) -> UINavigationItemSearchBarPlacement

pub unsafe fn standardAppearance( &self ) -> Option<Retained<UINavigationBarAppearance>>

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

pub unsafe fn setStandardAppearance( &self, standard_appearance: Option<&UINavigationBarAppearance> )

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

pub unsafe fn compactAppearance( &self ) -> Option<Retained<UINavigationBarAppearance>>

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

pub unsafe fn setCompactAppearance( &self, compact_appearance: Option<&UINavigationBarAppearance> )

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

pub unsafe fn scrollEdgeAppearance( &self ) -> Option<Retained<UINavigationBarAppearance>>

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

pub unsafe fn setScrollEdgeAppearance( &self, scroll_edge_appearance: Option<&UINavigationBarAppearance> )

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

pub unsafe fn compactScrollEdgeAppearance( &self ) -> Option<Retained<UINavigationBarAppearance>>

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

pub unsafe fn setCompactScrollEdgeAppearance( &self, compact_scroll_edge_appearance: Option<&UINavigationBarAppearance> )

Available on crate features UIBarAppearance and UINavigationBarAppearance only.

impl UINavigationItem

Methods declared on superclass NSObject

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

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

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.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Available on crate feature UIIndirectScribbleInteraction only.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for UINavigationItem

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSObject> for UINavigationItem

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<UINavigationItem> for UINavigationItem

fn as_mut(&mut self) -> &mut Self

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

impl AsRef<AnyObject> for UINavigationItem

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UINavigationItem

fn as_ref(&self) -> &NSObject

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

impl AsRef<UINavigationItem> for UINavigationItem

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UINavigationItem

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UINavigationItem

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for UINavigationItem

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for UINavigationItem

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl ClassType for UINavigationItem

type Super = NSObject

The superclass of this class.

type Mutability = MainThreadOnly

Whether the type is mutable or immutable.

const NAME: &'static str = "UINavigationItem"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

impl Debug for UINavigationItem

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

Formats the value using the given formatter.

impl Deref for UINavigationItem

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for UINavigationItem

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Hash for UINavigationItem

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 NSCoding for UINavigationItem

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for UINavigationItem

fn isEqual(&self, other: &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,

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 UINavigationItem

fn eq(&self, other: &UINavigationItem) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for UINavigationItem

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

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

impl Eq for UINavigationItem

impl Message for UINavigationItem

impl StructuralPartialEq for UINavigationItem