Struct TVCollectionViewFullScreenLayoutAttributes 

pub struct TVCollectionViewFullScreenLayoutAttributes { /* private fields */ }

Available on crate feature TVCollectionViewFullScreenLayout only.

Apple’s documentation

Implementations

impl TVCollectionViewFullScreenLayoutAttributes

pub unsafe fn cornerRadius(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setCornerRadius(&self, corner_radius: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for cornerRadius.

pub unsafe fn contentBleed(&self) -> UIEdgeInsets

pub unsafe fn setContentBleed(&self, content_bleed: UIEdgeInsets)

Setter for contentBleed.

pub unsafe fn normalizedPosition(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setNormalizedPosition(&self, normalized_position: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for normalizedPosition.

pub unsafe fn maskAmount(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setMaskAmount(&self, mask_amount: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for maskAmount.

pub unsafe fn parallaxOffset(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setParallaxOffset(&self, parallax_offset: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for parallaxOffset.

impl TVCollectionViewFullScreenLayoutAttributes

Methods declared on superclass UICollectionViewLayoutAttributes.

pub unsafe fn layoutAttributesForCellWithIndexPath( index_path: &NSIndexPath, mtm: MainThreadMarker, ) -> Retained<Self>

pub unsafe fn layoutAttributesForSupplementaryViewOfKind_withIndexPath( element_kind: &NSString, index_path: &NSIndexPath, mtm: MainThreadMarker, ) -> Retained<Self>

pub unsafe fn layoutAttributesForDecorationViewOfKind_withIndexPath( decoration_view_kind: &NSString, index_path: &NSIndexPath, mtm: MainThreadMarker, ) -> Retained<Self>

impl TVCollectionViewFullScreenLayoutAttributes

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = UICollectionViewLayoutAttributes>

pub fn frame(&self) -> CGRect

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

pub fn center(&self) -> CGPoint

pub fn setCenter(&self, center: CGPoint)

Setter for center.

pub fn size(&self) -> CGSize

pub fn setSize(&self, size: CGSize)

Setter for size.

pub fn bounds(&self) -> CGRect

pub fn setBounds(&self, bounds: CGRect)

Setter for bounds.

pub fn transform(&self) -> CGAffineTransform

pub fn setTransform(&self, transform: CGAffineTransform)

Setter for transform.

pub fn alpha(&self) -> f64

pub fn setAlpha(&self, alpha: f64)

Setter for alpha.

pub fn zIndex(&self) -> isize

pub fn setZIndex(&self, z_index: isize)

Setter for zIndex.

pub fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

pub fn indexPath(&self) -> Retained<NSIndexPath>

pub fn setIndexPath(&self, index_path: &NSIndexPath)

Setter for indexPath.

pub fn representedElementCategory(&self) -> UICollectionElementCategory

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

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 TVCollectionViewFullScreenLayoutAttributes

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for TVCollectionViewFullScreenLayoutAttributes

fn as_ref(&self) -> &NSObject

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

impl AsRef<TVCollectionViewFullScreenLayoutAttributes> for TVCollectionViewFullScreenLayoutAttributes

fn as_ref(&self) -> &Self

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

impl AsRef<UICollectionViewLayoutAttributes> for TVCollectionViewFullScreenLayoutAttributes

fn as_ref(&self) -> &UICollectionViewLayoutAttributes

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

impl Borrow<AnyObject> for TVCollectionViewFullScreenLayoutAttributes

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for TVCollectionViewFullScreenLayoutAttributes

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UICollectionViewLayoutAttributes> for TVCollectionViewFullScreenLayoutAttributes

fn borrow(&self) -> &UICollectionViewLayoutAttributes

Immutably borrows from an owned value.

impl ClassType for TVCollectionViewFullScreenLayoutAttributes

const NAME: &'static str = "TVCollectionViewFullScreenLayoutAttributes"

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

type Super = UICollectionViewLayoutAttributes

The superclass of this class.

type ThreadKind = <<TVCollectionViewFullScreenLayoutAttributes 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 CopyingHelper for TVCollectionViewFullScreenLayoutAttributes

type Result = TVCollectionViewFullScreenLayoutAttributes

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for TVCollectionViewFullScreenLayoutAttributes

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

Formats the value using the given formatter.

impl Deref for TVCollectionViewFullScreenLayoutAttributes

type Target = UICollectionViewLayoutAttributes

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for TVCollectionViewFullScreenLayoutAttributes

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 TVCollectionViewFullScreenLayoutAttributes

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for TVCollectionViewFullScreenLayoutAttributes

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for TVCollectionViewFullScreenLayoutAttributes

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 TVCollectionViewFullScreenLayoutAttributes

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 TVCollectionViewFullScreenLayoutAttributes

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

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

impl UIDynamicItem for TVCollectionViewFullScreenLayoutAttributes

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 DowncastTarget for TVCollectionViewFullScreenLayoutAttributes

impl Eq for TVCollectionViewFullScreenLayoutAttributes