UINavigationItem class
UINavigationItem
- Available extensions
Constructors
-
Returns a new instance of UINavigationItem constructed with the default
new
method.factory -
Constructs a UINavigationItem that points to the same underlying object as
other
. - Constructs a UINavigationItem that wraps the given raw object pointer.
Properties
- backBarButtonItem ↔ UIBarButtonItem?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
Bar button item to use for the back button when this item is the navigation bar's backItem.getter/setter pair - backButtonDisplayMode ↔ UINavigationItemBackButtonDisplayMode
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
Controls how the back button sources its title.getter/setter pair - backButtonTitle ↔ NSString?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
Title to use when this item is the navigation bar's backItem. Default is nil. backBarButtonItem takes precedence if both are specified.getter/setter pair - compactAppearance ↔ UINavigationBarAppearance?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
When set and this item is topmost, overrides the hosting navigation bar's compactAppearance. See UINavigationBar.compactAppearance for further details.getter/setter pair - compactScrollEdgeAppearance ↔ UINavigationBarAppearance?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
When set and this item is topmost, overrides the hosting navigation bar's compactScrollEdgeAppearance. See UINavigationBar.h for further details.getter/setter pair - hashCode → int
-
The hash code for this object.
no setterinherited
- hidesBackButton ↔ bool
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
If YES, this navigation item will hide the back button when it's on top of the stack.getter/setter pair - hidesSearchBarWhenScrolling ↔ bool
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
If this property is true (the default), the searchController’s search bar will hide as the user scrolls in the top view controller’s scroll view. If false, the search bar will remain visible and pinned underneath the navigation bar.getter/setter pair - largeTitleDisplayMode ↔ UINavigationItemLargeTitleDisplayMode
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
When UINavigationBar.prefersLargeTitles=YES, this property controls when the larger out-of-line title is displayed. If prefersLargeTitles=NO, this property has no effect. The default value is Automatic.getter/setter pair - leftBarButtonItem ↔ UIBarButtonItem?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
Some navigation items want to display a custom left or right item when they're on top of the stack. A custom left item replaces the regular back button unless you set leftItemsSupplementBackButton to YESgetter/setter pair - leftBarButtonItems ↔ NSArray?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
leftBarButtonItemsgetter/setter pair - leftItemsSupplementBackButton ↔ bool
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
leftItemsSupplementBackButtongetter/setter pair - prompt ↔ NSString?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
Explanatory text to display above the navigation bar buttons.getter/setter pair - ref → ObjCObjectRef
-
finalinherited
- rightBarButtonItem ↔ UIBarButtonItem?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
rightBarButtonItemgetter/setter pair - rightBarButtonItems ↔ NSArray?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
rightBarButtonItemsgetter/setter pair - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollEdgeAppearance ↔ UINavigationBarAppearance?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
When set and this item is topmost, overrides the hosting navigation bar's scrollEdgeAppearance. See UINavigationBar.scrollEdgeAppearance for further details.getter/setter pair - searchController ↔ UISearchController?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
A view controller that will be shown inside of a navigation controller can assign a UISearchController to this property to display the search controller’s search bar in its containing navigation controller’s navigation bar.getter/setter pair - standardAppearance ↔ UINavigationBarAppearance?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
When set and this item is topmost, overrides the hosting navigation bar's standardAppearance. See UINavigationBar.standardAppearance for further details.getter/setter pair - title ↔ NSString?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
Title when topmost on the stack. default is nilgetter/setter pair - titleView ↔ UIView?
-
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
Custom view to use in lieu of a title. May be sized horizontally. Only used when item is topmost on the stack.getter/setter pair
Methods
-
encodeWithCoder(
NSCoder coder) → void -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
encodeWithCoder: -
init(
) → UINavigationItem -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
init -
initWithCoder(
NSCoder coder) → UINavigationItem? -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
initWithCoder: -
initWithTitle(
NSString title) → UINavigationItem -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
initWithTitle: -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setHidesBackButton(
bool hidesBackButton$1, {required bool animated}) → void -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
setHidesBackButton:animated: -
setLeftBarButtonItem(
UIBarButtonItem? item, {required bool animated}) → void -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
setLeftBarButtonItem:animated: -
setLeftBarButtonItems(
NSArray? items, {required bool animated}) → void -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
setLeftBarButtonItems:animated: -
setRightBarButtonItem(
UIBarButtonItem? item, {required bool animated}) → void -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
setRightBarButtonItem:animated: -
setRightBarButtonItems(
NSArray? items, {required bool animated}) → void -
Available on UINavigationItem, provided by the UINavigationItem$Methods extension
setRightBarButtonItems:animated: -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
alloc(
) → UINavigationItem - alloc
-
allocWithZone(
Pointer< NSZone> zone) → UINavigationItem - allocWithZone:
-
isInstance(
ObjCObjectBase obj) → bool -
Returns whether
obj
is an instance of UINavigationItem. -
new$(
) → UINavigationItem - new