Struct objc2_ui_kit::UIBarButtonItem

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

Available on crate features UIBarButtonItem and UIBarItem only.

Implementations

impl UIBarButtonItem

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

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

pub unsafe fn initWithImage_style_target_action( this: Allocated<Self>, image: Option<&UIImage>, style: UIBarButtonItemStyle, target: Option<&AnyObject>, action: Option<Sel> ) -> Retained<Self>

Available on crate feature UIImage only.

pub unsafe fn initWithImage_landscapeImagePhone_style_target_action( this: Allocated<Self>, image: Option<&UIImage>, landscape_image_phone: Option<&UIImage>, style: UIBarButtonItemStyle, target: Option<&AnyObject>, action: Option<Sel> ) -> Retained<Self>

Available on crate feature UIImage only.

pub unsafe fn initWithTitle_style_target_action( this: Allocated<Self>, title: Option<&NSString>, style: UIBarButtonItemStyle, target: Option<&AnyObject>, action: Option<Sel> ) -> Retained<Self>

pub unsafe fn initWithBarButtonSystemItem_target_action( this: Allocated<Self>, system_item: UIBarButtonSystemItem, target: Option<&AnyObject>, action: Option<Sel> ) -> Retained<Self>

pub unsafe fn initWithCustomView( this: Allocated<Self>, custom_view: &UIView ) -> Retained<Self>

Available on crate features UIResponder and UIView only.

pub unsafe fn initWithBarButtonSystemItem_primaryAction( this: Allocated<Self>, system_item: UIBarButtonSystemItem, primary_action: Option<&UIAction> ) -> Retained<Self>

Available on crate features UIAction and UIMenuElement only.

pub unsafe fn initWithPrimaryAction( this: Allocated<Self>, primary_action: Option<&UIAction> ) -> Retained<Self>

Available on crate features UIAction and UIMenuElement only.

pub unsafe fn initWithBarButtonSystemItem_menu( this: Allocated<Self>, system_item: UIBarButtonSystemItem, menu: Option<&UIMenu> ) -> Retained<Self>

Available on crate features UIMenu and UIMenuElement only.

pub unsafe fn initWithTitle_menu( this: Allocated<Self>, title: Option<&NSString>, menu: Option<&UIMenu> ) -> Retained<Self>

Available on crate features UIMenu and UIMenuElement only.

pub unsafe fn initWithImage_menu( this: Allocated<Self>, image: Option<&UIImage>, menu: Option<&UIMenu> ) -> Retained<Self>

Available on crate features UIImage and UIMenu and UIMenuElement only.

pub unsafe fn initWithPrimaryAction_menu( this: Allocated<Self>, primary_action: Option<&UIAction>, menu: Option<&UIMenu> ) -> Retained<Self>

Available on crate features UIAction and UIMenu and UIMenuElement only.

pub unsafe fn initWithBarButtonSystemItem_primaryAction_menu( this: Allocated<Self>, system_item: UIBarButtonSystemItem, primary_action: Option<&UIAction>, menu: Option<&UIMenu> ) -> Retained<Self>

Available on crate features UIAction and UIMenu and UIMenuElement only.

pub unsafe fn initWithTitle_image_target_action_menu( this: Allocated<Self>, title: Option<&NSString>, image: Option<&UIImage>, target: Option<&AnyObject>, action: Option<Sel>, menu: Option<&UIMenu> ) -> Retained<Self>

Available on crate features UIImage and UIMenu and UIMenuElement only.

pub unsafe fn fixedSpaceItemOfWidth( width: CGFloat, mtm: MainThreadMarker ) -> Retained<Self>

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

pub unsafe fn style(&self) -> UIBarButtonItemStyle

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

pub unsafe fn width(&self) -> CGFloat

pub unsafe fn setWidth(&self, width: CGFloat)

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

pub unsafe fn setPossibleTitles( &self, possible_titles: Option<&NSSet<NSString>> )

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

Available on crate features UIResponder and UIView only.

pub unsafe fn setCustomView(&self, custom_view: Option<&UIView>)

Available on crate features UIResponder and UIView only.

pub unsafe fn action(&self) -> Option<Sel>

pub unsafe fn setAction(&self, action: Option<Sel>)

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

pub unsafe fn setTarget(&self, target: Option<&AnyObject>)

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

Available on crate features UIAction and UIMenuElement only.

pub unsafe fn setPrimaryAction(&self, primary_action: Option<&UIAction>)

Available on crate features UIAction and UIMenuElement only.

pub unsafe fn menu(&self) -> Option<Retained<UIMenu>>

Available on crate features UIMenu and UIMenuElement only.

pub unsafe fn setMenu(&self, menu: Option<&UIMenu>)

Available on crate features UIMenu and UIMenuElement only.

pub unsafe fn preferredMenuElementOrder( &self ) -> UIContextMenuConfigurationElementOrder

Available on crate feature UIContextMenuConfiguration only.

pub unsafe fn setPreferredMenuElementOrder( &self, preferred_menu_element_order: UIContextMenuConfigurationElementOrder )

Available on crate feature UIContextMenuConfiguration only.

pub unsafe fn changesSelectionAsPrimaryAction(&self) -> bool

pub unsafe fn setChangesSelectionAsPrimaryAction( &self, changes_selection_as_primary_action: bool )

pub unsafe fn isSelected(&self) -> bool

pub unsafe fn setSelected(&self, selected: bool)

pub unsafe fn isHidden(&self) -> bool

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

pub unsafe fn isSymbolAnimationEnabled(&self) -> bool

pub unsafe fn setSymbolAnimationEnabled(&self, symbol_animation_enabled: bool)

pub unsafe fn menuRepresentation(&self) -> Option<Retained<UIMenuElement>>

Available on crate feature UIMenuElement only.

pub unsafe fn setMenuRepresentation( &self, menu_representation: Option<&UIMenuElement> )

Available on crate feature UIMenuElement only.

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

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn creatingMovableGroupWithCustomizationIdentifier( &self, customization_identifier: &NSString ) -> Retained<UIBarButtonItemGroup>

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn creatingOptionalGroupWithCustomizationIdentifier_inDefaultCustomization( &self, customization_identifier: &NSString, in_default_customization: bool ) -> Retained<UIBarButtonItemGroup>

Available on crate feature UIBarButtonItemGroup only.

pub unsafe fn setBackgroundImage_forState_barMetrics( &self, background_image: Option<&UIImage>, state: UIControlState, bar_metrics: UIBarMetrics )

Available on crate features UIBarCommon and UIControl and UIImage only.

pub unsafe fn backgroundImageForState_barMetrics( &self, state: UIControlState, bar_metrics: UIBarMetrics ) -> Option<Retained<UIImage>>

Available on crate features UIBarCommon and UIControl and UIImage only.

pub unsafe fn setBackgroundImage_forState_style_barMetrics( &self, background_image: Option<&UIImage>, state: UIControlState, style: UIBarButtonItemStyle, bar_metrics: UIBarMetrics )

Available on crate features UIBarCommon and UIControl and UIImage only.

pub unsafe fn backgroundImageForState_style_barMetrics( &self, state: UIControlState, style: UIBarButtonItemStyle, bar_metrics: UIBarMetrics ) -> Option<Retained<UIImage>>

Available on crate features UIBarCommon and UIControl and UIImage only.

pub unsafe fn tintColor(&self) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

pub unsafe fn setTintColor(&self, tint_color: Option<&UIColor>)

Available on crate feature UIColor only.

pub unsafe fn setBackgroundVerticalPositionAdjustment_forBarMetrics( &self, adjustment: CGFloat, bar_metrics: UIBarMetrics )

Available on crate feature UIBarCommon only.

pub unsafe fn backgroundVerticalPositionAdjustmentForBarMetrics( &self, bar_metrics: UIBarMetrics ) -> CGFloat

Available on crate feature UIBarCommon only.

pub unsafe fn setTitlePositionAdjustment_forBarMetrics( &self, adjustment: UIOffset, bar_metrics: UIBarMetrics )

Available on crate features UIBarCommon and UIGeometry only.

pub unsafe fn titlePositionAdjustmentForBarMetrics( &self, bar_metrics: UIBarMetrics ) -> UIOffset

Available on crate features UIBarCommon and UIGeometry only.

pub unsafe fn setBackButtonBackgroundImage_forState_barMetrics( &self, background_image: Option<&UIImage>, state: UIControlState, bar_metrics: UIBarMetrics )

Available on crate features UIBarCommon and UIControl and UIImage only.

pub unsafe fn backButtonBackgroundImageForState_barMetrics( &self, state: UIControlState, bar_metrics: UIBarMetrics ) -> Option<Retained<UIImage>>

Available on crate features UIBarCommon and UIControl and UIImage only.

pub unsafe fn setBackButtonTitlePositionAdjustment_forBarMetrics( &self, adjustment: UIOffset, bar_metrics: UIBarMetrics )

Available on crate features UIBarCommon and UIGeometry only.

pub unsafe fn backButtonTitlePositionAdjustmentForBarMetrics( &self, bar_metrics: UIBarMetrics ) -> UIOffset

Available on crate features UIBarCommon and UIGeometry only.

pub unsafe fn setBackButtonBackgroundVerticalPositionAdjustment_forBarMetrics( &self, adjustment: CGFloat, bar_metrics: UIBarMetrics )

Available on crate feature UIBarCommon only.

pub unsafe fn backButtonBackgroundVerticalPositionAdjustmentForBarMetrics( &self, bar_metrics: UIBarMetrics ) -> CGFloat

Available on crate feature UIBarCommon only.

impl UIBarButtonItem

Methods declared on superclass NSObject

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

impl UIBarButtonItem

This impl block contains no items.

SpringLoading

impl UIBarButtonItem

pub unsafe fn addSymbolEffect(&self, symbol_effect: &NSSymbolEffect)

Available on crate feature objc2-symbols only.

pub unsafe fn addSymbolEffect_options( &self, symbol_effect: &NSSymbolEffect, options: &NSSymbolEffectOptions )

Available on crate feature objc2-symbols only.

pub unsafe fn addSymbolEffect_options_animated( &self, symbol_effect: &NSSymbolEffect, options: &NSSymbolEffectOptions, animated: bool )

Available on crate feature objc2-symbols only.

pub unsafe fn removeSymbolEffectOfType(&self, symbol_effect: &NSSymbolEffect)

Available on crate feature objc2-symbols only.

pub unsafe fn removeSymbolEffectOfType_options( &self, symbol_effect: &NSSymbolEffect, options: &NSSymbolEffectOptions )

Available on crate feature objc2-symbols only.

pub unsafe fn removeSymbolEffectOfType_options_animated( &self, symbol_effect: &NSSymbolEffect, options: &NSSymbolEffectOptions, animated: bool )

Available on crate feature objc2-symbols only.

pub unsafe fn removeAllSymbolEffects(&self)

pub unsafe fn removeAllSymbolEffectsWithOptions( &self, options: &NSSymbolEffectOptions )

Available on crate feature objc2-symbols only.

pub unsafe fn removeAllSymbolEffectsWithOptions_animated( &self, options: &NSSymbolEffectOptions, animated: bool )

Available on crate feature objc2-symbols only.

pub unsafe fn setSymbolImage_withContentTransition( &self, symbol_image: &UIImage, transition: &NSSymbolContentTransition )

Available on crate features UIImage and objc2-symbols only.

pub unsafe fn setSymbolImage_withContentTransition_options( &self, symbol_image: &UIImage, transition: &NSSymbolContentTransition, options: &NSSymbolEffectOptions )

Available on crate features UIImage and objc2-symbols only.

impl UIBarButtonItem

UIBarButtonItemGroup

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

Available on crate feature UIBarButtonItemGroup only.

impl UIBarButtonItem

This impl block contains no items.

UIPopoverPresentationControllerSourceItem

Methods from Deref<Target = UIBarItem>

pub unsafe fn isEnabled(&self) -> bool

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

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

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

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

Available on crate feature UIImage only.

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

Available on crate feature UIImage only.

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

Available on crate feature UIImage only.

pub unsafe fn setLandscapeImagePhone( &self, landscape_image_phone: Option<&UIImage> )

Available on crate feature UIImage only.

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

Available on crate feature UIImage only.

pub unsafe fn setLargeContentSizeImage( &self, large_content_size_image: Option<&UIImage> )

Available on crate feature UIImage only.

pub unsafe fn imageInsets(&self) -> UIEdgeInsets

Available on crate feature UIGeometry only.

pub unsafe fn setImageInsets(&self, image_insets: UIEdgeInsets)

Available on crate feature UIGeometry only.

pub unsafe fn landscapeImagePhoneInsets(&self) -> UIEdgeInsets

Available on crate feature UIGeometry only.

pub unsafe fn setLandscapeImagePhoneInsets( &self, landscape_image_phone_insets: UIEdgeInsets )

Available on crate feature UIGeometry only.

pub unsafe fn largeContentSizeImageInsets(&self) -> UIEdgeInsets

Available on crate feature UIGeometry only.

pub unsafe fn setLargeContentSizeImageInsets( &self, large_content_size_image_insets: UIEdgeInsets )

Available on crate feature UIGeometry only.

pub unsafe fn tag(&self) -> NSInteger

pub unsafe fn setTag(&self, tag: NSInteger)

pub unsafe fn setTitleTextAttributes_forState( &self, attributes: Option<&NSDictionary<NSAttributedStringKey, AnyObject>>, state: UIControlState )

Available on crate feature UIControl only.

pub unsafe fn titleTextAttributesForState( &self, state: UIControlState ) -> Option<Retained<NSDictionary<NSAttributedStringKey, AnyObject>>>

Available on crate feature UIControl only.

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 UIBarButtonItem

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

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

impl AsMut<NSObject> for UIBarButtonItem

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

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

impl AsMut<UIBarButtonItem> for UIBarButtonItem

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

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

impl AsMut<UIBarItem> for UIBarButtonItem

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

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

impl AsRef<AnyObject> for UIBarButtonItem

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIBarButtonItem

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIBarButtonItem> for UIBarButtonItem

fn as_ref(&self) -> &Self

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

impl AsRef<UIBarItem> for UIBarButtonItem

fn as_ref(&self) -> &UIBarItem

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

impl Borrow<AnyObject> for UIBarButtonItem

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIBarButtonItem

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIBarItem> for UIBarButtonItem

fn borrow(&self) -> &UIBarItem

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for UIBarButtonItem

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for UIBarButtonItem

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

Mutably borrows from an owned value.

impl BorrowMut<UIBarItem> for UIBarButtonItem

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

Mutably borrows from an owned value.

impl ClassType for UIBarButtonItem

type Super = UIBarItem

The superclass of this class.

type Mutability = MainThreadOnly

Whether the type is mutable or immutable.

const NAME: &'static str = "UIBarButtonItem"

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 UIBarButtonItem

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

Formats the value using the given formatter.

impl Deref for UIBarButtonItem

type Target = UIBarItem

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for UIBarButtonItem

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

Mutably dereferences the value.

impl Hash for UIBarButtonItem

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 UIBarButtonItem

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 UIBarButtonItem

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 UIBarButtonItem

fn eq(&self, other: &UIBarButtonItem) -> 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 UIBarButtonItem

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

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

impl UIAppearance for UIBarButtonItem

Available on crate feature UIAppearance only.

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

where Self: Sized + ClassType,

unsafe fn appearanceWhenContainedInInstancesOfClasses( container_types: &NSArray<TodoClass>, mtm: MainThreadMarker ) -> Retained<Self>

where Self: Sized + ClassType,

unsafe fn appearanceForTraitCollection( trait: &UITraitCollection, mtm: MainThreadMarker ) -> Retained<Self>

where Self: Sized + ClassType,

Available on crate feature UITraitCollection only.

unsafe fn appearanceForTraitCollection_whenContainedInInstancesOfClasses( trait: &UITraitCollection, container_types: &NSArray<TodoClass>, mtm: MainThreadMarker ) -> Retained<Self>

where Self: Sized + ClassType,

Available on crate feature UITraitCollection only.

impl UIPopoverPresentationControllerSourceItem for UIBarButtonItem

Available on crate feature UIPopoverPresentationControllerSourceItem only.

unsafe fn frameInView(&self, reference_view: &UIView) -> CGRect

where Self: Sized + Message,

Available on crate features UIResponder and UIView only.

impl UISpringLoadedInteractionSupporting for UIBarButtonItem

Available on crate feature UISpringLoadedInteractionSupporting only.

unsafe fn isSpringLoaded(&self) -> bool

where Self: Sized + Message,

unsafe fn setSpringLoaded(&self, spring_loaded: bool)

where Self: Sized + Message,

impl Eq for UIBarButtonItem

impl Message for UIBarButtonItem

impl StructuralPartialEq for UIBarButtonItem