BarButtonItem

A specialized button for placement on a toolbar or tab bar.

open class BarButtonItem: BarItem 

You can customize the appearance of buttons by sending the setter messages to BarButtonItemAppearance to customize all buttons, or to a specific BarButtonItem instance. You can use customized buttons in standard places in a NavigationItem object (backBarButtonItem, leftBarButtonItem, rightBarButtonItem) or a Toolbar instance.

In general, you should specify a value for the normal state so that other states without a custom value set can use it. Similarly, when a property is depends on the bar metrics, you should specify a value of BarMetrics.default.

Inheritance

BarItem

Initializers

`init(barButtonSystemItem:target:action:)`

Initializes a new item containing the specified system item.

public convenience init<Target: AnyObject>(barButtonSystemItem systemItem: BarButtonItem.SystemItem,
                                             target: Target?,
                                             action: ((Target) -> () -> Void)?) 

`init(barButtonSystemItem:target:action:)`

public convenience init<Target: AnyObject>(barButtonSystemItem systemItem: BarButtonItem.SystemItem,
                                             target: Target?,
                                             action: ((Target) -> (AnyObject?) -> Void)?) 

`init(customView:)`

Initializes a new item using the specified custom view.

public convenience init(customView: View) 

The bar button item created by this method does not call the action method of its target in response to user interactions. Instead, the bar button item expects the specified custom view to handle any user interactions and provide an appropriate response.

`init(image:style:target:action:)`

Initializes a new item using the specified image and other properties.

public convenience init<Target: AnyObject>(image: Image?,
                                             style: BarButtonItem.Style,
                                             target: Target?,
                                             action: ((Target) -> () -> Void)?) 

`init(image:style:target:action:)`

public convenience init<Target: AnyObject>(image: Image?,
                                             style: BarButtonItem.Style,
                                             target: Target?,
                                             action: ((Target) -> (AnyObject?) -> Void)?) 

`init(title:style:target:action:)`

Initializes a new item using the specified title and other properties.

public convenience init<Target: AnyObject>(title: String?,
                                             style: BarButtonItem.Style,
                                             target: Target?,
                                             action: ((Target) -> () -> Void)?) 

`init(title:style:target:action:)`

public convenience init<Target: AnyObject>(title: String?,
                                             style: BarButtonItem.Style,
                                             target: Target?,
                                             action: ((Target) -> (AnyObject?) -> Void)?) 

`init(title:image:primaryAction:menu:)`

Initializes a new item using the specified title, image, action, and context menu.

public convenience init(title: String? = nil, image: Image? = nil,
                          primaryAction: Action? = nil, menu: Menu? = nil) 

The context menu is displayed immediately when touched.

`init(systemItem:primaryAction:menu:)`

Initializes a new item using the specified system item, action, and context menu.

public convenience init(systemItem: BarButtonItem.SystemItem,
                          primaryAction: Action? = nil, menu: Menu? = nil) 

The context menu is displayed immediately when touched.

`init(image:landscapeImagePhone:style:target:action:)`

Initializes a new item using the specified images and other properties.

public convenience init<Target: AnyObject>(image: Image?,
                                             landscapeImagePhone: Image?,
                                             style: BarButtonItem.Style,
                                             target: Target?,
                                             action: ((Target) -> () -> Void)?) 

A new item initialized to use using the specified images and other properties.

`init(image:landscapeImagePhone:style:target:action:)`

public convenience init<Target: AnyObject>(image: Image?,
                                             landscapeImagePhone: Image?,
                                             style: BarButtonItem.Style,
                                             target: Target?,
                                             action: ((Target) -> (_: AnyObject?) -> Void)?) 

`init()`

Initializes the bar button item to its default state.

public override init() 

Properties

`target`

The object that receives an action when the user selects the item.

open weak var target: AnyObject?

If nil, the action message is passed up the responder chain where it may be handled by any object implementing a method corresponding to the selector held by the action property. The default value is nil.

`style`

The selector defining the action message to send to the target object when the user taps this bar button item.

open var style: BarButtonItem.Style = .plain

If the value of this property is nil, no action message is sent. The default value is nil. The style of the item.

One of the constants defined in BarButtonItem.Style. The default value is BarButtonItem.Style.plain.

`possibleTitles`

The set of possible titles to display on the bar button.

open var possibleTitles: Set<String>?

`width`

The width of the item.

open var width: Double = 0.0

If this property value is positive, the width of the combined image and title are fixed. If the value is 0.0 or negative, the item sets the width of the combined image and title to fit. This property is ignored if the style uses radio mode. The default value is 0.0.

`customView`

A custom view representing the item.

open var customView: View?

`menu`

The context menu for this button.

open var menu: Menu?

The context menu is displayed immediately when touched.

`primaryAction`

The action to send to the target when the user selects the item.

open var primaryAction: Action?

The target and action properties are ingored when primaryAction is not nil.

`tintColor`

The tint color to apply to the button item.

open var tintColor: Color?

All subclasses of View derive their behaviour for tintColor from the base class. Although BarButtonItem is not a view, its tintColor property behaves the same as that of View. See the discussion of tintColor at the View level for more information.

`buttonGroup`

The group on the shortcuts bar that the button belongs to.

open private(set) weak var buttonGroup: BarButtonItemGroup?

For bar button items installed on the shortcuts bar above the keyboard, this property contains the group to which the item belongs. This property is configured automatically when you add the bar button item to a BarButtonItemGroup object. If the item is not associated with a bar button item group, this property is nil.

Methods

`fixedSpace(_:)`

Creates a new fixed space item using the width.

open class func fixedSpace(_ width: Double) -> Self 

`flexibleSpace()`

Creates a new flexible width space item.

open class func flexibleSpace() -> Self 