Struct UICollectionView 

pub struct UICollectionView { /* private fields */ }

Available on crate features UICollectionView and UIResponder and UIScrollView and UIView only.

Apple’s documentation

Implementations

impl UICollectionView

pub fn initWithFrame_collectionViewLayout( this: Allocated<Self>, frame: CGRect, layout: &UICollectionViewLayout, ) -> Retained<Self>

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

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

Safety

coder possibly has further requirements.

pub fn collectionViewLayout(&self) -> Retained<UICollectionViewLayout>

Available on crate feature UICollectionViewLayout only.

pub fn setCollectionViewLayout( &self, collection_view_layout: &UICollectionViewLayout, )

Available on crate feature UICollectionViewLayout only.

Setter for collectionViewLayout.

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

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

Setter for delegate.

This is a weak property.

pub fn dataSource( &self, ) -> Option<Retained<ProtocolObject<dyn UICollectionViewDataSource>>>

pub fn setDataSource( &self, data_source: Option<&ProtocolObject<dyn UICollectionViewDataSource>>, )

Setter for dataSource.

This is a weak property.

pub fn prefetchDataSource( &self, ) -> Option<Retained<ProtocolObject<dyn UICollectionViewDataSourcePrefetching>>>

pub fn setPrefetchDataSource( &self, prefetch_data_source: Option<&ProtocolObject<dyn UICollectionViewDataSourcePrefetching>>, )

Setter for prefetchDataSource.

This is a weak property.

pub fn isPrefetchingEnabled(&self) -> bool

pub fn setPrefetchingEnabled(&self, prefetching_enabled: bool)

Setter for isPrefetchingEnabled.

pub fn dragDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn UICollectionViewDragDelegate>>>

pub fn setDragDelegate( &self, drag_delegate: Option<&ProtocolObject<dyn UICollectionViewDragDelegate>>, )

Setter for dragDelegate.

This is a weak property.

pub fn dropDelegate( &self, ) -> Option<Retained<ProtocolObject<dyn UICollectionViewDropDelegate>>>

pub fn setDropDelegate( &self, drop_delegate: Option<&ProtocolObject<dyn UICollectionViewDropDelegate>>, )

Setter for dropDelegate.

This is a weak property.

pub fn dragInteractionEnabled(&self) -> bool

pub fn setDragInteractionEnabled(&self, drag_interaction_enabled: bool)

Setter for dragInteractionEnabled.

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

Available on crate feature UIContextMenuInteraction only.

pub fn reorderingCadence(&self) -> UICollectionViewReorderingCadence

pub fn setReorderingCadence( &self, reordering_cadence: UICollectionViewReorderingCadence, )

Setter for reorderingCadence.

pub fn selfSizingInvalidation(&self) -> UICollectionViewSelfSizingInvalidation

pub fn setSelfSizingInvalidation( &self, self_sizing_invalidation: UICollectionViewSelfSizingInvalidation, )

Setter for selfSizingInvalidation.

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

pub fn setBackgroundView(&self, background_view: Option<&UIView>)

Setter for backgroundView.

pub unsafe fn registerClass_forCellWithReuseIdentifier( &self, cell_class: Option<&AnyClass>, identifier: &NSString, )

Safety

cell_class probably has further requirements.

pub fn registerNib_forCellWithReuseIdentifier( &self, nib: Option<&UINib>, identifier: &NSString, )

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Available on crate feature UINib only.

pub unsafe fn registerClass_forSupplementaryViewOfKind_withReuseIdentifier( &self, view_class: Option<&AnyClass>, element_kind: &NSString, identifier: &NSString, )

Safety

view_class probably has further requirements.

pub fn registerNib_forSupplementaryViewOfKind_withReuseIdentifier( &self, nib: Option<&UINib>, kind: &NSString, identifier: &NSString, )

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.

Available on crate feature UINib only.

pub fn dequeueReusableCellWithReuseIdentifier_forIndexPath( &self, identifier: &NSString, index_path: &NSIndexPath, ) -> Retained<UICollectionViewCell>

Available on crate feature UICollectionViewCell only.

pub fn dequeueReusableSupplementaryViewOfKind_withReuseIdentifier_forIndexPath( &self, element_kind: &NSString, identifier: &NSString, index_path: &NSIndexPath, ) -> Retained<UICollectionReusableView>

Available on crate feature UICollectionViewCell only.

pub unsafe fn dequeueConfiguredReusableCellWithRegistration_forIndexPath_item( &self, registration: &UICollectionViewCellRegistration, index_path: &NSIndexPath, item: &AnyObject, ) -> Retained<UICollectionViewCell>

Available on crate features UICollectionViewCell and UICollectionViewItemRegistration only.

Safety

item should be of the correct type.

pub fn dequeueConfiguredReusableSupplementaryViewWithRegistration_forIndexPath( &self, registration: &UICollectionViewSupplementaryRegistration, index_path: &NSIndexPath, ) -> Retained<UICollectionReusableView>

Available on crate features UICollectionViewCell and UICollectionViewItemRegistration only.

pub fn allowsSelection(&self) -> bool

pub fn setAllowsSelection(&self, allows_selection: bool)

Setter for allowsSelection.

pub fn allowsMultipleSelection(&self) -> bool

pub fn setAllowsMultipleSelection(&self, allows_multiple_selection: bool)

Setter for allowsMultipleSelection.

pub fn indexPathsForSelectedItems( &self, ) -> Option<Retained<NSArray<NSIndexPath>>>

pub fn selectItemAtIndexPath_animated_scrollPosition( &self, index_path: Option<&NSIndexPath>, animated: bool, scroll_position: UICollectionViewScrollPosition, )

pub fn deselectItemAtIndexPath_animated( &self, index_path: &NSIndexPath, animated: bool, )

pub fn hasUncommittedUpdates(&self) -> bool

pub fn reloadData(&self)

pub fn setCollectionViewLayout_animated( &self, layout: &UICollectionViewLayout, animated: bool, )

Available on crate feature UICollectionViewLayout only.

pub fn setCollectionViewLayout_animated_completion( &self, layout: &UICollectionViewLayout, animated: bool, completion: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate features UICollectionViewLayout and block2 only.

pub unsafe fn startInteractiveTransitionToCollectionViewLayout_completion( &self, layout: &UICollectionViewLayout, completion: UICollectionViewLayoutInteractiveTransitionCompletion, ) -> Retained<UICollectionViewTransitionLayout>

Available on crate features UICollectionViewLayout and UICollectionViewTransitionLayout and block2 only.

Safety

completion must be a valid pointer or null.

pub fn finishInteractiveTransition(&self)

pub fn cancelInteractiveTransition(&self)

pub fn numberOfSections(&self) -> NSInteger

pub fn numberOfItemsInSection(&self, section: NSInteger) -> NSInteger

pub fn layoutAttributesForItemAtIndexPath( &self, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Available on crate feature UICollectionViewLayout only.

pub fn layoutAttributesForSupplementaryElementOfKind_atIndexPath( &self, kind: &NSString, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Available on crate feature UICollectionViewLayout only.

pub fn indexPathForItemAtPoint( &self, point: CGPoint, ) -> Option<Retained<NSIndexPath>>

Available on crate feature objc2-core-foundation only.

pub fn indexPathForCell( &self, cell: &UICollectionViewCell, ) -> Option<Retained<NSIndexPath>>

Available on crate feature UICollectionViewCell only.

pub fn indexPathForSupplementaryView( &self, supplementary_view: &UICollectionReusableView, ) -> Option<Retained<NSIndexPath>>

Available on crate feature UICollectionViewCell only.

Gets the index path of the specified supplementary view.

Parameter supplementaryView: The supplementary or decoration view whose index path you want.

Returns: The index path of the specified view if it is in the collection view, else nil.

pub fn cellForItemAtIndexPath( &self, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewCell>>

Available on crate feature UICollectionViewCell only.

pub fn visibleCells(&self) -> Retained<NSArray<UICollectionViewCell>>

Available on crate feature UICollectionViewCell only.

pub fn indexPathsForVisibleItems(&self) -> Retained<NSArray<NSIndexPath>>

pub fn supplementaryViewForElementKind_atIndexPath( &self, element_kind: &NSString, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionReusableView>>

Available on crate feature UICollectionViewCell only.

pub fn visibleSupplementaryViewsOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<UICollectionReusableView>>

Available on crate feature UICollectionViewCell only.

pub fn indexPathsForVisibleSupplementaryElementsOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>

pub fn scrollToItemAtIndexPath_atScrollPosition_animated( &self, index_path: &NSIndexPath, scroll_position: UICollectionViewScrollPosition, animated: bool, )

pub fn insertSections(&self, sections: &NSIndexSet)

pub fn deleteSections(&self, sections: &NSIndexSet)

pub fn moveSection_toSection(&self, section: NSInteger, new_section: NSInteger)

pub fn reloadSections(&self, sections: &NSIndexSet)

pub fn insertItemsAtIndexPaths(&self, index_paths: &NSArray<NSIndexPath>)

pub fn deleteItemsAtIndexPaths(&self, index_paths: &NSArray<NSIndexPath>)

pub fn moveItemAtIndexPath_toIndexPath( &self, index_path: &NSIndexPath, new_index_path: &NSIndexPath, )

pub fn reloadItemsAtIndexPaths(&self, index_paths: &NSArray<NSIndexPath>)

pub fn reconfigureItemsAtIndexPaths(&self, index_paths: &NSArray<NSIndexPath>)

pub fn performBatchUpdates_completion( &self, updates: Option<&DynBlock<dyn Fn() + '_>>, completion: Option<&DynBlock<dyn Fn(Bool)>>, )

Available on crate feature block2 only.

pub fn beginInteractiveMovementForItemAtIndexPath( &self, index_path: &NSIndexPath, ) -> bool

pub fn updateInteractiveMovementTargetPosition(&self, target_position: CGPoint)

Available on crate feature objc2-core-foundation only.

pub fn endInteractiveMovement(&self)

pub fn cancelInteractiveMovement(&self)

pub fn remembersLastFocusedIndexPath(&self) -> bool

pub fn setRemembersLastFocusedIndexPath( &self, remembers_last_focused_index_path: bool, )

Setter for remembersLastFocusedIndexPath.

pub fn selectionFollowsFocus(&self) -> bool

When enabled, the collection view ensures that selection is automatically triggered when focus moves to a cell. Defaults to a system derived value based on platform and other properties of the collection view.

pub fn setSelectionFollowsFocus(&self, selection_follows_focus: bool)

Setter for selectionFollowsFocus.

pub fn allowsFocus(&self) -> bool

Determines if the collection view allows its cells to become focused. When collectionView:canFocusItemAtIndexPath: is implemented, its return value takes precedence over this method. Defaults to a system derived value based on platform and other properties of the collection view.

pub fn setAllowsFocus(&self, allows_focus: bool)

Setter for allowsFocus.

pub fn allowsFocusDuringEditing(&self) -> bool

Determines if the collection view allows its cells to become focused while editing. When collectionView:canFocusItemAtIndexPath: is implemented, its return value takes precedence over this method. Defaults to a system derived value based on platform and other properties of the collection view.

pub fn setAllowsFocusDuringEditing(&self, allows_focus_during_editing: bool)

Setter for allowsFocusDuringEditing.

pub fn hasActiveDrag(&self) -> bool

pub fn hasActiveDrop(&self) -> bool

pub fn isEditing(&self) -> bool

pub fn setEditing(&self, editing: bool)

Setter for isEditing.

pub fn allowsSelectionDuringEditing(&self) -> bool

pub fn setAllowsSelectionDuringEditing( &self, allows_selection_during_editing: bool, )

Setter for allowsSelectionDuringEditing.

pub fn allowsMultipleSelectionDuringEditing(&self) -> bool

pub fn setAllowsMultipleSelectionDuringEditing( &self, allows_multiple_selection_during_editing: bool, )

Setter for allowsMultipleSelectionDuringEditing.

impl UICollectionView

Methods declared on superclass UIView.

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

Available on crate feature objc2-core-foundation only.

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

impl UICollectionView

Methods declared on superclass NSObject.

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

impl UICollectionView

This impl block contains no items.

UIDragAndDrop.

Methods from Deref<Target = UIScrollView>

pub fn contentOffset(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub fn setContentOffset(&self, content_offset: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for contentOffset.

pub fn contentSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

pub fn setContentSize(&self, content_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for contentSize.

pub fn contentInset(&self) -> UIEdgeInsets

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

pub fn setContentInset(&self, content_inset: UIEdgeInsets)

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

Setter for contentInset.

pub fn contentAlignmentPoint(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub fn setContentAlignmentPoint(&self, content_alignment_point: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for contentAlignmentPoint.

pub fn adjustedContentInset(&self) -> UIEdgeInsets

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

pub fn adjustedContentInsetDidChange(&self)

pub fn contentInsetAdjustmentBehavior( &self, ) -> UIScrollViewContentInsetAdjustmentBehavior

pub fn setContentInsetAdjustmentBehavior( &self, content_inset_adjustment_behavior: UIScrollViewContentInsetAdjustmentBehavior, )

Setter for contentInsetAdjustmentBehavior.

pub fn automaticallyAdjustsScrollIndicatorInsets(&self) -> bool

pub fn setAutomaticallyAdjustsScrollIndicatorInsets( &self, automatically_adjusts_scroll_indicator_insets: bool, )

Setter for automaticallyAdjustsScrollIndicatorInsets.

pub fn contentLayoutGuide(&self) -> Retained<UILayoutGuide>

Available on crate feature UILayoutGuide only.

pub fn frameLayoutGuide(&self) -> Retained<UILayoutGuide>

Available on crate feature UILayoutGuide only.

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

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

Setter for delegate.

This is a weak property.

pub fn isDirectionalLockEnabled(&self) -> bool

pub fn setDirectionalLockEnabled(&self, directional_lock_enabled: bool)

Setter for isDirectionalLockEnabled.

pub fn bounces(&self) -> bool

pub fn setBounces(&self, bounces: bool)

Setter for bounces.

pub fn bouncesHorizontally(&self) -> bool

pub fn setBouncesHorizontally(&self, bounces_horizontally: bool)

Setter for bouncesHorizontally.

pub fn bouncesVertically(&self) -> bool

pub fn setBouncesVertically(&self, bounces_vertically: bool)

Setter for bouncesVertically.

pub fn alwaysBounceVertical(&self) -> bool

pub fn setAlwaysBounceVertical(&self, always_bounce_vertical: bool)

Setter for alwaysBounceVertical.

pub fn alwaysBounceHorizontal(&self) -> bool

pub fn setAlwaysBounceHorizontal(&self, always_bounce_horizontal: bool)

Setter for alwaysBounceHorizontal.

pub fn isPagingEnabled(&self) -> bool

pub fn setPagingEnabled(&self, paging_enabled: bool)

Setter for isPagingEnabled.

pub fn isScrollEnabled(&self) -> bool

pub fn setScrollEnabled(&self, scroll_enabled: bool)

Setter for isScrollEnabled.

pub fn transfersHorizontalScrollingToParent(&self) -> bool

pub fn setTransfersHorizontalScrollingToParent( &self, transfers_horizontal_scrolling_to_parent: bool, )

Setter for transfersHorizontalScrollingToParent.

pub fn transfersVerticalScrollingToParent(&self) -> bool

pub fn setTransfersVerticalScrollingToParent( &self, transfers_vertical_scrolling_to_parent: bool, )

Setter for transfersVerticalScrollingToParent.

pub fn showsVerticalScrollIndicator(&self) -> bool

pub fn setShowsVerticalScrollIndicator( &self, shows_vertical_scroll_indicator: bool, )

Setter for showsVerticalScrollIndicator.

pub fn showsHorizontalScrollIndicator(&self) -> bool

pub fn setShowsHorizontalScrollIndicator( &self, shows_horizontal_scroll_indicator: bool, )

Setter for showsHorizontalScrollIndicator.

pub fn indicatorStyle(&self) -> UIScrollViewIndicatorStyle

pub fn setIndicatorStyle(&self, indicator_style: UIScrollViewIndicatorStyle)

Setter for indicatorStyle.

pub fn verticalScrollIndicatorInsets(&self) -> UIEdgeInsets

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

pub fn setVerticalScrollIndicatorInsets( &self, vertical_scroll_indicator_insets: UIEdgeInsets, )

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

Setter for verticalScrollIndicatorInsets.

pub fn horizontalScrollIndicatorInsets(&self) -> UIEdgeInsets

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

pub fn setHorizontalScrollIndicatorInsets( &self, horizontal_scroll_indicator_insets: UIEdgeInsets, )

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

Setter for horizontalScrollIndicatorInsets.

pub fn scrollIndicatorInsets(&self) -> UIEdgeInsets

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

pub fn setScrollIndicatorInsets(&self, scroll_indicator_insets: UIEdgeInsets)

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

Setter for scrollIndicatorInsets.

pub fn decelerationRate(&self) -> UIScrollViewDecelerationRate

Available on crate feature objc2-core-foundation only.

pub fn setDecelerationRate( &self, deceleration_rate: UIScrollViewDecelerationRate, )

Available on crate feature objc2-core-foundation only.

Setter for decelerationRate.

pub fn indexDisplayMode(&self) -> UIScrollViewIndexDisplayMode

pub fn setIndexDisplayMode( &self, index_display_mode: UIScrollViewIndexDisplayMode, )

Setter for indexDisplayMode.

pub fn setContentOffset_animated(&self, content_offset: CGPoint, animated: bool)

Available on crate feature objc2-core-foundation only.

pub fn scrollRectToVisible_animated(&self, rect: CGRect, animated: bool)

Available on crate feature objc2-core-foundation only.

pub fn flashScrollIndicators(&self)

pub fn withScrollIndicatorsShownForContentOffsetChanges( &self, changes: &DynBlock<dyn Fn() + '_>, )

Available on crate feature block2 only.

pub fn topEdgeEffect(&self) -> Retained<UIScrollEdgeEffect>

The effect for the top edge of the scroll view.

pub fn leftEdgeEffect(&self) -> Retained<UIScrollEdgeEffect>

The effect for the left edge of the scroll view.

pub fn bottomEdgeEffect(&self) -> Retained<UIScrollEdgeEffect>

The effect for the bottom edge of the scroll view.

pub fn rightEdgeEffect(&self) -> Retained<UIScrollEdgeEffect>

The effect for the right edge of the scroll view.

pub fn isTracking(&self) -> bool

pub fn isDragging(&self) -> bool

pub fn isDecelerating(&self) -> bool

pub fn isScrollAnimating(&self) -> bool

pub fn delaysContentTouches(&self) -> bool

pub fn setDelaysContentTouches(&self, delays_content_touches: bool)

Setter for delaysContentTouches.

pub fn canCancelContentTouches(&self) -> bool

pub fn setCanCancelContentTouches(&self, can_cancel_content_touches: bool)

Setter for canCancelContentTouches.

pub fn touchesShouldBegin_withEvent_inContentView( &self, touches: &NSSet<UITouch>, event: Option<&UIEvent>, view: &UIView, ) -> bool

Available on crate features UIEvent and UITouch only.

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

pub fn minimumZoomScale(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMinimumZoomScale(&self, minimum_zoom_scale: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumZoomScale.

pub fn maximumZoomScale(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setMaximumZoomScale(&self, maximum_zoom_scale: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for maximumZoomScale.

pub fn zoomScale(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setZoomScale(&self, zoom_scale: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for zoomScale.

pub fn setZoomScale_animated(&self, scale: CGFloat, animated: bool)

Available on crate feature objc2-core-foundation only.

pub fn zoomToRect_animated(&self, rect: CGRect, animated: bool)

Available on crate feature objc2-core-foundation only.

pub fn bouncesZoom(&self) -> bool

pub fn setBouncesZoom(&self, bounces_zoom: bool)

Setter for bouncesZoom.

pub fn isZooming(&self) -> bool

pub fn isZoomBouncing(&self) -> bool

pub fn isZoomAnimating(&self) -> bool

pub fn scrollsToTop(&self) -> bool

pub fn setScrollsToTop(&self, scrolls_to_top: bool)

Setter for scrollsToTop.

pub fn stopScrollingAndZooming(&self)

pub fn panGestureRecognizer(&self) -> Retained<UIPanGestureRecognizer>

Available on crate features UIGestureRecognizer and UIPanGestureRecognizer only.

pub fn pinchGestureRecognizer( &self, ) -> Option<Retained<UIPinchGestureRecognizer>>

Available on crate features UIGestureRecognizer and UIPinchGestureRecognizer only.

pub fn directionalPressGestureRecognizer(&self) -> Retained<UIGestureRecognizer>

👎Deprecated: Configuring the panGestureRecognizer for indirect scrolling automatically supports directional presses now, so this property is no longer useful.

Available on crate feature UIGestureRecognizer only.

pub fn keyboardDismissMode(&self) -> UIScrollViewKeyboardDismissMode

pub fn setKeyboardDismissMode( &self, keyboard_dismiss_mode: UIScrollViewKeyboardDismissMode, )

Setter for keyboardDismissMode.

pub fn refreshControl(&self) -> Option<Retained<UIRefreshControl>>

Available on crate features UIControl and UIRefreshControl only.

pub fn setRefreshControl(&self, refresh_control: Option<&UIRefreshControl>)

Available on crate features UIControl and UIRefreshControl only.

Setter for refreshControl.

pub fn allowsKeyboardScrolling(&self) -> bool

Set this to YES to make the scroll view animate its content offset in response to keys like Page Up/Down, Home/End, and the arrow keys. The scroll view must be focused or first responder in order to receive these key events. Default is YES for apps linked after iOS 17.0.

pub fn setAllowsKeyboardScrolling(&self, allows_keyboard_scrolling: bool)

Setter for allowsKeyboardScrolling.

pub fn lookToScrollAxes(&self) -> UIAxis

Available on crate feature UIGeometry only.

Defines which axes are considered for Look to Scroll. Does not affect when isPagingEnabled is true.

pub fn setLookToScrollAxes(&self, look_to_scroll_axes: UIAxis)

Available on crate feature UIGeometry only.

Setter for lookToScrollAxes.

Methods from Deref<Target = UIView>

pub fn accessibilityIgnoresInvertColors(&self) -> bool

Available on crate feature UIAccessibilityAdditions only.

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

Available on crate feature UIAccessibilityAdditions only.

Setter for accessibilityIgnoresInvertColors.

pub 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 fn setHoverStyle(&self, hover_style: Option<&UIHoverStyle>)

Available on crate feature UIHoverStyle only.

Setter for hoverStyle.

This is copied when set.

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

Available on crate feature UIInteraction only.

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

Available on crate feature UIInteraction only.

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

Available on crate feature UIInteraction only.

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

Available on crate feature UIInteraction only.

Setter for interactions.

This is copied when set.

pub fn showsLargeContentViewer(&self) -> bool

Available on crate feature UILargeContentViewer only.

pub fn setShowsLargeContentViewer(&self, shows_large_content_viewer: bool)

Available on crate feature UILargeContentViewer only.

Setter for showsLargeContentViewer.

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

Available on crate feature UILargeContentViewer only.

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

Available on crate feature UILargeContentViewer only.

Setter for largeContentTitle.

This is copied when set.

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

Available on crate features UILargeContentViewer and UIImage only.

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

Available on crate features UILargeContentViewer and UIImage only.

Setter for largeContentImage.

pub fn scalesLargeContentImage(&self) -> bool

Available on crate feature UILargeContentViewer only.

pub fn setScalesLargeContentImage(&self, scales_large_content_image: bool)

Available on crate feature UILargeContentViewer only.

Setter for scalesLargeContentImage.

pub fn largeContentImageInsets(&self) -> UIEdgeInsets

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

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

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

Setter for largeContentImageInsets.

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

Available on crate feature UIPrintFormatter only.

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

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

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

Available on crate feature UITextField only.

pub fn isUserInteractionEnabled(&self) -> bool

pub fn setUserInteractionEnabled(&self, user_interaction_enabled: bool)

Setter for isUserInteractionEnabled.

pub fn tag(&self) -> NSInteger

pub 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 fn canBecomeFocused(&self) -> bool

pub fn isFocused(&self) -> bool

pub 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 fn setFocusGroupIdentifier(&self, focus_group_identifier: Option<&NSString>)

Setter for focusGroupIdentifier.

This is copied when set.

pub 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 fn setFocusGroupPriority(&self, focus_group_priority: UIFocusGroupPriority)

Available on crate feature UIFocus only.

Setter for focusGroupPriority.

pub 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 fn setFocusEffect(&self, focus_effect: Option<&UIFocusEffect>)

Available on crate feature UIFocusEffect only.

Setter for focusEffect.

This is copied when set.

pub fn semanticContentAttribute(&self) -> UISemanticContentAttribute

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

Setter for semanticContentAttribute.

pub 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 fn center(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub fn setCenter(&self, center: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for center.

pub fn transform(&self) -> CGAffineTransform

Available on crate feature objc2-core-foundation only.

pub fn setTransform(&self, transform: CGAffineTransform)

Available on crate feature objc2-core-foundation only.

Setter for transform.

pub fn transform3D(&self) -> CATransform3D

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

pub 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 fn anchorPoint(&self) -> CGPoint

Available on crate feature objc2-core-foundation only.

pub fn setAnchorPoint(&self, anchor_point: CGPoint)

Available on crate feature objc2-core-foundation only.

Setter for anchorPoint.

pub fn isMultipleTouchEnabled(&self) -> bool

pub fn setMultipleTouchEnabled(&self, multiple_touch_enabled: bool)

Setter for isMultipleTouchEnabled.

pub fn isExclusiveTouch(&self) -> bool

pub fn setExclusiveTouch(&self, exclusive_touch: bool)

Setter for isExclusiveTouch.

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

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

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

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

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

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

pub fn autoresizesSubviews(&self) -> bool

pub fn setAutoresizesSubviews(&self, autoresizes_subviews: bool)

Setter for autoresizesSubviews.

pub fn autoresizingMask(&self) -> UIViewAutoresizing

pub fn setAutoresizingMask(&self, autoresizing_mask: UIViewAutoresizing)

Setter for autoresizingMask.

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

Available on crate feature objc2-core-foundation only.

pub 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 fn removeFromSuperview(&self)

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

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

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

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

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

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

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

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

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

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

pub fn didMoveToSuperview(&self)

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

Available on crate feature UIWindow only.

pub fn didMoveToWindow(&self)

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

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

pub fn setNeedsUpdateProperties(&self)

Call to manually request a properties update for the view. Multiple requests may be coalesced into a single update alongside the next layout pass.

pub fn updateProperties(&self)

Override point for subclasses to update properties of this view. Never call this method directly; use setNeedsUpdateProperties to schedule an update.

pub fn updatePropertiesIfNeeded(&self)

Forces an immediate properties update for this view (and its view controller, if applicable) and any subviews, including any view controllers or views in its subtree.

pub fn setNeedsLayout(&self)

pub fn layoutIfNeeded(&self)

pub fn layoutSubviews(&self)

pub fn layoutMargins(&self) -> UIEdgeInsets

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

pub fn setLayoutMargins(&self, layout_margins: UIEdgeInsets)

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

Setter for layoutMargins.

pub fn directionalLayoutMargins(&self) -> NSDirectionalEdgeInsets

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

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

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

Setter for directionalLayoutMargins.

pub fn preservesSuperviewLayoutMargins(&self) -> bool

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

Setter for preservesSuperviewLayoutMargins.

pub fn insetsLayoutMarginsFromSafeArea(&self) -> bool

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

Setter for insetsLayoutMarginsFromSafeArea.

pub fn layoutMarginsDidChange(&self)

pub fn safeAreaInsets(&self) -> UIEdgeInsets

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

pub fn safeAreaInsetsDidChange(&self)

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

Available on crate feature UILayoutGuide only.

pub 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 fn safeAreaLayoutGuide(&self) -> Retained<UILayoutGuide>

Available on crate feature UILayoutGuide only.

pub 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 fn drawRect(&self, rect: CGRect)

Available on crate feature objc2-core-foundation only.

pub fn setNeedsDisplay(&self)

pub fn setNeedsDisplayInRect(&self, rect: CGRect)

Available on crate feature objc2-core-foundation only.

pub fn clipsToBounds(&self) -> bool

pub 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.

This is copied when set.

pub fn alpha(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub fn setAlpha(&self, alpha: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for alpha.

pub fn isOpaque(&self) -> bool

pub fn setOpaque(&self, opaque: bool)

Setter for isOpaque.

pub fn clearsContextBeforeDrawing(&self) -> bool

pub 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 fn contentMode(&self) -> UIViewContentMode

pub fn setContentMode(&self, content_mode: UIViewContentMode)

Setter for contentMode.

pub fn contentStretch(&self) -> CGRect

👎Deprecated

Available on crate feature objc2-core-foundation only.

pub fn setContentStretch(&self, content_stretch: CGRect)

👎Deprecated

Available on crate feature objc2-core-foundation only.

Setter for contentStretch.

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

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

Setter for maskView.

pub 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.

Safety

tint_color might not allow None.

pub fn tintAdjustmentMode(&self) -> UIViewTintAdjustmentMode

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

Setter for tintAdjustmentMode.

pub fn tintColorDidChange(&self)

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

Available on crate feature UIGestureRecognizer only.

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

Available on crate feature UIGestureRecognizer only.

Setter for gestureRecognizers.

This is copied when set.

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 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 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 fn motionEffects(&self) -> Retained<NSArray<UIMotionEffect>>

Available on crate feature UIMotionEffect only.

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

Available on crate feature UIMotionEffect only.

Setter for motionEffects.

This is copied when set.

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

Available on crate feature NSLayoutConstraint only.

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

Available on crate feature NSLayoutConstraint only.

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

Available on crate feature NSLayoutConstraint only.

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

Available on crate feature NSLayoutConstraint only.

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

Available on crate feature NSLayoutConstraint only.

pub fn updateConstraintsIfNeeded(&self)

pub fn updateConstraints(&self)

pub fn needsUpdateConstraints(&self) -> bool

pub fn setNeedsUpdateConstraints(&self)

pub fn translatesAutoresizingMaskIntoConstraints(&self) -> bool

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

Setter for translatesAutoresizingMaskIntoConstraints.

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

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

pub fn alignmentRectInsets(&self) -> UIEdgeInsets

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

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

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

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

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

pub fn intrinsicContentSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

pub fn invalidateIntrinsicContentSize(&self)

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

Available on crate feature NSLayoutConstraint only.

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

Available on crate feature NSLayoutConstraint only.

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

Available on crate feature NSLayoutConstraint only.

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

Available on crate feature NSLayoutConstraint only.

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

Available on crate feature objc2-core-foundation only.

pub 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 fn layoutGuides(&self) -> Retained<NSArray<UILayoutGuide>>

Available on crate feature UILayoutGuide only.

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

Available on crate feature UILayoutGuide only.

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

Available on crate feature UILayoutGuide only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutConstraint only.

pub fn hasAmbiguousLayout(&self) -> bool

pub fn exerciseAmbiguityInLayout(&self)

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

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

Setter for restorationIdentifier.

This is copied when set.

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

Safety

coder possibly has further requirements.

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

Safety

coder possibly has further requirements.

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

pub 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 fn drawViewHierarchyInRect_afterScreenUpdates( &self, rect: CGRect, after_updates: bool, ) -> bool

Available on crate feature objc2-core-foundation only.

pub fn overrideUserInterfaceStyle(&self) -> UIUserInterfaceStyle

Available on crate feature UIInterface only.

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

Available on crate feature UIInterface only.

Setter for overrideUserInterfaceStyle.

pub 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 fn setMinimumContentSizeCategory( &self, minimum_content_size_category: Option<&UIContentSizeCategory>, )

Available on crate feature UIContentSizeCategory only.

Setter for minimumContentSizeCategory.

This is copied when set.

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

Available on crate feature UIContentSizeCategory only.

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

Available on crate feature UIContentSizeCategory only.

Setter for maximumContentSizeCategory.

This is copied when set.

pub 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 fn traitOverrides(&self) -> Retained<ProtocolObject<dyn UITraitOverrides>>

Available on crate feature UITraitCollection only.

pub 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.

pub fn layoutGuideForLayoutRegion( &self, layout_region: &UIViewLayoutRegion, ) -> Retained<UILayoutGuide>

Available on crate features UILayoutGuide and UIViewLayoutRegion only.

pub fn edgeInsetsForLayoutRegion( &self, layout_region: &UIViewLayoutRegion, ) -> UIEdgeInsets

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

pub fn directionalEdgeInsetsForLayoutRegion( &self, layout_region: &UIViewLayoutRegion, ) -> NSDirectionalEdgeInsets

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

pub fn cornerConfiguration(&self) -> Retained<UICornerConfiguration>

Available on crate feature UICornerConfiguration only.

A configuration that defines the corners of the view.

pub fn setCornerConfiguration( &self, corner_configuration: &UICornerConfiguration, )

Available on crate feature UICornerConfiguration only.

Setter for cornerConfiguration.

This is copied when set.

pub fn effectiveRadiusForCorner(&self, corner: UIRectCorner) -> CGFloat

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

Returns the effective radius for the given corner, calculated using the view’s current cornerConfiguration.

When invoked within UIView.layoutSubviews(), UIView.updateProperties(), or UIViewController.updateProperties() automatic invalidation will occur if the effective radius changes. If more than one corner is provided, the returned radius represents the maximum effective radius of those corners.

• Parameter corner: The corner.
• Returns: The effective radius.

Methods from Deref<Target = UIResponder>

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

pub fn canBecomeFirstResponder(&self) -> bool

pub fn becomeFirstResponder(&self) -> bool

pub fn canResignFirstResponder(&self) -> bool

pub fn resignFirstResponder(&self) -> bool

pub fn isFirstResponder(&self) -> bool

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

Available on crate features UIEvent and UITouch only.

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

Available on crate features UIEvent and UITouch only.

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

Available on crate features UIEvent and UITouch only.

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

Available on crate features UIEvent and UITouch only.

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

Available on crate feature UITouch only.

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

Available on crate features UIEvent and UIPress and UIPressesEvent only.

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

Available on crate features UIEvent and UIPress and UIPressesEvent only.

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

Available on crate features UIEvent and UIPress and UIPressesEvent only.

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

Available on crate features UIEvent and UIPress and UIPressesEvent only.

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

Available on crate feature UIEvent only.

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

Available on crate feature UIEvent only.

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

Available on crate feature UIEvent only.

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

Available on crate feature UIEvent only.

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

Safety

• action must be a valid selector.
• sender should be of the correct type.

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

Safety

• action must be a valid selector.
• sender should be of the correct type.

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

Available on crate feature UIMenuBuilder only.

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

Available on crate features UICommand and UIMenuElement only.

pub fn providerForDeferredMenuElement( &self, deferred_element: &UIDeferredMenuElement, ) -> Option<Retained<UIDeferredMenuElementProvider>>

Available on crate features UIDeferredMenuElement and UIMenuElement only.

Asks the responder for an element provider to fulfill the given focus-based deferred element. Check the identifier of the deferred element to identify which deferred element this is. By default, this returns nil. Return a non-nil provider to make this responder responsible for providing elements for this fulfillment of the deferred element.

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

pub fn editingInteractionConfiguration( &self, ) -> UIEditingInteractionConfiguration

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

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

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

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

pub 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 fn inputViewController(&self) -> Option<Retained<UIInputViewController>>

Available on crate features UIInputViewController and UIViewController only.

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

Available on crate features UIInputViewController and UIViewController only.

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

Available on crate feature UITextInput only.

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

pub fn reloadInputViews(&self)

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

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

Setter for userActivity.

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

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

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

Safety

sender should be of the correct type.

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

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

pub 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 UICollectionView

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UICollectionView

fn as_ref(&self) -> &NSObject

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

impl AsRef<UICollectionView> for UICollectionView

fn as_ref(&self) -> &Self

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

impl AsRef<UIResponder> for UICollectionView

fn as_ref(&self) -> &UIResponder

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

impl AsRef<UIScrollView> for UICollectionView

fn as_ref(&self) -> &UIScrollView

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

impl AsRef<UIView> for UICollectionView

fn as_ref(&self) -> &UIView

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

impl Borrow<AnyObject> for UICollectionView

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UICollectionView

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIResponder> for UICollectionView

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIScrollView> for UICollectionView

fn borrow(&self) -> &UIScrollView

Immutably borrows from an owned value.

impl Borrow<UIView> for UICollectionView

fn borrow(&self) -> &UIView

Immutably borrows from an owned value.

impl CALayerDelegate for UICollectionView

fn displayLayer(&self, layer: &CALayer)

where Self: Sized + Message,

fn layerWillDraw(&self, layer: &CALayer)

where Self: Sized + Message,

fn layoutSublayersOfLayer(&self, layer: &CALayer)

where Self: Sized + Message,

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

where Self: Sized + Message,

impl ClassType for UICollectionView

const NAME: &'static str = "UICollectionView"

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

type Super = UIScrollView

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 UICollectionView

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

Formats the value using the given formatter.

impl Deref for UICollectionView

type Target = UIScrollView

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UICollectionView

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 UICollectionView

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UICollectionView

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSObjectProtocol for UICollectionView

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 UICollectionView

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 UICollectionView

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

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

impl UIAppearance for UICollectionView

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.

Safety

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.

Safety

impl UICoordinateSpace for UICollectionView

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 UIDataSourceTranslating for UICollectionView

fn presentationSectionIndexForDataSourceSectionIndex( &self, data_source_section_index: NSInteger, ) -> NSInteger

where Self: Sized + Message,

Available on crate feature UIDataSourceTranslating only.

fn dataSourceSectionIndexForPresentationSectionIndex( &self, presentation_section_index: NSInteger, ) -> NSInteger

where Self: Sized + Message,

Available on crate feature UIDataSourceTranslating only.

fn presentationIndexPathForDataSourceIndexPath( &self, data_source_index_path: Option<&NSIndexPath>, ) -> Option<Retained<NSIndexPath>>

where Self: Sized + Message,

Available on crate feature UIDataSourceTranslating only.

fn dataSourceIndexPathForPresentationIndexPath( &self, presentation_index_path: Option<&NSIndexPath>, ) -> Option<Retained<NSIndexPath>>

where Self: Sized + Message,

Available on crate feature UIDataSourceTranslating only.

fn performUsingPresentationValues( &self, actions_to_translate: &DynBlock<dyn Fn() + '_>, )

where Self: Sized + Message,

Available on crate features UIDataSourceTranslating and block2 only.

impl UIDynamicItem for UICollectionView

fn center(&self) -> CGPoint

where Self: Sized + Message,

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

fn setCenter(&self, center: CGPoint)

where Self: Sized + Message,

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

Setter for center.

fn bounds(&self) -> CGRect

where Self: Sized + Message,

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

fn transform(&self) -> CGAffineTransform

where Self: Sized + Message,

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

fn setTransform(&self, transform: CGAffineTransform)

where Self: Sized + Message,

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

Setter for transform.

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

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 UICollectionView

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’.

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.

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.

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];

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];.

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.

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.

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.

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

where Self: Sized + Message,

👎Deprecated

Available on crate features UIResponder and UIView and UIFocus only.

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 UICollectionView

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.

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.

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.

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).

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.

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.

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 UICollectionView

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.

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 UIFocusItemScrollableContainer for UICollectionView

fn contentOffset(&self) -> CGPoint

where Self: Sized + Message,

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

The current content offset of this scrollable container. If the scrollable container has a bounds property, bounds.origin must be equal to contentOffset.

fn setContentOffset(&self, content_offset: CGPoint)

where Self: Sized + Message,

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

Setter for contentOffset.

fn contentSize(&self) -> CGSize

where Self: Sized + Message,

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

The total size of the content contained by this container. If this size exceeds the size of this container’s visible size, then scrolling is possible.

fn visibleSize(&self) -> CGSize

where Self: Sized + Message,

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

The visible size of this scrollable container.

impl UIResponderStandardEditActions for UICollectionView

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate features UIResponder and block2 only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

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

where Self: Sized + Message,

Available on crate feature UIResponder only.

Safety

impl UISpringLoadedInteractionSupporting for UICollectionView

fn isSpringLoaded(&self) -> bool

where Self: Sized + Message,

Available on crate feature UISpringLoadedInteractionSupporting only.

fn setSpringLoaded(&self, spring_loaded: bool)

where Self: Sized + Message,

Available on crate feature UISpringLoadedInteractionSupporting only.

Setter for isSpringLoaded.

impl UITraitEnvironment for UICollectionView

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

where Self: Sized + Message,

Available on crate feature UITraitCollection only.

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 UICollectionView

impl Eq for UICollectionView

impl UIAppearanceContainer for UICollectionView