Struct TVCaptionButtonView 

pub struct TVCaptionButtonView { /* private fields */ }

Available on crate features TVCaptionButtonView and TVLockupView only.

TVCaptionButtonView is a button-like lockup view with a caption (or a footer), which itself consists of a title and a subtitle.

The caption button view can have either a content image or content text. The system adds it to a floating view with a knock-out effect. When in focus, the floating view will scale up in the .leading, .top., and .trailing directions by a fixed amount determined by the system. Overriding .focusSizeIncrease has no visible effect.

See also Apple’s documentation

Implementations

impl TVCaptionButtonView

pub unsafe fn motionDirection(&self) -> TVCaptionButtonViewMotionDirection

pub unsafe fn setMotionDirection( &self, motion_direction: TVCaptionButtonViewMotionDirection, )

Setter for motionDirection.

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

The content image

If a contentText exists, setting contentImage will remove it and take its place. By default, the system creates a template image from the alpha values in the source image. To prevent system coloring, provide the source image with UIImageRenderingModeAlwaysOriginal.

pub unsafe fn setContentImage(&self, content_image: Option<&UIImage>)

Setter for contentImage.

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

The content text

If a contentImage exists, setting contentText will remove it and take its place.

pub unsafe fn setContentText(&self, content_text: Option<&NSString>)

Setter for contentText.

This is copied when set.

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

The title text

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

Setter for title.

This is copied when set.

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

The subtitle text

pub unsafe fn setSubtitle(&self, subtitle: Option<&NSString>)

Setter for subtitle.

This is copied when set.

impl TVCaptionButtonView

Methods declared on superclass UIControl.

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

Safety

coder possibly has further requirements.

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

Available on crate feature objc2-core-foundation only.

Initializes the control and adds primaryAction for the UIControlEventPrimaryActionTriggered control event. Subclasses of UIControl may alter or add behaviors around the usage of primaryAction, see subclass documentation of this initializer for additional information.

impl TVCaptionButtonView

Methods declared on superclass UIView.

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

impl TVCaptionButtonView

Methods declared on superclass NSObject.

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

Methods from Deref<Target = TVLockupView>

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

The container view where subviews are added.

Clients should add their subviews to the contentView. Views added directly to the lockup view have undefined behaviors.

pub unsafe fn contentSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

The size of the content

Clients can use this to explicitly set the size of the content. Default results in system default contentSize.

pub unsafe fn setContentSize(&self, content_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for contentSize.

pub unsafe fn headerView(&self) -> Option<Retained<TVLockupHeaderFooterView>>

Available on crate feature TVLockupHeaderFooterView only.

The optional header and footer views.

Subclass TVLockupHeaderFooterView for additional customization.

pub unsafe fn setHeaderView( &self, header_view: Option<&TVLockupHeaderFooterView>, )

Available on crate feature TVLockupHeaderFooterView only.

Setter for headerView.

pub unsafe fn footerView(&self) -> Option<Retained<TVLockupHeaderFooterView>>

Available on crate feature TVLockupHeaderFooterView only.

pub unsafe fn setFooterView( &self, footer_view: Option<&TVLockupHeaderFooterView>, )

Available on crate feature TVLockupHeaderFooterView only.

Setter for footerView.

pub unsafe fn contentViewInsets(&self) -> NSDirectionalEdgeInsets

The spacing between the content view and its sibling and parent views

.top and .bottom are spaces between the contentView and headerView and footerView, respectively. .leading and .trailing are between contentView and the lockup view itself. Use negative values for positive spacing.

pub unsafe fn setContentViewInsets( &self, content_view_insets: NSDirectionalEdgeInsets, )

Setter for contentViewInsets.

pub unsafe fn focusSizeIncrease(&self) -> NSDirectionalEdgeInsets

The size increase when the lockup view or its subview is in focus

The amount by which headerView and footerView will move when the lockup view or its subview is in focus. Use negative values for positive increase.

pub unsafe fn setFocusSizeIncrease( &self, focus_size_increase: NSDirectionalEdgeInsets, )

Setter for focusSizeIncrease.

Methods from Deref<Target = UIControl>

pub fn isEnabled(&self) -> bool

pub fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub fn isSelected(&self) -> bool

pub fn setSelected(&self, selected: bool)

Setter for isSelected.

pub fn isHighlighted(&self) -> bool

pub fn setHighlighted(&self, highlighted: bool)

Setter for isHighlighted.

pub fn contentVerticalAlignment(&self) -> UIControlContentVerticalAlignment

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

Setter for contentVerticalAlignment.

pub fn contentHorizontalAlignment(&self) -> UIControlContentHorizontalAlignment

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

Setter for contentHorizontalAlignment.

pub fn effectiveContentHorizontalAlignment( &self, ) -> UIControlContentHorizontalAlignment

pub fn state(&self) -> UIControlState

pub fn isTracking(&self) -> bool

pub fn isTouchInside(&self) -> bool

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

Safety

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

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

Safety

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

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

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

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

Removes the action from the set of passed control events.

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

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

pub fn performPrimaryAction(&self)

Performs the control’s primary action.

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

pub fn allControlEvents(&self) -> UIControlEvents

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

Safety

target should be of the correct type.

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

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

pub fn sendActionsForControlEvents(&self, control_events: UIControlEvents)

send all actions associated with the given control events

pub fn isContextMenuInteractionEnabled(&self) -> bool

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

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

Setter for isContextMenuInteractionEnabled.

pub fn showsMenuAsPrimaryAction(&self) -> bool

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

pub fn setShowsMenuAsPrimaryAction(&self, shows_menu_as_primary_action: bool)

Setter for showsMenuAsPrimaryAction.

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

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

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

Setter for toolTip.

This is copied when set.

pub fn isSymbolAnimationEnabled(&self) -> bool

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

pub fn setSymbolAnimationEnabled(&self, symbol_animation_enabled: bool)

Setter for isSymbolAnimationEnabled.

Methods from Deref<Target = UIView>

pub fn isUserInteractionEnabled(&self) -> bool

pub fn setUserInteractionEnabled(&self, user_interaction_enabled: bool)

Setter for isUserInteractionEnabled.

pub fn tag(&self) -> isize

pub fn setTag(&self, tag: isize)

Setter for tag.

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

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: isize)

Setter for focusGroupPriority.

pub fn semanticContentAttribute(&self) -> UISemanticContentAttribute

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

Setter for semanticContentAttribute.

pub fn frame(&self) -> CGRect

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

pub fn bounds(&self) -> CGRect

pub fn setBounds(&self, bounds: CGRect)

Setter for bounds.

pub fn center(&self) -> CGPoint

pub fn setCenter(&self, center: CGPoint)

Setter for center.

pub fn transform(&self) -> CGAffineTransform

pub fn setTransform(&self, transform: CGAffineTransform)

Setter for transform.

pub fn contentScaleFactor(&self) -> f64

pub fn setContentScaleFactor(&self, content_scale_factor: f64)

Setter for contentScaleFactor.

pub fn anchorPoint(&self) -> CGPoint

pub fn setAnchorPoint(&self, anchor_point: CGPoint)

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 convertPoint_toView( &self, point: CGPoint, view: Option<&UIView>, ) -> CGPoint

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

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

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

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

pub fn sizeToFit(&self)

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

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

pub fn removeFromSuperview(&self)

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

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

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

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

pub fn viewWithTag(&self, tag: isize) -> 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

pub fn setLayoutMargins(&self, layout_margins: UIEdgeInsets)

Setter for layoutMargins.

pub fn directionalLayoutMargins(&self) -> NSDirectionalEdgeInsets

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

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

pub fn safeAreaInsetsDidChange(&self)

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

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

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>

pub fn drawRect(&self, rect: CGRect)

pub fn setNeedsDisplay(&self)

pub fn setNeedsDisplayInRect(&self, rect: CGRect)

pub fn clipsToBounds(&self) -> bool

pub fn setClipsToBounds(&self, clips_to_bounds: bool)

Setter for clipsToBounds.

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

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

Setter for backgroundColor.

This is copied when set.

pub fn alpha(&self) -> f64

pub fn setAlpha(&self, alpha: f64)

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

pub fn setContentStretch(&self, content_stretch: CGRect)

👎Deprecated

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

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

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

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

pub fn alignmentRectInsets(&self) -> UIEdgeInsets

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

pub fn invalidateIntrinsicContentSize(&self)

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

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

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

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

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

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

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

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 effectiveRadiusForCorner(&self, corner: UIRectCorner) -> f64

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 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 undoManager(&self) -> Option<Retained<NSUndoManager>>

pub fn editingInteractionConfiguration( &self, ) -> UIEditingInteractionConfiguration

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

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

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.

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

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.

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,

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 TVCaptionButtonView

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for TVCaptionButtonView

fn as_ref(&self) -> &NSObject

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

impl AsRef<TVCaptionButtonView> for TVCaptionButtonView

fn as_ref(&self) -> &Self

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

impl AsRef<TVLockupView> for TVCaptionButtonView

fn as_ref(&self) -> &TVLockupView

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

impl AsRef<UIControl> for TVCaptionButtonView

fn as_ref(&self) -> &UIControl

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

impl AsRef<UIResponder> for TVCaptionButtonView

fn as_ref(&self) -> &UIResponder

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

impl AsRef<UIView> for TVCaptionButtonView

fn as_ref(&self) -> &UIView

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

impl Borrow<AnyObject> for TVCaptionButtonView

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for TVCaptionButtonView

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<TVLockupView> for TVCaptionButtonView

fn borrow(&self) -> &TVLockupView

Immutably borrows from an owned value.

impl Borrow<UIControl> for TVCaptionButtonView

fn borrow(&self) -> &UIControl

Immutably borrows from an owned value.

impl Borrow<UIResponder> for TVCaptionButtonView

fn borrow(&self) -> &UIResponder

Immutably borrows from an owned value.

impl Borrow<UIView> for TVCaptionButtonView

fn borrow(&self) -> &UIView

Immutably borrows from an owned value.

impl CALayerDelegate for TVCaptionButtonView

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 TVCaptionButtonView

const NAME: &'static str = "TVCaptionButtonView"

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

type Super = TVLockupView

The superclass of this class.

type ThreadKind = <<TVCaptionButtonView as ClassType>::Super as ClassType>::ThreadKind

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 TVCaptionButtonView

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

Formats the value using the given formatter.

impl Deref for TVCaptionButtonView

type Target = TVLockupView

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for TVCaptionButtonView

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 TVCaptionButtonView

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for TVCaptionButtonView

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 TVCaptionButtonView

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 TVCaptionButtonView

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 TVCaptionButtonView

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

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

impl UIAppearance for TVCaptionButtonView

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

where Self: Sized + ClassType,

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

where Self: Sized + ClassType,

Safety

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

where Self: Sized + ClassType,

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

where Self: Sized + ClassType,

Safety

impl UICoordinateSpace for TVCaptionButtonView

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

where Self: Sized + Message,

fn bounds(&self) -> CGRect

where Self: Sized + Message,

impl UIDynamicItem for TVCaptionButtonView

fn center(&self) -> CGPoint

where Self: Sized + Message,

fn setCenter(&self, center: CGPoint)

where Self: Sized + Message,

Setter for center.

fn bounds(&self) -> CGRect

where Self: Sized + Message,

fn transform(&self) -> CGAffineTransform

where Self: Sized + Message,

fn setTransform(&self, transform: CGAffineTransform)

where Self: Sized + Message,

Setter for transform.

fn collisionBoundsType(&self) -> UIDynamicItemCollisionBoundsType

where Self: Sized + Message,

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

impl UIFocusEnvironment for TVCaptionButtonView

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

where Self: Sized + Message,

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,

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,

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

fn setNeedsFocusUpdate(&self)

where Self: Sized + Message,

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,

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,

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

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

where Self: Sized + Message,

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

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

where Self: Sized + Message,

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 TVCaptionButtonView

fn canBecomeFocused(&self) -> bool

where Self: Sized + Message,

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,

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

fn focusGroupPriority(&self) -> isize

where Self: Sized + Message,

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,

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,

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.

impl UIFocusItemContainer for TVCaptionButtonView

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

where Self: Sized + Message,

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,

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

impl UIResponderStandardEditActions for TVCaptionButtonView

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl UITraitEnvironment for TVCaptionButtonView

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

where Self: Sized + Message,

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

where Self: Sized + Message,

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

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

impl DowncastTarget for TVCaptionButtonView

impl Eq for TVCaptionButtonView

impl UIAppearanceContainer for TVCaptionButtonView