Struct UIView

Source

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

Available on crate features UIResponder and UIView only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIView

UIAccessibilityInvertColors.

Source

pub unsafe fn accessibilityIgnoresInvertColors(&self) -> bool

Available on crate feature UIAccessibilityAdditions only.

Source

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

Available on crate feature UIAccessibilityAdditions only.

Setter for accessibilityIgnoresInvertColors.

Source §

impl UIView

This impl block contains no items.

UIAccessibility.

Source §

impl UIView

UIHoverStyle.

Source

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

Available on crate feature UIHoverStyle only.

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

Source

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

Available on crate feature UIHoverStyle only.

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

Setter for largeContentImageInsets.

Source §

impl UIView

This impl block contains no items.

Source

pub fn layerClass(mtm: MainThreadMarker) -> &'static AnyClass

Source

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

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

Source §

Available on crate feature objc2-core-foundation only.

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

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

Source

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

Available on crate feature objc2-core-foundation only.

Source

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

Available on crate feature objc2-core-foundation only.

Source

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

Available on crate feature objc2-core-foundation only.

Available on crate feature objc2-core-foundation only.

Source

pub unsafe fn sizeToFit(&self)

Source §

impl UIView

UIViewHierarchy.

Source

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

Source

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

Source

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

Available on crate feature UIWindow only.

pub unsafe fn layoutMargins(&self) -> UIEdgeInsets

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

Source

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

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

Setter for layoutMargins.

Source

pub unsafe fn directionalLayoutMargins(&self) -> NSDirectionalEdgeInsets

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

Source

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

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

Source

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

Available on crate feature UILayoutGuide only.

Source

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

Available on crate features UIKeyboardLayoutGuide and UILayoutGuide and UITrackingLayoutGuide only.

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

Source §

impl UIView

UIViewRendering.

Available on crate feature UIColor only.

Source

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

Available on crate feature UIColor only.

Setter for backgroundColor.

Source

pub unsafe fn alpha(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

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

Available on crate feature objc2-core-foundation only.

Source

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

👎Deprecated

Available on crate feature objc2-core-foundation only.

Setter for contentStretch.

Source

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

Source

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

Setter for maskView.

Source

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

Available on crate feature UIColor only.

Source

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

Available on crate feature UIColor only.

Source

pub unsafe fn performWithoutAnimation( actions_without_animation: &DynBlock<dyn Fn() + '_>, mtm: MainThreadMarker, )

Available on crate feature block2 only.

Source

Available on crate feature UIGestureRecognizer only.

Source

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

Available on crate feature UIMotionEffect only.

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

Source

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

Available on crate feature UIMotionEffect only.

Source

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

Available on crate feature UIMotionEffect only.

pub unsafe fn translatesAutoresizingMaskIntoConstraints(&self) -> bool

Source

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

Setter for translatesAutoresizingMaskIntoConstraints.

Source

Source

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

Source

pub unsafe fn intrinsicContentSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

Source

Available on crate feature NSLayoutConstraint only.

Source

Source §

impl UIView

UISnapshotting.

Source

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.

Source §

impl UIView

Source

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

Available on crate feature UITraitCollection only.

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

Source

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

Source

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

Available on crate feature UIMenuBuilder only.

Source

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

Available on crate features UICommand and UIMenuElement only.

Source

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

Source

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

Source

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

Available on crate features UICommand and UIKeyCommand and UIMenuElement only.

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

Available on crate features UIInputViewController and UIViewController only.

Source

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

Available on crate feature UITextInput only.

Source

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

Source

pub unsafe fn reloadInputViews(&self)

Source

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

Source

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

Setter for userActivity.

Source

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

Source

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

Source

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

Source

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

Available on crate features UIResponder_UIActivityItemsConfiguration and UIActivityItemsConfigurationReading only.

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

Source

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.

Source

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

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

Source §

type Super = UIResponder

The superclass of this class. Read more

Source §

type ThreadKind = dyn MainThreadOnly

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

Source §

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more

Dereferences the value.

Source §

impl Hash for UIView

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Message for UIView

Source §

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more

Source §

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. Read more

Source §

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

Source §

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

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

1.0.0 · Source§

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

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

Source §

impl RefEncode for UIView

Source §

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

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

Available on crate feature UIAppearance only.

Source §

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

Available on crate features UIAppearance and UITraitCollection only.

Source §

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.

Source §

Source §

unsafe fn center(&self) -> CGPoint
where Self: Sized + Message,

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

Source §

unsafe fn setCenter(&self, center: CGPoint)
where Self: Sized + Message,

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

Setter for center.

Source §

unsafe fn bounds(&self) -> CGRect
where Self: Sized + Message,

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

Source §

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

Source §

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

Struct UIViewCopy item path

Implementations§

impl UIView

pub unsafe fn accessibilityIgnoresInvertColors(&self) -> bool

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

impl UIView

impl UIView

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

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

impl UIView

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

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

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

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

impl UIView

pub unsafe fn showsLargeContentViewer(&self) -> bool

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

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

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

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

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

pub unsafe fn scalesLargeContentImage(&self) -> bool

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

pub unsafe fn largeContentImageInsets(&self) -> UIEdgeInsets

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

impl UIView

impl UIView

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

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

impl UIView

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

impl UIView

pub fn layerClass(mtm: MainThreadMarker) -> &'static AnyClass

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

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

pub unsafe fn isUserInteractionEnabled(&self) -> bool

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

pub unsafe fn tag(&self) -> NSInteger

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

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

pub unsafe fn canBecomeFocused(&self) -> bool

pub unsafe fn isFocused(&self) -> bool

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

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

pub unsafe fn focusGroupPriority(&self) -> UIFocusGroupPriority

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

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

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

pub unsafe fn semanticContentAttribute(&self) -> UISemanticContentAttribute

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

pub unsafe fn userInterfaceLayoutDirectionForSemanticContentAttribute( attribute: UISemanticContentAttribute, mtm: MainThreadMarker, ) -> UIUserInterfaceLayoutDirection

pub unsafe fn userInterfaceLayoutDirectionForSemanticContentAttribute_relativeToLayoutDirection( semantic_content_attribute: UISemanticContentAttribute, layout_direction: UIUserInterfaceLayoutDirection, mtm: MainThreadMarker, ) -> UIUserInterfaceLayoutDirection

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

impl UIView

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

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

impl UIView

pub fn frame(&self) -> CGRect

pub fn setFrame(&self, frame: CGRect)

pub fn bounds(&self) -> CGRect

pub fn setBounds(&self, bounds: CGRect)

pub unsafe fn center(&self) -> CGPoint

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

pub unsafe fn transform(&self) -> CGAffineTransform

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

pub unsafe fn transform3D(&self) -> CATransform3D

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

pub fn contentScaleFactor(&self) -> CGFloat

pub fn setContentScaleFactor(&self, content_scale_factor: CGFloat)

pub unsafe fn anchorPoint(&self) -> CGPoint

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

pub unsafe fn isMultipleTouchEnabled(&self) -> bool

pub fn setMultipleTouchEnabled(&self, multiple_touch_enabled: bool)

pub unsafe fn isExclusiveTouch(&self) -> bool

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

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

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

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

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

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

Struct UIView