Struct UISearchBar

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

Available on crate features UIResponder and UISearchBar and UIView only.

Apple’s documentation

Implementations

impl UISearchBar

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

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 barStyle(&self) -> UIBarStyle

Available on crate feature UIInterface only.

pub unsafe fn setBarStyle(&self, bar_style: UIBarStyle)

Available on crate feature UIInterface only.

Setter for barStyle.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn UISearchBarDelegate>>>

Available on crate feature UIBarCommon only.

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn UISearchBarDelegate>>, )

Available on crate feature UIBarCommon only.

This is a weak property. Setter for delegate.

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

pub unsafe fn setText(&self, text: Option<&NSString>)

Setter for text.

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

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

Setter for prompt.

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

pub unsafe fn setPlaceholder(&self, placeholder: Option<&NSString>)

Setter for placeholder.

pub unsafe fn showsBookmarkButton(&self) -> bool

pub unsafe fn setShowsBookmarkButton(&self, shows_bookmark_button: bool)

Setter for showsBookmarkButton.

pub unsafe fn searchTextField(&self) -> Retained<UISearchTextField>

Available on crate features UIControl and UISearchTextField and UITextField only.

pub unsafe fn showsCancelButton(&self) -> bool

pub unsafe fn setShowsCancelButton(&self, shows_cancel_button: bool)

Setter for showsCancelButton.

pub unsafe fn showsSearchResultsButton(&self) -> bool

pub unsafe fn setShowsSearchResultsButton( &self, shows_search_results_button: bool, )

Setter for showsSearchResultsButton.

pub unsafe fn isSearchResultsButtonSelected(&self) -> bool

pub unsafe fn setSearchResultsButtonSelected( &self, search_results_button_selected: bool, )

Setter for isSearchResultsButtonSelected.

pub unsafe fn setShowsCancelButton_animated( &self, shows_cancel_button: bool, animated: bool, )

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

Available on crate feature UITextInput only.

Use this method to modify the contents of the Unified Content Bar, shown on top of the keyboard when search is engaged. 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.

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 barTintColor(&self) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

pub unsafe fn setBarTintColor(&self, bar_tint_color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for barTintColor.

pub unsafe fn searchBarStyle(&self) -> UISearchBarStyle

pub unsafe fn setSearchBarStyle(&self, search_bar_style: UISearchBarStyle)

Setter for searchBarStyle.

pub unsafe fn isTranslucent(&self) -> bool

pub unsafe fn setTranslucent(&self, translucent: bool)

Setter for isTranslucent.

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

pub unsafe fn setScopeButtonTitles( &self, scope_button_titles: Option<&NSArray<NSString>>, )

Setter for scopeButtonTitles.

pub unsafe fn selectedScopeButtonIndex(&self) -> NSInteger

pub unsafe fn setSelectedScopeButtonIndex( &self, selected_scope_button_index: NSInteger, )

Setter for selectedScopeButtonIndex.

pub unsafe fn showsScopeBar(&self) -> bool

pub unsafe fn setShowsScopeBar(&self, shows_scope_bar: bool)

Setter for showsScopeBar.

pub unsafe fn setShowsScopeBar_animated(&self, show: bool, animate: bool)

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

pub unsafe fn setInputAccessoryView( &self, input_accessory_view: Option<&UIView>, )

Setter for inputAccessoryView.

pub unsafe fn isEnabled(&self) -> bool

When set to false, user interaction will be prevented and the search bar will take on a disabled appearance If the search bar is associated with a UINavigationItem with UINavigationItemSearchBarPlacementInline, then the minimized (icon-only) UISearchBar will not grow to the text field while enabled is false.

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

Setter for isEnabled.

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

Available on crate feature UIImage only.

pub unsafe fn setBackgroundImage(&self, background_image: Option<&UIImage>)

Available on crate feature UIImage only.

Setter for backgroundImage.

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

Available on crate feature UIImage only.

pub unsafe fn setScopeBarBackgroundImage( &self, scope_bar_background_image: Option<&UIImage>, )

Available on crate feature UIImage only.

Setter for scopeBarBackgroundImage.

pub unsafe fn setBackgroundImage_forBarPosition_barMetrics( &self, background_image: Option<&UIImage>, bar_position: UIBarPosition, bar_metrics: UIBarMetrics, )

Available on crate features UIBarCommon and UIImage only.

pub unsafe fn backgroundImageForBarPosition_barMetrics( &self, bar_position: UIBarPosition, bar_metrics: UIBarMetrics, ) -> Option<Retained<UIImage>>

Available on crate features UIBarCommon and UIImage only.

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

Available on crate features UIControl and UIImage only.

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

Available on crate features UIControl and UIImage only.

pub unsafe fn setImage_forSearchBarIcon_state( &self, icon_image: Option<&UIImage>, icon: UISearchBarIcon, state: UIControlState, )

Available on crate features UIControl and UIImage only.

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

Available on crate features UIControl and UIImage only.

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

Available on crate features UIControl and UIImage only.

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

Available on crate features UIControl and UIImage only.

pub unsafe fn setScopeBarButtonDividerImage_forLeftSegmentState_rightSegmentState( &self, divider_image: Option<&UIImage>, left_state: UIControlState, right_state: UIControlState, )

Available on crate features UIControl and UIImage only.

pub unsafe fn scopeBarButtonDividerImageForLeftSegmentState_rightSegmentState( &self, left_state: UIControlState, right_state: UIControlState, ) -> Option<Retained<UIImage>>

Available on crate features UIControl and UIImage only.

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

Available on crate feature UIControl only.

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

Available on crate feature UIControl only.

pub unsafe fn searchFieldBackgroundPositionAdjustment(&self) -> UIOffset

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

pub unsafe fn setSearchFieldBackgroundPositionAdjustment( &self, search_field_background_position_adjustment: UIOffset, )

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

Setter for searchFieldBackgroundPositionAdjustment.

pub unsafe fn searchTextPositionAdjustment(&self) -> UIOffset

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

pub unsafe fn setSearchTextPositionAdjustment( &self, search_text_position_adjustment: UIOffset, )

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

Setter for searchTextPositionAdjustment.

pub unsafe fn setPositionAdjustment_forSearchBarIcon( &self, adjustment: UIOffset, icon: UISearchBarIcon, )

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

pub unsafe fn positionAdjustmentForSearchBarIcon( &self, icon: UISearchBarIcon, ) -> UIOffset

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

pub unsafe fn isLookToDictateEnabled(&self) -> bool

pub unsafe fn setLookToDictateEnabled(&self, look_to_dictate_enabled: bool)

Setter for isLookToDictateEnabled.

impl UISearchBar

Methods declared on superclass NSObject.

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

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 UISearchBar

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UISearchBar

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIResponder> for UISearchBar

fn as_ref(&self) -> &UIResponder

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

impl AsRef<UISearchBar> for UISearchBar

fn as_ref(&self) -> &Self

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

impl AsRef<UIView> for UISearchBar

fn as_ref(&self) -> &UIView

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

impl Borrow<AnyObject> for UISearchBar

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UISearchBar

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIResponder> for UISearchBar

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIView> for UISearchBar

fn borrow(&self) -> &UIView

Immutably borrows from an owned value.

impl CALayerDelegate for UISearchBar

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 UISearchBar

const NAME: &'static str = "UISearchBar"

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

type Super = UIView

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 UISearchBar

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

Formats the value using the given formatter.

impl Deref for UISearchBar

type Target = UIView

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UISearchBar

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 UISearchBar

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UISearchBar

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 UISearchBar

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 UISearchBar

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 UISearchBar

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

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

impl UIAppearance for UISearchBar

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 UIBarPositioning for UISearchBar

unsafe fn barPosition(&self) -> UIBarPosition

where Self: Sized + Message,

Available on crate feature UIBarCommon only.

impl UICoordinateSpace for UISearchBar

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 UISearchBar

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 UISearchBar

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 UISearchBar

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 UISearchBar

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 UILookToDictateCapable for UISearchBar

unsafe fn isLookToDictateEnabled(&self) -> bool

where Self: Sized + Message,

Enable or disable ‘Look To Dictate’ on the receiver.

unsafe fn setLookToDictateEnabled(&self, look_to_dictate_enabled: bool)

where Self: Sized + Message,

Setter for isLookToDictateEnabled.

impl UIResponderStandardEditActions for UISearchBar

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 UITextInputTraits for UISearchBar

unsafe fn autocapitalizationType(&self) -> UITextAutocapitalizationType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setAutocapitalizationType( &self, autocapitalization_type: UITextAutocapitalizationType, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for autocapitalizationType.

unsafe fn autocorrectionType(&self) -> UITextAutocorrectionType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setAutocorrectionType( &self, autocorrection_type: UITextAutocorrectionType, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for autocorrectionType.

unsafe fn spellCheckingType(&self) -> UITextSpellCheckingType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setSpellCheckingType( &self, spell_checking_type: UITextSpellCheckingType, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for spellCheckingType.

unsafe fn smartQuotesType(&self) -> UITextSmartQuotesType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setSmartQuotesType(&self, smart_quotes_type: UITextSmartQuotesType)

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for smartQuotesType.

unsafe fn smartDashesType(&self) -> UITextSmartDashesType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setSmartDashesType(&self, smart_dashes_type: UITextSmartDashesType)

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for smartDashesType.

unsafe fn smartInsertDeleteType(&self) -> UITextSmartInsertDeleteType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setSmartInsertDeleteType( &self, smart_insert_delete_type: UITextSmartInsertDeleteType, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for smartInsertDeleteType.

unsafe fn inlinePredictionType(&self) -> UITextInlinePredictionType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setInlinePredictionType( &self, inline_prediction_type: UITextInlinePredictionType, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for inlinePredictionType.

unsafe fn mathExpressionCompletionType( &self, ) -> UITextMathExpressionCompletionType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setMathExpressionCompletionType( &self, math_expression_completion_type: UITextMathExpressionCompletionType, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for mathExpressionCompletionType.

unsafe fn keyboardType(&self) -> UIKeyboardType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setKeyboardType(&self, keyboard_type: UIKeyboardType)

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for keyboardType.

unsafe fn keyboardAppearance(&self) -> UIKeyboardAppearance

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setKeyboardAppearance( &self, keyboard_appearance: UIKeyboardAppearance, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for keyboardAppearance.

unsafe fn returnKeyType(&self) -> UIReturnKeyType

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setReturnKeyType(&self, return_key_type: UIReturnKeyType)

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for returnKeyType.

unsafe fn enablesReturnKeyAutomatically(&self) -> bool

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setEnablesReturnKeyAutomatically( &self, enables_return_key_automatically: bool, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for enablesReturnKeyAutomatically.

unsafe fn isSecureTextEntry(&self) -> bool

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setSecureTextEntry(&self, secure_text_entry: bool)

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for isSecureTextEntry.

unsafe fn textContentType(&self) -> Retained<UITextContentType>

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setTextContentType( &self, text_content_type: Option<&UITextContentType>, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for textContentType.

unsafe fn passwordRules(&self) -> Option<Retained<UITextInputPasswordRules>>

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setPasswordRules( &self, password_rules: Option<&UITextInputPasswordRules>, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for passwordRules.

unsafe fn writingToolsBehavior(&self) -> UIWritingToolsBehavior

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setWritingToolsBehavior( &self, writing_tools_behavior: UIWritingToolsBehavior, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for writingToolsBehavior.

unsafe fn allowedWritingToolsResultOptions(&self) -> UIWritingToolsResultOptions

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

unsafe fn setAllowedWritingToolsResultOptions( &self, allowed_writing_tools_result_options: UIWritingToolsResultOptions, )

where Self: Sized + Message,

Available on crate feature UITextInputTraits only.

Setter for allowedWritingToolsResultOptions.

unsafe fn conversationContext(&self) -> Option<Retained<UIConversationContext>>

where Self: Sized + Message,

Available on crate features UITextInputTraits and UIConversationContext only.

A reference to a conversation, such as a mail or messaging thread.

unsafe fn setConversationContext( &self, conversation_context: Option<&UIConversationContext>, )

where Self: Sized + Message,

Available on crate features UITextInputTraits and UIConversationContext only.

Setter for conversationContext.

impl UITraitEnvironment for UISearchBar

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 UISearchBar

impl Eq for UISearchBar

impl UIAppearanceContainer for UISearchBar