Struct UIKeyboardLayoutGuide

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

Available on crate features UIKeyboardLayoutGuide and UILayoutGuide and UITrackingLayoutGuide only.

Apple’s documentation

Implementations

impl UIKeyboardLayoutGuide

pub unsafe fn followsUndockedKeyboard(&self) -> bool

Defaults to NO.

pub unsafe fn setFollowsUndockedKeyboard(&self, follows_undocked_keyboard: bool)

Setter for followsUndockedKeyboard.

pub unsafe fn usesBottomSafeArea(&self) -> bool

Defaults to YES.When the keyboard is offscreen, the layout guide is tied to the bottomAnchor of the view’s safeAreaLayoutGuide. Set this to NOto instead have the guide use the bottomAnchor of the view.

pub unsafe fn setUsesBottomSafeArea(&self, uses_bottom_safe_area: bool)

Setter for usesBottomSafeArea.

pub unsafe fn keyboardDismissPadding(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Defaults to 0.0. When a user scrolls to dismiss the keyboard (see UIScrollViewKeyboardDismissMode),the gesture waits to start the dismiss until it intersects with the keyboard. This adds padding above the keyboard to start the dismiss earlier. Negative values will be treated as 0.

pub unsafe fn setKeyboardDismissPadding( &self, keyboard_dismiss_padding: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for keyboardDismissPadding.

impl UIKeyboardLayoutGuide

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

pub unsafe fn setConstraints_activeWhenNearEdge( &self, tracking_constraints: &NSArray<NSLayoutConstraint>, edge: NSDirectionalRectEdge, )

Available on crate features NSLayoutConstraint and UIGeometry only.

Parameter trackingConstraints: Constraints to activate when the guide is close to the specified edge, and deactivate when it moves away. Sending nil will deactivate any currently active constraints associated with this edge and remove them from tracking.

Parameter edge: When the tracking layout guide is close to this edge, specified constraints will change

pub unsafe fn constraintsActiveWhenNearEdge( &self, edge: NSDirectionalRectEdge, ) -> Retained<NSArray<NSLayoutConstraint>>

Available on crate features NSLayoutConstraint and UIGeometry only.

pub unsafe fn setConstraints_activeWhenAwayFromEdge( &self, tracking_constraints: &NSArray<NSLayoutConstraint>, edge: NSDirectionalRectEdge, )

Available on crate features NSLayoutConstraint and UIGeometry only.

Parameter trackingConstraints: Constraints to deactivate when the guide is close to the specified edge, and activate when it moves away. Sending nil will remove the constraints associated with this edge from tracking.

Parameter edge: When the tracking layout guide is close to this edge, specified constraints will change

pub unsafe fn constraintsActiveWhenAwayFromEdge( &self, edge: NSDirectionalRectEdge, ) -> Retained<NSArray<NSLayoutConstraint>>

Available on crate features NSLayoutConstraint and UIGeometry only.

pub unsafe fn removeAllTrackedConstraints(&self)

Manually remove all constraints from this guide’s tracking.

Methods from Deref<Target = UILayoutGuide>

pub unsafe fn layoutFrame(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

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

Available on crate features UIResponder and UIView only.

pub unsafe fn setOwningView(&self, owning_view: Option<&UIView>)

Available on crate features UIResponder and UIView only.

This is a weak property. Setter for owningView.

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

pub unsafe fn setIdentifier(&self, identifier: &NSString)

Setter for identifier.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate feature NSLayoutAnchor only.

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

Available on crate features UIView and NSLayoutConstraint only.

pub unsafe fn hasAmbiguousLayout(&self) -> bool

Available on crate feature UIView only.

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 UIKeyboardLayoutGuide

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIKeyboardLayoutGuide

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIKeyboardLayoutGuide> for UIKeyboardLayoutGuide

fn as_ref(&self) -> &Self

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

impl AsRef<UILayoutGuide> for UIKeyboardLayoutGuide

fn as_ref(&self) -> &UILayoutGuide

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

impl AsRef<UITrackingLayoutGuide> for UIKeyboardLayoutGuide

fn as_ref(&self) -> &UITrackingLayoutGuide

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

impl Borrow<AnyObject> for UIKeyboardLayoutGuide

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIKeyboardLayoutGuide

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UILayoutGuide> for UIKeyboardLayoutGuide

fn borrow(&self) -> &UILayoutGuide

Immutably borrows from an owned value.

impl Borrow<UITrackingLayoutGuide> for UIKeyboardLayoutGuide

fn borrow(&self) -> &UITrackingLayoutGuide

Immutably borrows from an owned value.

impl ClassType for UIKeyboardLayoutGuide

const NAME: &'static str = "UIKeyboardLayoutGuide"

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

type Super = UITrackingLayoutGuide

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 UIKeyboardLayoutGuide

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

Formats the value using the given formatter.

impl Deref for UIKeyboardLayoutGuide

type Target = UITrackingLayoutGuide

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIKeyboardLayoutGuide

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 UIKeyboardLayoutGuide

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for UIKeyboardLayoutGuide

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSObjectProtocol for UIKeyboardLayoutGuide

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 UIKeyboardLayoutGuide

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 UIKeyboardLayoutGuide

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

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

impl DowncastTarget for UIKeyboardLayoutGuide

impl Eq for UIKeyboardLayoutGuide