Struct UIButton

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

Available on crate features UIButton and UIControl and UIResponder and UIView only.

Apple’s documentation

Implementations

impl UIButton

This impl block contains no items.

UIAccessibilityContentSizeCategoryImageAdjusting.

impl UIButton

UIBehavioralStyle.

pub unsafe fn behavioralStyle(&self) -> UIBehavioralStyle

Available on crate feature UIBehavioralStyle only.

The button’s behavioral style. This property always returns a concrete, resolved style (never UIBehavioralStyleAutomatic).

pub unsafe fn preferredBehavioralStyle(&self) -> UIBehavioralStyle

Available on crate feature UIBehavioralStyle only.

Request a style for the button. If the style changed, the button will redraw and its metrics may change.

pub unsafe fn setPreferredBehavioralStyle( &self, preferred_behavioral_style: UIBehavioralStyle, )

Available on crate feature UIBehavioralStyle only.

Setter for preferredBehavioralStyle.

impl UIButton

pub unsafe fn initWithFrame( this: Allocated<Self>, frame: CGRect, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

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

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

Available on crate features UIAction and UIMenuElement and objc2-core-foundation only.

Initializes a custom button, registers primaryAction for the UIControlEventPrimaryActionTriggered control event, and uses primaryAction’s title & image as the button’s title & image.

pub unsafe fn buttonWithType( button_type: UIButtonType, mtm: MainThreadMarker, ) -> Retained<Self>

pub unsafe fn systemButtonWithImage_target_action( image: &UIImage, target: Option<&AnyObject>, action: Option<Sel>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate feature UIImage only.

pub unsafe fn systemButtonWithPrimaryAction( primary_action: Option<&UIAction>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate features UIAction and UIMenuElement only.

Creates a system button, registers primaryAction for the UIControlEventPrimaryActionTriggered control event, and uses primaryAction’s title & image as the button’s title & image.

pub unsafe fn buttonWithType_primaryAction( button_type: UIButtonType, primary_action: Option<&UIAction>, mtm: MainThreadMarker, ) -> Retained<Self>

Available on crate features UIAction and UIMenuElement only.

Creates a button of the given type, registers primaryAction for the UIControlEventPrimaryActionTriggered control event, and if appropriate uses primaryAction’s title & image as the button’s title & image.

pub unsafe fn buttonWithConfiguration_primaryAction( configuration: &UIButtonConfiguration, primary_action: Option<&UIAction>, ) -> Retained<Self>

Available on crate features UIAction and UIButtonConfiguration and UIMenuElement only.

Construct a new UIButton. configuration will be installed on the created button, and primaryAction added to handle the .primaryActionTriggered control event. If primaryAction has a title or image, they will be copied to configuration

pub unsafe fn configuration(&self) -> Option<Retained<UIButtonConfiguration>>

Available on crate feature UIButtonConfiguration only.

Setting a non-nil value for configuration will opt into configuration-based behavior on UIButton, update the button in a platform specific manner, and enable/disable some API.

pub unsafe fn setConfiguration( &self, configuration: Option<&UIButtonConfiguration>, )

Available on crate feature UIButtonConfiguration only.

Setter for configuration.

pub unsafe fn setNeedsUpdateConfiguration(&self)

Requests the view update its configuration for its current state. This method is called automatically when the button’s state may have changed, as well as in other circumstances where an update may be required. Multiple requests may be coalesced into a single update at the appropriate time.

pub unsafe fn updateConfiguration(&self)

Subclasses should override this method and update the button’s configuration. This method should not be called directly, use setNeedsUpdateConfiguration to request an update.

pub unsafe fn configurationUpdateHandler( &self, ) -> UIButtonConfigurationUpdateHandler

Available on crate feature block2 only.

Block-based equivalent to overriding -updateConfiguration in a subclass. Setting this handler will force the button into configuration-based behavior (see the configuration property). This block is called after -updateConfiguration

pub unsafe fn setConfigurationUpdateHandler( &self, configuration_update_handler: UIButtonConfigurationUpdateHandler, )

Available on crate feature block2 only.

Setter for configurationUpdateHandler.

pub unsafe fn automaticallyUpdatesConfiguration(&self) -> bool

When YES, the button will automatically call -updatedConfigurationForButton: on its configuration when the button’s state changes, and apply the updated configuration to the button. The default value is YES.

pub unsafe fn setAutomaticallyUpdatesConfiguration( &self, automatically_updates_configuration: bool, )

Setter for automaticallyUpdatesConfiguration.

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.

Setter for tintColor.

pub unsafe fn buttonType(&self) -> UIButtonType

pub unsafe fn isHovered(&self) -> bool

If pointer effects are enabled for the button, this will return true when an effect is active.

pub unsafe fn isHeld(&self) -> bool

Returns true while the button is presenting a menu.

pub unsafe fn role(&self) -> UIButtonRole

pub unsafe fn setRole(&self, role: UIButtonRole)

Setter for role.

pub unsafe fn isPointerInteractionEnabled(&self) -> bool

Enables this button’s built-in pointer interaction.

pub unsafe fn setPointerInteractionEnabled( &self, pointer_interaction_enabled: bool, )

Setter for isPointerInteractionEnabled.

pub unsafe fn pointerStyleProvider(&self) -> UIButtonPointerStyleProvider

Available on crate features UIHoverStyle and UIPointerStyle and block2 only.

Called when the system pointer hovers over this button if its pointer interaction is enabled. The system calls this block with a proposed UIPointerEffect and UIPointerShape. You may use them to construct a customized version of the system provided style or return an entirely custom one. Setting this property automatically enables the button’s pointer interaction and sets pointerInteractionEnabledto true.

pub unsafe fn setPointerStyleProvider( &self, pointer_style_provider: UIButtonPointerStyleProvider, )

Available on crate features UIHoverStyle and UIPointerStyle and block2 only.

Setter for pointerStyleProvider.

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

Available on crate features UIMenu and UIMenuElement only.

An optional menu for the button to display. The button will automatically enable or disable its contextMenuInteraction when a non-nil or nil menu is set. Defaults to nil.

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

Available on crate features UIMenu and UIMenuElement only.

Setter for menu.

pub unsafe fn preferredMenuElementOrder( &self, ) -> UIContextMenuConfigurationElementOrder

Available on crate feature UIContextMenuConfiguration only.

Preferred menu element ordering strategy for menus displayed by this button.

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

Available on crate feature UIContextMenuConfiguration only.

Setter for preferredMenuElementOrder.

pub unsafe fn changesSelectionAsPrimaryAction(&self) -> bool

Indicates if the button changes selection as its primary action. This shows the menu as options for selection if a menu is populated and showsMenuAsPrimaryAction is enabled. If no menu is provided or it is not the primary action, UIControlStateSelected is toggled on and off for the primary action.

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

Setter for changesSelectionAsPrimaryAction.

pub unsafe fn setTitle_forState( &self, title: Option<&NSString>, state: UIControlState, )

pub unsafe fn setTitleColor_forState( &self, color: Option<&UIColor>, state: UIControlState, )

Available on crate feature UIColor only.

pub unsafe fn setTitleShadowColor_forState( &self, color: Option<&UIColor>, state: UIControlState, )

Available on crate feature UIColor only.

pub unsafe fn setImage_forState( &self, image: Option<&UIImage>, state: UIControlState, )

Available on crate feature UIImage only.

pub unsafe fn setBackgroundImage_forState( &self, image: Option<&UIImage>, state: UIControlState, )

Available on crate feature UIImage only.

pub unsafe fn setPreferredSymbolConfiguration_forImageInState( &self, configuration: Option<&UIImageSymbolConfiguration>, state: UIControlState, )

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

pub unsafe fn setAttributedTitle_forState( &self, title: Option<&NSAttributedString>, state: UIControlState, )

pub unsafe fn titleForState( &self, state: UIControlState, ) -> Option<Retained<NSString>>

pub unsafe fn titleColorForState( &self, state: UIControlState, ) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

pub unsafe fn titleShadowColorForState( &self, state: UIControlState, ) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

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

Available on crate feature UIImage only.

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

Available on crate feature UIImage only.

pub unsafe fn preferredSymbolConfigurationForImageInState( &self, state: UIControlState, ) -> Option<Retained<UIImageSymbolConfiguration>>

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

pub unsafe fn attributedTitleForState( &self, state: UIControlState, ) -> Option<Retained<NSAttributedString>>

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

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

Available on crate feature UIColor only.

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

Available on crate feature UIColor only.

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

Available on crate feature UIImage only.

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

Available on crate feature UIImage only.

pub unsafe fn currentPreferredSymbolConfiguration( &self, ) -> Option<Retained<UIImageSymbolConfiguration>>

Available on crate features UIImageConfiguration and UIImageSymbolConfiguration only.

pub unsafe fn currentAttributedTitle( &self, ) -> Option<Retained<NSAttributedString>>

pub unsafe fn titleLabel(&self) -> Option<Retained<UILabel>>

Available on crate feature UILabel only.

pub unsafe fn imageView(&self) -> Option<Retained<UIImageView>>

Available on crate feature UIImageView only.

pub unsafe fn subtitleLabel(&self) -> Option<Retained<UILabel>>

Available on crate feature UILabel only.

The label used to display the subtitle, when present.

impl UIButton

Methods declared on superclass NSObject.

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

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

impl UIButton

pub unsafe fn font(&self) -> Retained<UIFont>

👎Deprecated: Specify an attributed title with a custom font

Available on crate feature UIFont only.

pub unsafe fn setFont(&self, font: &UIFont)

👎Deprecated: Specify an attributed title with a custom font

Available on crate feature UIFont only.

Setter for font.

pub unsafe fn lineBreakMode(&self) -> NSLineBreakMode

👎Deprecated: Specify an attributed title with a customized paragraph style

Available on crate feature NSParagraphStyle only.

pub unsafe fn setLineBreakMode(&self, line_break_mode: NSLineBreakMode)

👎Deprecated: Specify an attributed title with a customized paragraph style

Available on crate feature NSParagraphStyle only.

Setter for lineBreakMode.

pub unsafe fn titleShadowOffset(&self) -> CGSize

👎Deprecated: Specify an attributed title with a customized shadow style

Available on crate feature objc2-core-foundation only.

pub unsafe fn setTitleShadowOffset(&self, title_shadow_offset: CGSize)

👎Deprecated: Specify an attributed title with a customized shadow style

Available on crate feature objc2-core-foundation only.

Setter for titleShadowOffset.

pub unsafe fn contentEdgeInsets(&self) -> UIEdgeInsets

👎Deprecated: This property is ignored when using UIButtonConfiguration

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setContentEdgeInsets(&self, content_edge_insets: UIEdgeInsets)

👎Deprecated: This property is ignored when using UIButtonConfiguration

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for contentEdgeInsets.

pub unsafe fn titleEdgeInsets(&self) -> UIEdgeInsets

👎Deprecated: This property is ignored when using UIButtonConfiguration

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setTitleEdgeInsets(&self, title_edge_insets: UIEdgeInsets)

👎Deprecated: This property is ignored when using UIButtonConfiguration

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for titleEdgeInsets.

pub unsafe fn imageEdgeInsets(&self) -> UIEdgeInsets

👎Deprecated: This property is ignored when using UIButtonConfiguration

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setImageEdgeInsets(&self, image_edge_insets: UIEdgeInsets)

👎Deprecated: This property is ignored when using UIButtonConfiguration

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for imageEdgeInsets.

pub unsafe fn reversesTitleShadowWhenHighlighted(&self) -> bool

👎Deprecated: This property is ignored when using UIButtonConfiguration, you may customize to replicate this behavior via a configurationUpdateHandler

pub unsafe fn setReversesTitleShadowWhenHighlighted( &self, reverses_title_shadow_when_highlighted: bool, )

👎Deprecated: This property is ignored when using UIButtonConfiguration, you may customize to replicate this behavior via a configurationUpdateHandler

Setter for reversesTitleShadowWhenHighlighted.

pub unsafe fn adjustsImageWhenHighlighted(&self) -> bool

👎Deprecated: This property is ignored when using UIButtonConfiguration, you may customize to replicate this behavior via a configurationUpdateHandler

pub unsafe fn setAdjustsImageWhenHighlighted( &self, adjusts_image_when_highlighted: bool, )

👎Deprecated: This property is ignored when using UIButtonConfiguration, you may customize to replicate this behavior via a configurationUpdateHandler

Setter for adjustsImageWhenHighlighted.

pub unsafe fn adjustsImageWhenDisabled(&self) -> bool

👎Deprecated: This property is ignored when using UIButtonConfiguration, you may customize to replicate this behavior via a configurationUpdateHandler

pub unsafe fn setAdjustsImageWhenDisabled( &self, adjusts_image_when_disabled: bool, )

👎Deprecated: This property is ignored when using UIButtonConfiguration, you may customize to replicate this behavior via a configurationUpdateHandler

Setter for adjustsImageWhenDisabled.

pub unsafe fn showsTouchWhenHighlighted(&self) -> bool

👎Deprecated: This property is ignored when using UIButtonConfiguration

pub unsafe fn setShowsTouchWhenHighlighted( &self, shows_touch_when_highlighted: bool, )

👎Deprecated: This property is ignored when using UIButtonConfiguration

Setter for showsTouchWhenHighlighted.

pub unsafe fn backgroundRectForBounds(&self, bounds: CGRect) -> CGRect

👎Deprecated: Override layoutSubviews, call super, and position views as you desire.

Available on crate feature objc2-core-foundation only.

pub unsafe fn contentRectForBounds(&self, bounds: CGRect) -> CGRect

👎Deprecated: Override layoutSubviews, call super, and position views as you desire.

Available on crate feature objc2-core-foundation only.

pub unsafe fn titleRectForContentRect(&self, content_rect: CGRect) -> CGRect

👎Deprecated: Override layoutSubviews, call super, and position views as you desire.

Available on crate feature objc2-core-foundation only.

pub unsafe fn imageRectForContentRect(&self, content_rect: CGRect) -> CGRect

👎Deprecated: Override layoutSubviews, call super, and position views as you desire.

Available on crate feature objc2-core-foundation only.

impl UIButton

This impl block contains no items.

SpringLoading.

Methods from Deref<Target = UIControl>

pub unsafe fn isEnabled(&self) -> bool

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

Setter for isEnabled.

pub unsafe fn isSelected(&self) -> bool

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

Setter for isSelected.

pub unsafe fn isHighlighted(&self) -> bool

pub unsafe fn setHighlighted(&self, highlighted: bool)

Setter for isHighlighted.

pub unsafe fn contentVerticalAlignment( &self, ) -> UIControlContentVerticalAlignment

pub unsafe fn setContentVerticalAlignment( &self, content_vertical_alignment: UIControlContentVerticalAlignment, )

Setter for contentVerticalAlignment.

pub unsafe fn contentHorizontalAlignment( &self, ) -> UIControlContentHorizontalAlignment

pub unsafe fn setContentHorizontalAlignment( &self, content_horizontal_alignment: UIControlContentHorizontalAlignment, )

Setter for contentHorizontalAlignment.

pub unsafe fn effectiveContentHorizontalAlignment( &self, ) -> UIControlContentHorizontalAlignment

pub unsafe fn state(&self) -> UIControlState

pub unsafe fn isTracking(&self) -> bool

pub unsafe fn isTouchInside(&self) -> bool

pub unsafe fn beginTrackingWithTouch_withEvent( &self, touch: &UITouch, event: Option<&UIEvent>, ) -> bool

Available on crate features UIEvent and UITouch only.

pub unsafe fn continueTrackingWithTouch_withEvent( &self, touch: &UITouch, event: Option<&UIEvent>, ) -> bool

Available on crate features UIEvent and UITouch only.

pub unsafe fn endTrackingWithTouch_withEvent( &self, touch: Option<&UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn cancelTrackingWithEvent(&self, event: Option<&UIEvent>)

Available on crate feature UIEvent only.

pub unsafe fn addTarget_action_forControlEvents( &self, target: Option<&AnyObject>, action: Sel, control_events: UIControlEvents, )

pub unsafe fn removeTarget_action_forControlEvents( &self, target: Option<&AnyObject>, action: Option<Sel>, control_events: UIControlEvents, )

pub unsafe fn addAction_forControlEvents( &self, action: &UIAction, control_events: UIControlEvents, )

Available on crate features UIAction and UIMenuElement only.

Adds the UIAction to a given event. UIActions are uniqued based on their identifier, and subsequent actions with the same identifier replace previously added actions. You may add multiple UIActions for corresponding controlEvents, and you may add the same action to multiple controlEvents.

pub unsafe fn removeAction_forControlEvents( &self, action: &UIAction, control_events: UIControlEvents, )

Available on crate features UIAction and UIMenuElement only.

Removes the action from the set of passed control events.

pub unsafe fn removeActionForIdentifier_forControlEvents( &self, action_identifier: &UIActionIdentifier, control_events: UIControlEvents, )

Available on crate feature UIAction only.

Removes the action with the provided identifier from the set of passed control events.

pub unsafe fn performPrimaryAction(&self)

Performs the control’s primary action.

pub unsafe fn allTargets(&self) -> Retained<NSSet>

pub unsafe fn allControlEvents(&self) -> UIControlEvents

pub unsafe fn actionsForTarget_forControlEvent( &self, target: Option<&AnyObject>, control_event: UIControlEvents, ) -> Option<Retained<NSArray<NSString>>>

pub unsafe fn enumerateEventHandlers( &self, iterator: &DynBlock<dyn Fn(*mut UIAction, *mut AnyObject, Option<Sel>, UIControlEvents, NonNull<Bool>) + '_>, )

Available on crate features UIAction and UIMenuElement and block2 only.

Iterate over the event handlers installed on this control at the time this method is called. For each call, either actionHandler or action will be non-nil. controlEvents is always non-zero. Setting *stop to YES will terminate the enumeration early. It is legal to manipulate the control’s event handlers within the block.

pub unsafe fn sendAction_to_forEvent( &self, action: Sel, target: Option<&AnyObject>, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

Dispatch the target-action pair. This method is called repeatedly by -sendActionsForControlEvents: and is a point at which you can observe or override behavior.

pub unsafe fn sendAction(&self, action: &UIAction)

Available on crate features UIAction and UIMenuElement only.

Like -sendAction:to:forEvent:, this method is called by -sendActionsForControlEvents:. You may override this method to observe or modify behavior. If you override this method, you should call super precisely once to dispatch the action, or not call super to suppress sending that action.

pub unsafe fn sendActionsForControlEvents( &self, control_events: UIControlEvents, )

send all actions associated with the given control events

pub unsafe fn contextMenuInteraction( &self, ) -> Option<Retained<UIContextMenuInteraction>>

Available on crate feature UIContextMenuInteraction only.

Returns a UIContextMenuInteraction with this control set as its delegate. Before constructing the UIContextMenuInteraction, UIControl verifies ‘self’ is a viable delegate. See ‘Implementing UIControl Menus’ below for more details.

pub unsafe fn isContextMenuInteractionEnabled(&self) -> bool

Specifies if the context menu interaction is enabled. NO by default.

pub unsafe fn setContextMenuInteractionEnabled( &self, context_menu_interaction_enabled: bool, )

Setter for isContextMenuInteractionEnabled.

pub unsafe fn showsMenuAsPrimaryAction(&self) -> bool

If the contextMenuInteraction is the primary action of the control, invoked on touch-down. NO by default.

pub unsafe fn setShowsMenuAsPrimaryAction( &self, shows_menu_as_primary_action: bool, )

Setter for showsMenuAsPrimaryAction.

pub unsafe fn menuAttachmentPointForConfiguration( &self, configuration: &UIContextMenuConfiguration, ) -> CGPoint

Available on crate features UIContextMenuConfiguration and objc2-core-foundation only.

Return a point in this control’s coordinate space to which to attach the given configuration’s menu.

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

Assigning a value to this property causes the tool tip to be displayed for the view. Setting the property to nil cancels the display of the tool tip for the view.

pub unsafe fn setToolTip(&self, tool_tip: Option<&NSString>)

Setter for toolTip.

pub unsafe fn toolTipInteraction( &self, ) -> Option<Retained<UIToolTipInteraction>>

Available on crate feature UIToolTipInteraction only.

Returns the control’s default UIToolTipInteraction.

pub unsafe fn isSymbolAnimationEnabled(&self) -> bool

Whether or not symbol animations are enabled for this control. The default value varies depending on the control.

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

Setter for isSymbolAnimationEnabled.

pub unsafe fn contextMenuInteraction_configurationForMenuAtLocation( &self, interaction: &UIContextMenuInteraction, location: CGPoint, ) -> Option<Retained<UIContextMenuConfiguration>>

Available on crate features UIContextMenuConfiguration and UIContextMenuInteraction and objc2-core-foundation only.

An override is required for UIControl to create a UIContextMenuInteraction. Direct UIControl subclasses do not need to call super.

pub unsafe fn contextMenuInteraction_previewForHighlightingMenuWithConfiguration( &self, interaction: &UIContextMenuInteraction, configuration: &UIContextMenuConfiguration, ) -> Option<Retained<UITargetedPreview>>

Available on crate features UIContextMenuConfiguration and UIContextMenuInteraction and UITargetedPreview only.

Direct UIControl subclasses do not need to call super.

pub unsafe fn contextMenuInteraction_previewForDismissingMenuWithConfiguration( &self, interaction: &UIContextMenuInteraction, configuration: &UIContextMenuConfiguration, ) -> Option<Retained<UITargetedPreview>>

Available on crate features UIContextMenuConfiguration and UIContextMenuInteraction and UITargetedPreview only.

Direct UIControl subclasses do not need to call super.

pub unsafe fn contextMenuInteraction_willDisplayMenuForConfiguration_animator( &self, interaction: &UIContextMenuInteraction, configuration: &UIContextMenuConfiguration, animator: Option<&ProtocolObject<dyn UIContextMenuInteractionAnimating>>, )

Available on crate features UIContextMenuConfiguration and UIContextMenuInteraction only.

UIControl subclasses should always call super.

pub unsafe fn contextMenuInteraction_willEndForConfiguration_animator( &self, interaction: &UIContextMenuInteraction, configuration: &UIContextMenuConfiguration, animator: Option<&ProtocolObject<dyn UIContextMenuInteractionAnimating>>, )

Available on crate features UIContextMenuConfiguration and UIContextMenuInteraction only.

UIControl subclasses should always call super.

pub unsafe fn contextMenuInteraction_willPerformPreviewActionForMenuWithConfiguration_animator( &self, interaction: &UIContextMenuInteraction, configuration: &UIContextMenuConfiguration, animator: &ProtocolObject<dyn UIContextMenuInteractionCommitAnimating>, )

Available on crate features UIContextMenuConfiguration and UIContextMenuInteraction only.

UIControl based menus do not display previews, so this method will not be called even if implemented. UIControl does not have an implementation.

Methods from Deref<Target = UIView>

pub unsafe fn accessibilityIgnoresInvertColors(&self) -> bool

Available on crate feature UIAccessibilityAdditions only.

pub unsafe fn setAccessibilityIgnoresInvertColors( &self, accessibility_ignores_invert_colors: bool, )

Available on crate feature UIAccessibilityAdditions only.

Setter for accessibilityIgnoresInvertColors.

pub unsafe fn hoverStyle(&self) -> Option<Retained<UIHoverStyle>>

Available on crate feature UIHoverStyle only.

The hover style associated with this view. Defaults to nil, indicating that this view should not have any hover effect. Subclasses may configure this style to use a different default value.

pub unsafe fn setHoverStyle(&self, hover_style: Option<&UIHoverStyle>)

Available on crate feature UIHoverStyle only.

Setter for hoverStyle.

pub unsafe fn addInteraction( &self, interaction: &ProtocolObject<dyn UIInteraction>, )

Available on crate feature UIInteraction only.

pub unsafe fn removeInteraction( &self, interaction: &ProtocolObject<dyn UIInteraction>, )

Available on crate feature UIInteraction only.

pub unsafe fn interactions( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIInteraction>>>

Available on crate feature UIInteraction only.

pub unsafe fn setInteractions( &self, interactions: &NSArray<ProtocolObject<dyn UIInteraction>>, )

Available on crate feature UIInteraction only.

Setter for interactions.

pub unsafe fn showsLargeContentViewer(&self) -> bool

Available on crate feature UILargeContentViewer only.

pub unsafe fn setShowsLargeContentViewer( &self, shows_large_content_viewer: bool, )

Available on crate feature UILargeContentViewer only.

Setter for showsLargeContentViewer.

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

Available on crate feature UILargeContentViewer only.

pub unsafe fn setLargeContentTitle( &self, large_content_title: Option<&NSString>, )

Available on crate feature UILargeContentViewer only.

Setter for largeContentTitle.

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

Available on crate features UILargeContentViewer and UIImage only.

pub unsafe fn setLargeContentImage(&self, large_content_image: Option<&UIImage>)

Available on crate features UILargeContentViewer and UIImage only.

Setter for largeContentImage.

pub unsafe fn scalesLargeContentImage(&self) -> bool

Available on crate feature UILargeContentViewer only.

pub unsafe fn setScalesLargeContentImage( &self, scales_large_content_image: bool, )

Available on crate feature UILargeContentViewer only.

Setter for scalesLargeContentImage.

pub unsafe fn largeContentImageInsets(&self) -> UIEdgeInsets

Available on crate features UILargeContentViewer and UIGeometry and objc2-core-foundation only.

pub unsafe fn setLargeContentImageInsets( &self, large_content_image_insets: UIEdgeInsets, )

Available on crate features UILargeContentViewer and UIGeometry and objc2-core-foundation only.

Setter for largeContentImageInsets.

pub unsafe fn viewPrintFormatter(&self) -> Retained<UIViewPrintFormatter>

Available on crate feature UIPrintFormatter only.

pub unsafe fn drawRect_forViewPrintFormatter( &self, rect: CGRect, formatter: &UIViewPrintFormatter, )

Available on crate features UIPrintFormatter and objc2-core-foundation only.

pub unsafe fn endEditing(&self, force: bool) -> bool

Available on crate feature UITextField only.

pub unsafe fn isUserInteractionEnabled(&self) -> bool

pub unsafe fn setUserInteractionEnabled(&self, user_interaction_enabled: bool)

Setter for isUserInteractionEnabled.

pub unsafe fn tag(&self) -> NSInteger

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

Setter for tag.

pub fn layer(&self) -> Retained<CALayer>

Available on crate feature objc2-quartz-core and non-watchOS only.

pub unsafe fn canBecomeFocused(&self) -> bool

pub unsafe fn isFocused(&self) -> bool

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

The identifier of the focus group that this view belongs to. If this is nil, subviews inherit their superview’s focus group.

pub unsafe fn setFocusGroupIdentifier( &self, focus_group_identifier: Option<&NSString>, )

Setter for focusGroupIdentifier.

pub unsafe fn focusGroupPriority(&self) -> UIFocusGroupPriority

Available on crate feature UIFocus only.

The priority this item has in its focus group. The higher the priority, the more likely it is to get picked when focus moves into this group. Note: this method can only be used to increase an item’s priority, not decrease it. For example if an item is currently selected, the actual priority of this item will be determined by MAX(focusGroupPriority, UIFocusGroupPrioritySelected).

pub unsafe fn setFocusGroupPriority( &self, focus_group_priority: UIFocusGroupPriority, )

Available on crate feature UIFocus only.

Setter for focusGroupPriority.

pub unsafe fn focusEffect(&self) -> Option<Retained<UIFocusEffect>>

Available on crate feature UIFocusEffect only.

Describes a visual effect to apply when this item is focused. If this property is nil no effect will be applied when this view becomes focused.

pub unsafe fn setFocusEffect(&self, focus_effect: Option<&UIFocusEffect>)

Available on crate feature UIFocusEffect only.

Setter for focusEffect.

pub unsafe fn semanticContentAttribute(&self) -> UISemanticContentAttribute

pub unsafe fn setSemanticContentAttribute( &self, semantic_content_attribute: UISemanticContentAttribute, )

Setter for semanticContentAttribute.

pub unsafe fn effectiveUserInterfaceLayoutDirection( &self, ) -> UIUserInterfaceLayoutDirection

Available on crate feature UIInterface only.

pub fn frame(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub fn setFrame(&self, frame: CGRect)

Available on crate feature objc2-core-foundation only.

Setter for frame.

pub fn bounds(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub fn setBounds(&self, bounds: CGRect)

Available on crate feature objc2-core-foundation only.

Setter for bounds.

pub unsafe fn center(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub unsafe fn setCenter(&self, center: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for center.

pub unsafe fn transform(&self) -> CGAffineTransform

Available on crate feature objc2-core-foundation only.

pub unsafe fn setTransform(&self, transform: CGAffineTransform)

Available on crate feature objc2-core-foundation only.

Setter for transform.

pub unsafe fn transform3D(&self) -> CATransform3D

Available on crate feature objc2-quartz-core and non-watchOS only.

pub unsafe fn setTransform3D(&self, transform3_d: CATransform3D)

Available on crate feature objc2-quartz-core and non-watchOS only.

Setter for transform3D.

pub fn contentScaleFactor(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setContentScaleFactor(&self, content_scale_factor: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for contentScaleFactor.

pub unsafe fn anchorPoint(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub unsafe fn setAnchorPoint(&self, anchor_point: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for anchorPoint.

pub unsafe fn isMultipleTouchEnabled(&self) -> bool

pub fn setMultipleTouchEnabled(&self, multiple_touch_enabled: bool)

Setter for isMultipleTouchEnabled.

pub unsafe fn isExclusiveTouch(&self) -> bool

pub unsafe fn setExclusiveTouch(&self, exclusive_touch: bool)

Setter for isExclusiveTouch.

pub unsafe fn hitTest_withEvent( &self, point: CGPoint, event: Option<&UIEvent>, ) -> Option<Retained<UIView>>

Available on crate features UIEvent and objc2-core-foundation only.

pub unsafe fn pointInside_withEvent( &self, point: CGPoint, event: Option<&UIEvent>, ) -> bool

Available on crate features UIEvent and objc2-core-foundation only.

pub unsafe fn convertPoint_toView( &self, point: CGPoint, view: Option<&UIView>, ) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub unsafe fn convertPoint_fromView( &self, point: CGPoint, view: Option<&UIView>, ) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub unsafe fn convertRect_toView( &self, rect: CGRect, view: Option<&UIView>, ) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn convertRect_fromView( &self, rect: CGRect, view: Option<&UIView>, ) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn autoresizesSubviews(&self) -> bool

pub unsafe fn setAutoresizesSubviews(&self, autoresizes_subviews: bool)

Setter for autoresizesSubviews.

pub unsafe fn autoresizingMask(&self) -> UIViewAutoresizing

pub unsafe fn setAutoresizingMask(&self, autoresizing_mask: UIViewAutoresizing)

Setter for autoresizingMask.

pub unsafe fn sizeThatFits(&self, size: CGSize) -> CGSize

Available on crate feature objc2-core-foundation only.

pub unsafe fn sizeToFit(&self)

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

pub fn subviews(&self) -> Retained<NSArray<UIView>>

pub fn window(&self) -> Option<Retained<UIWindow>>

Available on crate feature UIWindow only.

pub unsafe fn removeFromSuperview(&self)

pub unsafe fn insertSubview_atIndex(&self, view: &UIView, index: NSInteger)

pub unsafe fn exchangeSubviewAtIndex_withSubviewAtIndex( &self, index1: NSInteger, index2: NSInteger, )

pub unsafe fn addSubview(&self, view: &UIView)

pub unsafe fn insertSubview_belowSubview( &self, view: &UIView, sibling_subview: &UIView, )

pub unsafe fn insertSubview_aboveSubview( &self, view: &UIView, sibling_subview: &UIView, )

pub unsafe fn bringSubviewToFront(&self, view: &UIView)

pub unsafe fn sendSubviewToBack(&self, view: &UIView)

pub unsafe fn didAddSubview(&self, subview: &UIView)

pub unsafe fn willRemoveSubview(&self, subview: &UIView)

pub unsafe fn willMoveToSuperview(&self, new_superview: Option<&UIView>)

pub unsafe fn didMoveToSuperview(&self)

pub unsafe fn willMoveToWindow(&self, new_window: Option<&UIWindow>)

Available on crate feature UIWindow only.

pub unsafe fn didMoveToWindow(&self)

pub unsafe fn isDescendantOfView(&self, view: &UIView) -> bool

pub unsafe fn viewWithTag(&self, tag: NSInteger) -> Option<Retained<UIView>>

pub unsafe fn setNeedsLayout(&self)

pub unsafe fn layoutIfNeeded(&self)

pub unsafe fn layoutSubviews(&self)

pub unsafe fn layoutMargins(&self) -> UIEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setLayoutMargins(&self, layout_margins: UIEdgeInsets)

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for layoutMargins.

pub unsafe fn directionalLayoutMargins(&self) -> NSDirectionalEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn setDirectionalLayoutMargins( &self, directional_layout_margins: NSDirectionalEdgeInsets, )

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for directionalLayoutMargins.

pub unsafe fn preservesSuperviewLayoutMargins(&self) -> bool

pub unsafe fn setPreservesSuperviewLayoutMargins( &self, preserves_superview_layout_margins: bool, )

Setter for preservesSuperviewLayoutMargins.

pub unsafe fn insetsLayoutMarginsFromSafeArea(&self) -> bool

pub unsafe fn setInsetsLayoutMarginsFromSafeArea( &self, insets_layout_margins_from_safe_area: bool, )

Setter for insetsLayoutMarginsFromSafeArea.

pub unsafe fn layoutMarginsDidChange(&self)

pub fn safeAreaInsets(&self) -> UIEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn safeAreaInsetsDidChange(&self)

pub unsafe fn layoutMarginsGuide(&self) -> Retained<UILayoutGuide>

Available on crate feature UILayoutGuide only.

pub unsafe fn readableContentGuide(&self) -> Retained<UILayoutGuide>

Available on crate feature UILayoutGuide only.

This content guide provides a layout area that you can use to place text and related content whose width should generally be constrained to a size that is easy for the user to read. This guide provides a centered region that you can place content within to get this behavior for this view.

pub unsafe fn safeAreaLayoutGuide(&self) -> Retained<UILayoutGuide>

Available on crate feature UILayoutGuide only.

pub unsafe fn keyboardLayoutGuide(&self) -> Retained<UIKeyboardLayoutGuide>

Available on crate features UIKeyboardLayoutGuide and UILayoutGuide and UITrackingLayoutGuide only.

Follows the keyboard when on screen and docked. See UIKeyboardLayoutGuide.h for additional options.

pub unsafe fn drawRect(&self, rect: CGRect)

Available on crate feature objc2-core-foundation only.

pub fn setNeedsDisplay(&self)

pub unsafe fn setNeedsDisplayInRect(&self, rect: CGRect)

Available on crate feature objc2-core-foundation only.

pub unsafe fn clipsToBounds(&self) -> bool

pub unsafe fn setClipsToBounds(&self, clips_to_bounds: bool)

Setter for clipsToBounds.

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

Available on crate feature UIColor only.

pub fn setBackgroundColor(&self, background_color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for backgroundColor.

pub unsafe fn alpha(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setAlpha(&self, alpha: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for alpha.

pub unsafe fn isOpaque(&self) -> bool

pub unsafe fn setOpaque(&self, opaque: bool)

Setter for isOpaque.

pub unsafe fn clearsContextBeforeDrawing(&self) -> bool

pub unsafe fn setClearsContextBeforeDrawing( &self, clears_context_before_drawing: bool, )

Setter for clearsContextBeforeDrawing.

pub fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

pub unsafe fn contentMode(&self) -> UIViewContentMode

pub unsafe fn setContentMode(&self, content_mode: UIViewContentMode)

Setter for contentMode.

pub unsafe fn contentStretch(&self) -> CGRect

👎Deprecated

Available on crate feature objc2-core-foundation only.

pub unsafe fn setContentStretch(&self, content_stretch: CGRect)

👎Deprecated

Available on crate feature objc2-core-foundation only.

Setter for contentStretch.

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

pub unsafe fn setMaskView(&self, mask_view: Option<&UIView>)

Setter for maskView.

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.

Setter for tintColor.

pub unsafe fn tintAdjustmentMode(&self) -> UIViewTintAdjustmentMode

pub unsafe fn setTintAdjustmentMode( &self, tint_adjustment_mode: UIViewTintAdjustmentMode, )

Setter for tintAdjustmentMode.

pub unsafe fn tintColorDidChange(&self)

pub fn gestureRecognizers( &self, ) -> Option<Retained<NSArray<UIGestureRecognizer>>>

Available on crate feature UIGestureRecognizer only.

pub unsafe fn setGestureRecognizers( &self, gesture_recognizers: Option<&NSArray<UIGestureRecognizer>>, )

Available on crate feature UIGestureRecognizer only.

Setter for gestureRecognizers.

pub fn addGestureRecognizer(&self, gesture_recognizer: &UIGestureRecognizer)

Available on crate feature UIGestureRecognizer only.

pub fn removeGestureRecognizer(&self, gesture_recognizer: &UIGestureRecognizer)

Available on crate feature UIGestureRecognizer only.

pub fn gestureRecognizerShouldBegin( &self, gesture_recognizer: &UIGestureRecognizer, ) -> bool

Available on crate feature UIGestureRecognizer only.

pub unsafe fn addMotionEffect(&self, effect: &UIMotionEffect)

Available on crate feature UIMotionEffect only.

Begins applying effect to the receiver. The effect’s emitted keyPath/value pairs will be applied to the view’s presentation layer.

Animates the transition to the motion effect’s values using the present UIView animation context.

pub unsafe fn removeMotionEffect(&self, effect: &UIMotionEffect)

Available on crate feature UIMotionEffect only.

Stops applying effect to the receiver. Any affected presentation values will animate to their post-removal values using the present UIView animation context.

pub unsafe fn motionEffects(&self) -> Retained<NSArray<UIMotionEffect>>

Available on crate feature UIMotionEffect only.

pub unsafe fn setMotionEffects(&self, motion_effects: &NSArray<UIMotionEffect>)

Available on crate feature UIMotionEffect only.

Setter for motionEffects.

pub unsafe fn constraints(&self) -> Retained<NSArray<NSLayoutConstraint>>

Available on crate feature NSLayoutConstraint only.

pub unsafe fn addConstraint(&self, constraint: &NSLayoutConstraint)

Available on crate feature NSLayoutConstraint only.

pub unsafe fn addConstraints(&self, constraints: &NSArray<NSLayoutConstraint>)

Available on crate feature NSLayoutConstraint only.

pub unsafe fn removeConstraint(&self, constraint: &NSLayoutConstraint)

Available on crate feature NSLayoutConstraint only.

pub unsafe fn removeConstraints( &self, constraints: &NSArray<NSLayoutConstraint>, )

Available on crate feature NSLayoutConstraint only.

pub unsafe fn updateConstraintsIfNeeded(&self)

pub unsafe fn updateConstraints(&self)

pub unsafe fn needsUpdateConstraints(&self) -> bool

pub unsafe fn setNeedsUpdateConstraints(&self)

pub unsafe fn translatesAutoresizingMaskIntoConstraints(&self) -> bool

pub unsafe fn setTranslatesAutoresizingMaskIntoConstraints( &self, translates_autoresizing_mask_into_constraints: bool, )

Setter for translatesAutoresizingMaskIntoConstraints.

pub unsafe fn alignmentRectForFrame(&self, frame: CGRect) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn frameForAlignmentRect(&self, alignment_rect: CGRect) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn alignmentRectInsets(&self) -> UIEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.

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

👎Deprecated: Override -viewForFirstBaselineLayout or -viewForLastBaselineLayout as appropriate, instead

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

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

pub unsafe fn intrinsicContentSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

pub unsafe fn invalidateIntrinsicContentSize(&self)

pub unsafe fn contentHuggingPriorityForAxis( &self, axis: UILayoutConstraintAxis, ) -> UILayoutPriority

Available on crate feature NSLayoutConstraint only.

pub unsafe fn setContentHuggingPriority_forAxis( &self, priority: UILayoutPriority, axis: UILayoutConstraintAxis, )

Available on crate feature NSLayoutConstraint only.

pub unsafe fn contentCompressionResistancePriorityForAxis( &self, axis: UILayoutConstraintAxis, ) -> UILayoutPriority

Available on crate feature NSLayoutConstraint only.

pub unsafe fn setContentCompressionResistancePriority_forAxis( &self, priority: UILayoutPriority, axis: UILayoutConstraintAxis, )

Available on crate feature NSLayoutConstraint only.

pub unsafe fn systemLayoutSizeFittingSize(&self, target_size: CGSize) -> CGSize

Available on crate feature objc2-core-foundation only.

pub unsafe fn systemLayoutSizeFittingSize_withHorizontalFittingPriority_verticalFittingPriority( &self, target_size: CGSize, horizontal_fitting_priority: UILayoutPriority, vertical_fitting_priority: UILayoutPriority, ) -> CGSize

Available on crate features NSLayoutConstraint and objc2-core-foundation only.

pub unsafe fn layoutGuides(&self) -> Retained<NSArray<UILayoutGuide>>

Available on crate feature UILayoutGuide only.

pub unsafe fn addLayoutGuide(&self, layout_guide: &UILayoutGuide)

Available on crate feature UILayoutGuide only.

pub unsafe fn removeLayoutGuide(&self, layout_guide: &UILayoutGuide)

Available on crate feature UILayoutGuide only.

pub unsafe fn leadingAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn trailingAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn leftAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn rightAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn topAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn bottomAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn widthAnchor(&self) -> Retained<NSLayoutDimension>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn heightAnchor(&self) -> Retained<NSLayoutDimension>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn centerXAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn centerYAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn firstBaselineAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn lastBaselineAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

Available on crate feature NSLayoutAnchor only.

pub unsafe fn constraintsAffectingLayoutForAxis( &self, axis: UILayoutConstraintAxis, ) -> Retained<NSArray<NSLayoutConstraint>>

Available on crate feature NSLayoutConstraint only.

pub unsafe fn hasAmbiguousLayout(&self) -> bool

pub unsafe fn exerciseAmbiguityInLayout(&self)

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

pub unsafe fn setRestorationIdentifier( &self, restoration_identifier: Option<&NSString>, )

Setter for restorationIdentifier.

pub unsafe fn encodeRestorableStateWithCoder(&self, coder: &NSCoder)

pub unsafe fn decodeRestorableStateWithCoder(&self, coder: &NSCoder)

pub unsafe fn snapshotViewAfterScreenUpdates( &self, after_updates: bool, ) -> Option<Retained<UIView>>

pub unsafe fn resizableSnapshotViewFromRect_afterScreenUpdates_withCapInsets( &self, rect: CGRect, after_updates: bool, cap_insets: UIEdgeInsets, ) -> Option<Retained<UIView>>

Available on crate features UIGeometry and objc2-core-foundation only.

pub unsafe fn drawViewHierarchyInRect_afterScreenUpdates( &self, rect: CGRect, after_updates: bool, ) -> bool

Available on crate feature objc2-core-foundation only.

pub unsafe fn overrideUserInterfaceStyle(&self) -> UIUserInterfaceStyle

Available on crate feature UIInterface only.

pub unsafe fn setOverrideUserInterfaceStyle( &self, override_user_interface_style: UIUserInterfaceStyle, )

Available on crate feature UIInterface only.

Setter for overrideUserInterfaceStyle.

pub unsafe fn minimumContentSizeCategory( &self, ) -> Option<Retained<UIContentSizeCategory>>

Available on crate feature UIContentSizeCategory only.

Specify content size category limits. Setting one or both of these properties will limit the content size category for this view (and its subviews) to a minimum or a maximum value. You can use this to limit the support content size categories on part of your view hierarchy. Setting this to nil removes the limit on the minimum or maximum. Limits will be applied immediately and when future content size category updates occur.

Specifying a minimum limit that is greater than the maximum limit (or vice versa) will effectively only use the maximum limit.

Example:

// limit the support content size categories between .medium and .accessibilityExtraLarge (included). view.minimumContentSizeCategory = UIContentSizeCategoryMedium; view.maximumContentSizeCategory = UIContentSizeCategoryAccessibilityExtraLarge;

pub unsafe fn setMinimumContentSizeCategory( &self, minimum_content_size_category: Option<&UIContentSizeCategory>, )

Available on crate feature UIContentSizeCategory only.

Setter for minimumContentSizeCategory.

pub unsafe fn maximumContentSizeCategory( &self, ) -> Option<Retained<UIContentSizeCategory>>

Available on crate feature UIContentSizeCategory only.

pub unsafe fn setMaximumContentSizeCategory( &self, maximum_content_size_category: Option<&UIContentSizeCategory>, )

Available on crate feature UIContentSizeCategory only.

Setter for maximumContentSizeCategory.

pub unsafe fn appliedContentSizeCategoryLimitsDescription( &self, ) -> Retained<NSString>

Will return a string with a log of all the superviews of this view, alongside with what content size category each view has and if that view has limits applied. This is for debugging purposes only.

pub unsafe fn traitOverrides( &self, ) -> Retained<ProtocolObject<dyn UITraitOverrides>>

Available on crate feature UITraitCollection only.

pub unsafe fn updateTraitsIfNeeded(&self)

Forces an immediate trait update for this view (and its view controller, if applicable) and any subviews, including any view controllers or views in its subtree. Any trait change callbacks are sent synchronously.

Methods from Deref<Target = UIResponder>

pub unsafe fn nextResponder(&self) -> Option<Retained<UIResponder>>

pub unsafe fn canBecomeFirstResponder(&self) -> bool

pub unsafe fn becomeFirstResponder(&self) -> bool

pub unsafe fn canResignFirstResponder(&self) -> bool

pub unsafe fn resignFirstResponder(&self) -> bool

pub unsafe fn isFirstResponder(&self) -> bool

pub unsafe fn touchesBegan_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn touchesMoved_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn touchesEnded_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn touchesCancelled_withEvent( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, )

Available on crate features UIEvent and UITouch only.

pub unsafe fn touchesEstimatedPropertiesUpdated(&self, touches: &NSSet<UITouch>)

Available on crate feature UITouch only.

pub unsafe fn pressesBegan_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesChanged_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesEnded_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn pressesCancelled_withEvent( &self, presses: &NSSet<UIPress>, event: Option<&UIPressesEvent>, )

Available on crate features UIEvent and UIPress and UIPressesEvent only.

pub unsafe fn motionBegan_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub unsafe fn motionEnded_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub unsafe fn motionCancelled_withEvent( &self, motion: UIEventSubtype, event: Option<&UIEvent>, )

Available on crate feature UIEvent only.

pub unsafe fn remoteControlReceivedWithEvent(&self, event: Option<&UIEvent>)

Available on crate feature UIEvent only.

pub unsafe fn canPerformAction_withSender( &self, action: Sel, sender: Option<&AnyObject>, ) -> bool

pub unsafe fn targetForAction_withSender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

pub unsafe fn buildMenuWithBuilder( &self, builder: &ProtocolObject<dyn UIMenuBuilder>, )

Available on crate feature UIMenuBuilder only.

pub unsafe fn validateCommand(&self, command: &UICommand)

Available on crate features UICommand and UIMenuElement only.

pub unsafe fn undoManager(&self) -> Option<Retained<NSUndoManager>>

pub unsafe fn editingInteractionConfiguration( &self, ) -> UIEditingInteractionConfiguration

pub unsafe fn keyCommands(&self) -> Option<Retained<NSArray<UIKeyCommand>>>

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

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

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

pub unsafe fn inputAssistantItem(&self) -> Retained<UITextInputAssistantItem>

Available on crate feature UITextInput only.

This method is for clients that wish to put buttons on the Shortcuts Bar, shown on top of the keyboard. You may modify the returned inputAssistantItem to add to or replace the existing items on the bar. Modifications made to the returned UITextInputAssistantItem are reflected automatically. This method should not be overridden. Goes up the responder chain.

pub unsafe fn inputViewController( &self, ) -> Option<Retained<UIInputViewController>>

Available on crate features UIInputViewController and UIViewController only.

pub unsafe fn inputAccessoryViewController( &self, ) -> Option<Retained<UIInputViewController>>

Available on crate features UIInputViewController and UIViewController only.

pub unsafe fn textInputMode(&self) -> Option<Retained<UITextInputMode>>

Available on crate feature UITextInput only.

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

pub unsafe fn reloadInputViews(&self)

pub unsafe fn userActivity(&self) -> Option<Retained<NSUserActivity>>

pub unsafe fn setUserActivity(&self, user_activity: Option<&NSUserActivity>)

Setter for userActivity.

pub unsafe fn updateUserActivityState(&self, activity: &NSUserActivity)

pub unsafe fn restoreUserActivityState(&self, activity: &NSUserActivity)

pub unsafe fn captureTextFromCamera(&self, sender: Option<&AnyObject>)

pub unsafe fn activityItemsConfiguration( &self, ) -> Option<Retained<ProtocolObject<dyn UIActivityItemsConfigurationReading>>>

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

pub unsafe fn setActivityItemsConfiguration( &self, activity_items_configuration: Option<&ProtocolObject<dyn UIActivityItemsConfigurationReading>>, )

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

Setter for activityItemsConfiguration.

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.

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());

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

Trait Implementations

impl AsRef<AnyObject> for UIButton

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIButton

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIButton> for UIButton

fn as_ref(&self) -> &Self

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

impl AsRef<UIControl> for UIButton

fn as_ref(&self) -> &UIControl

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

impl AsRef<UIResponder> for UIButton

fn as_ref(&self) -> &UIResponder

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

impl AsRef<UIView> for UIButton

fn as_ref(&self) -> &UIView

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

impl Borrow<AnyObject> for UIButton

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIButton

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIControl> for UIButton

fn borrow(&self) -> &UIControl

Immutably borrows from an owned value.

impl Borrow<UIResponder> for UIButton

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIView> for UIButton

fn borrow(&self) -> &UIView

Immutably borrows from an owned value.

impl CALayerDelegate for UIButton

unsafe fn displayLayer(&self, layer: &CALayer)

where Self: Sized + Message,

unsafe fn layerWillDraw(&self, layer: &CALayer)

where Self: Sized + Message,

unsafe fn layoutSublayersOfLayer(&self, layer: &CALayer)

where Self: Sized + Message,

unsafe fn actionForLayer_forKey( &self, layer: &CALayer, event: &NSString, ) -> Option<Retained<ProtocolObject<dyn CAAction>>>

where Self: Sized + Message,

impl ClassType for UIButton

const NAME: &'static str = "UIButton"

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

type Super = UIControl

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread.

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.

impl Debug for UIButton

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

Formats the value using the given formatter.

impl Deref for UIButton

type Target = UIControl

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIButton

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 Message for UIButton

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIButton

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for UIButton

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

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

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 UIButton

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RefEncode for UIButton

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

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

impl UIAccessibilityContentSizeCategoryImageAdjusting for UIButton

Available on crate feature UIAccessibilityContentSizeCategoryImageAdjusting only.

unsafe fn adjustsImageSizeForAccessibilityContentSizeCategory(&self) -> bool

where Self: Sized + Message,

unsafe fn setAdjustsImageSizeForAccessibilityContentSizeCategory( &self, adjusts_image_size_for_accessibility_content_size_category: bool, )

where Self: Sized + Message,

Setter for adjustsImageSizeForAccessibilityContentSizeCategory.

impl UIAppearance for UIButton

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

where Self: Sized + ClassType,

Available on crate feature UIAppearance only.

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

where Self: Sized + ClassType,

Available on crate feature UIAppearance only.

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

where Self: Sized + ClassType,

Available on crate features UIAppearance and UITraitCollection only.

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

where Self: Sized + ClassType,

Available on crate features UIAppearance and UITraitCollection only.

impl UICoordinateSpace for UIButton

fn convertPoint_toCoordinateSpace( &self, point: CGPoint, coordinate_space: &ProtocolObject<dyn UICoordinateSpace>, ) -> CGPoint

where Self: Sized + Message,

Available on crate features UIView and objc2-core-foundation only.

fn convertPoint_fromCoordinateSpace( &self, point: CGPoint, coordinate_space: &ProtocolObject<dyn UICoordinateSpace>, ) -> CGPoint

where Self: Sized + Message,

Available on crate features UIView and objc2-core-foundation only.

fn convertRect_toCoordinateSpace( &self, rect: CGRect, coordinate_space: &ProtocolObject<dyn UICoordinateSpace>, ) -> CGRect

where Self: Sized + Message,

Available on crate features UIView and objc2-core-foundation only.

fn convertRect_fromCoordinateSpace( &self, rect: CGRect, coordinate_space: &ProtocolObject<dyn UICoordinateSpace>, ) -> CGRect

where Self: Sized + Message,

Available on crate features UIView and objc2-core-foundation only.

fn bounds(&self) -> CGRect

where Self: Sized + Message,

Available on crate features UIView and objc2-core-foundation only.

impl UIDynamicItem for UIButton

unsafe fn center(&self) -> CGPoint

where Self: Sized + Message,

Available on crate features UIDynamicBehavior and objc2-core-foundation only.

unsafe fn setCenter(&self, center: CGPoint)

where Self: Sized + Message,

Available on crate features UIDynamicBehavior and objc2-core-foundation only.

Setter for center.

unsafe fn bounds(&self) -> CGRect

where Self: Sized + Message,

Available on crate features UIDynamicBehavior and objc2-core-foundation only.

unsafe fn transform(&self) -> CGAffineTransform

where Self: Sized + Message,

Available on crate features UIDynamicBehavior and objc2-core-foundation only.

unsafe fn setTransform(&self, transform: CGAffineTransform)

where Self: Sized + Message,

Available on crate features UIDynamicBehavior and objc2-core-foundation only.

Setter for transform.

unsafe fn collisionBoundsType(&self) -> UIDynamicItemCollisionBoundsType

where Self: Sized + Message,

Available on crate feature UIDynamicBehavior only.

The collision type represents how the dynamics system will evaluate collisions with respect to the dynamic item. defaults to UIDynamicItemCollisionBoundsTypeRectangle

unsafe fn collisionBoundingPath(&self) -> Retained<UIBezierPath>

where Self: Sized + Message,

Available on crate features UIDynamicBehavior and UIBezierPath only.

The path must represent a convex polygon with counter clockwise winding and no self intersection. The point (0,0) in the path corresponds to the dynamic item’s center.

impl UIFocusEnvironment for UIButton

unsafe fn preferredFocusEnvironments( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIFocusEnvironment>>>

where Self: Sized + Message,

Available on crate feature UIFocus only.

The preferred focus environments define where to search for the default focused item in an environment, such as when focus updates programmatically. Starting from the target environment, each preferred focus environment is recursively searched in the order of the array until an eligible, focusable item is found. Preferred focus environments can include focusable and non-focusable items, in addition to non-item environments. Returning an empty array is equivalent to returning an array containing only ‘self’.

unsafe fn parentFocusEnvironment( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusEnvironment>>>

where Self: Sized + Message,

Available on crate feature UIFocus only.

The parent focus environment of this environment, or nil if no parent exists. NOTE: If you implement this method, you must return a non-nil value for parent focus environment, otherwise your focus environment will not participate in focus interactions.

unsafe fn focusItemContainer( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusItemContainer>>>

where Self: Sized + Message,

Available on crate feature UIFocus only.

The container of any child focus items in this focus environment, or nil if no container exists.

unsafe fn setNeedsFocusUpdate(&self)

where Self: Sized + Message,

Available on crate feature UIFocus only.

Marks this environment as needing a focus update, which if accepted will attempt to reset focus to this environment, or one of its preferred focus environments, on the next update cycle. If this environment does not currently contain the focused item, then calling this method has no effect. If a parent of this environment is also requesting focus, then this environment’s request is rejected in favor of the parent’s. NOTE: If you provide your own implementation, it must call [[UIFocusSystem focusSystemForEnvironment:self] requestFocusUpdateToEnvironment:self];

unsafe fn updateFocusIfNeeded(&self)

where Self: Sized + Message,

Available on crate feature UIFocus only.

Forces focus to be updated immediately. If there is an environment that has requested a focus update via -setNeedsFocusUpdate, and the request was accepted, then focus will be updated to that environment or one of its preferred focus environments. NOTE: If you provide your own implementation, it must call [[UIFocusSystem focusSystemForEnvironment:self] updateFocusIfNeeded];.

unsafe fn shouldUpdateFocusInContext( &self, context: &UIFocusUpdateContext, ) -> bool

where Self: Sized + Message,

Available on crate feature UIFocus only.

Asks whether the system should allow a focus update to occur.

unsafe fn didUpdateFocusInContext_withAnimationCoordinator( &self, context: &UIFocusUpdateContext, coordinator: &UIFocusAnimationCoordinator, )

where Self: Sized + Message,

Available on crate features UIFocus and UIFocusAnimationCoordinator only.

Called when the screen’s focused item has been updated to a new item. Use the animation coordinator to schedule focus-related animations in response to the update.

unsafe fn soundIdentifierForFocusUpdateInContext( &self, context: &UIFocusUpdateContext, ) -> Option<Retained<UIFocusSoundIdentifier>>

where Self: Sized + Message,

Available on crate feature UIFocus only.

Specifies an identifier corresponding to a sound that should be played for a focus update. Return UIFocusSoundIdentifierNone to opt out of sounds, UIFocusSoundIdentifierDefault for the system default sounds, a previously registered identifier for a custom sound, or nil to defer the decision to the parent.

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

where Self: Sized + Message,

👎Deprecated

Available on crate features UIResponder and UIView and UIFocus only.

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

where Self: Sized + Message,

Available on crate feature UIFocus only.

The identifier of the focus group that this view belongs to. If this is nil, subviews inherit their superview’s focus group.

impl UIFocusItem for UIButton

unsafe fn canBecomeFocused(&self) -> bool

where Self: Sized + Message,

Available on crate feature UIFocus only.

Indicates whether or not this item is currently allowed to become focused. Returning NO restricts the item from being focusable, even if it is visible in the user interface. For example, UIControls return NO if they are disabled.

unsafe fn frame(&self) -> CGRect

where Self: Sized + Message,

Available on crate features UIFocus and objc2-core-foundation only.

The geometric frame of this item, represented in the coordinateSpace of the UIFocusItemContainer in which it is contained.

unsafe fn focusEffect(&self) -> Option<Retained<UIFocusEffect>>

where Self: Sized + Message,

Available on crate features UIFocus and UIFocusEffect only.

Describes a visual effect to apply when this item is focused. When not implemented, the system may create a default effect for this item. Returning nil indicates that the system should not apply any visual effects, and that the app will handle applying the appropriate visuals.

unsafe fn focusGroupPriority(&self) -> UIFocusGroupPriority

where Self: Sized + Message,

Available on crate feature UIFocus only.

The priority this item has in its focus group. The higher the priority, the more likely it is to get picked when focus moves into this group. Note: this method can only be used to increase an item’s priority, not decrease it. For example if an item is currently selected, the actual priority of this item will be determined by MAX(focusGroupPriority, UIFocusGroupPrioritySelected).

unsafe fn focusItemDeferralMode(&self) -> UIFocusItemDeferralMode

where Self: Sized + Message,

Available on crate feature UIFocus only.

If this property is present and returns UIFocusItemDeferralModeNever, the focus deferral will not be enabled again after the user engagement timeout has expired if this item is currently focused and programmatic focus updates pointing to this item will be executed immediatly. If it returns UIFocusItemDeferralModeAlways focus will always be deferred when this item is supposed to be focused. Does nothing when focus deferral is not supported on the platform.

unsafe fn isTransparentFocusItem(&self) -> bool

where Self: Sized + Message,

Available on crate feature UIFocus only.

If this returns YES, the focus item is considered transparent in terms of occlusion. Items that are behind it are focusable. This value is ignored when the item is focusable, in which case the item is never considered transparent.

unsafe fn didHintFocusMovement(&self, hint: &UIFocusMovementHint)

where Self: Sized + Message,

Available on crate features UIFocus and UIFocusMovementHint only.

Called whenever this focus item is hinting to the user a focus movement might occur. The provided object is mutated by the focus engine whenever the user’s finger moves.

impl UIFocusItemContainer for UIButton

unsafe fn coordinateSpace( &self, ) -> Retained<ProtocolObject<dyn UICoordinateSpace>>

where Self: Sized + Message,

Available on crate features UIFocus and UIView only.

The coordinate space of the focus items contained in this container. The focus items returned by focusItemsInRect: should report their frames in this coordinate space. If you are implementing this protocol, you may find it convenient to return the UIScreen as your coordinate space, and ensure that your contained items report their frames in screen space. Similarly, you might find that your focus items’ containing UIView or UIWindow is the most convenient coordinate space to use. You may also choose to implement your own object that conforms to UICoordinateSpace, if that is the most natural solution for your architecture.

unsafe fn focusItemsInRect( &self, rect: CGRect, ) -> Retained<NSArray<ProtocolObject<dyn UIFocusItem>>>

where Self: Sized + Message,

Available on crate features UIFocus and objc2-core-foundation only.

Returns an array of all focus items within this container that intersect with the provided rect. rect is expressed in coordinateSpace. Note: starting in iOS & tvOS 16.0, UIView will return its subviews from this method. If you override this method in a UIView subclass, it will be your responsibility to call super and merge your array of custom focus items with UIView’s default focus items.

impl UIResponderStandardEditActions for UIButton

unsafe fn cut(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn copy(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn paste(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn pasteAndMatchStyle(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn pasteAndGo(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn pasteAndSearch(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn select(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn selectAll(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn delete(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn makeTextWritingDirectionLeftToRight(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn makeTextWritingDirectionRightToLeft(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn toggleBoldface(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn toggleItalics(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn toggleUnderline(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn increaseSize(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn decreaseSize(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn find(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn findAndReplace(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn findNext(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn findPrevious(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn useSelectionForFind(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn updateTextAttributesWithConversionHandler( &self, conversion_handler: UITextAttributesConversionHandler, )

where Self: Sized + Message,

Available on crate features UIResponder and block2 only.

unsafe fn print(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn rename(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn duplicate(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn move(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn export(&self, sender: Option<&AnyObject>)

where Self: Sized + Message,

Available on crate feature UIResponder only.

unsafe fn showWritingTools(&self, sender: &AnyObject)

where Self: Sized + Message,

Available on crate feature UIResponder only.

impl UISpringLoadedInteractionSupporting for UIButton

unsafe fn isSpringLoaded(&self) -> bool

where Self: Sized + Message,

Available on crate feature UISpringLoadedInteractionSupporting only.

unsafe fn setSpringLoaded(&self, spring_loaded: bool)

where Self: Sized + Message,

Available on crate feature UISpringLoadedInteractionSupporting only.

Setter for isSpringLoaded.

impl UITraitEnvironment for UIButton

fn traitCollection(&self) -> Retained<UITraitCollection>

where Self: Sized + Message,

Available on crate feature UITraitCollection only.

unsafe fn traitCollectionDidChange( &self, previous_trait_collection: Option<&UITraitCollection>, )

where Self: Sized + Message,

👎Deprecated: Use the trait change registration APIs declared in the UITraitChangeObservable protocol

Available on crate feature UITraitCollection only.

To be overridden as needed to provide custom behavior when the environment’s traits change.

impl DowncastTarget for UIButton

impl Eq for UIButton

impl UIAppearanceContainer for UIButton