Struct NSCursor

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

Available on crate feature NSCursor only.

Apple’s documentation

Implementations

impl NSCursor

pub fn initWithImage_hotSpot( this: Allocated<Self>, new_image: &NSImage, point: NSPoint, ) -> Retained<Self>

Available on crate feature NSImage only.

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

pub unsafe fn image(&self) -> Retained<NSImage>

Available on crate feature NSImage only.

pub unsafe fn hotSpot(&self) -> NSPoint

pub unsafe fn hide()

pub unsafe fn unhide()

pub unsafe fn setHiddenUntilMouseMoves(flag: bool)

pub unsafe fn pop_class()

pub unsafe fn pop(&self)

pub unsafe fn push(&self)

pub unsafe fn set(&self)

pub unsafe fn currentCursor() -> Retained<NSCursor>

Returns the application’s current cursor.

• Note: This isn’t necessarily the cursor that is currently being displayed, as the system may be showing the cursor for another running application.

pub fn arrowCursor() -> Retained<NSCursor>

Returns the default cursor, the arrow cursor.

• Discussion: The default cursor, a slanted arrow with its hot spot at the tip. The arrow cursor is the one you’re used to seeing over buttons, scrollers, and many other objects in the window system.

pub fn crosshairCursor() -> Retained<NSCursor>

pub fn disappearingItemCursor() -> Retained<NSCursor>

pub fn operationNotAllowedCursor() -> Retained<NSCursor>

pub fn dragLinkCursor() -> Retained<NSCursor>

pub fn dragCopyCursor() -> Retained<NSCursor>

pub fn contextualMenuCursor() -> Retained<NSCursor>

pub fn pointingHandCursor() -> Retained<NSCursor>

pub fn closedHandCursor() -> Retained<NSCursor>

pub fn openHandCursor() -> Retained<NSCursor>

pub fn IBeamCursor() -> Retained<NSCursor>

pub fn IBeamCursorForVerticalLayout() -> Retained<NSCursor>

pub unsafe fn zoomInCursor() -> Retained<NSCursor>

Returns the zoom-in cursor.

• Note: This cursor is used to indicate zooming in on (magnifying) a canvas or object.

pub unsafe fn zoomOutCursor() -> Retained<NSCursor>

Returns the zoom-out cursor.

• Note: This cursor is used to indicate zooming out of a canvas or object.

pub unsafe fn columnResizeCursor() -> Retained<NSCursor>

Returns the cursor for resizing a column (vertical divider) in either direction.

pub unsafe fn columnResizeCursorInDirections( directions: NSHorizontalDirections, ) -> Retained<NSCursor>

Available on crate feature NSDirection only.

Returns the cursor for resizing a column (vertical divider) in the specified directions.

• Parameter directions: The direction in which a column can be resized.

pub unsafe fn rowResizeCursor() -> Retained<NSCursor>

Returns the cursor for resizing a row (horizontal divider) in either direction.

pub unsafe fn rowResizeCursorInDirections( directions: NSVerticalDirections, ) -> Retained<NSCursor>

Available on crate feature NSDirection only.

Returns the cursor for resizing a row (horizontal divider) in the specified directions.

• Parameter directions: The direction in which a row can be resized.

pub unsafe fn frameResizeCursorFromPosition_inDirections( position: NSCursorFrameResizePosition, directions: NSCursorFrameResizeDirections, ) -> Retained<NSCursor>

Returns the cursor for resizing a rectangular frame from the specified edge or corner.

• Parameters:
• position: The position along the perimeter of a rectangular frame (its edges and corners) from which it’s resized.
• directions: The directions in which a rectangular frame can be resized.

impl NSCursor

Methods declared on superclass NSObject.

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

pub unsafe fn new() -> Retained<Self>

impl NSCursor

Deprecated.

pub unsafe fn currentSystemCursor() -> Option<Retained<NSCursor>>

👎Deprecated: No longer recommended. Use ScreenCaptureKit to capture the screen. Use the showsCursor property on SCStreamConfiguration to control whether or not to include the cursor in the capture. Or, use NSCursor.currentCursor if needing to just get the current cursor for this application.

This property will always be nil in a future version of macOS.

pub fn resizeLeftCursor() -> Retained<NSCursor>

👎Deprecated: Use either +[NSCursor columnResizeCursorInDirections:] or +[NSCursor frameResizeCursorFromPosition:inDirections:] instead, depending on whether a divider is being re-positioned or a rectangular frame is being resized.

pub fn resizeRightCursor() -> Retained<NSCursor>

👎Deprecated: Use either +[NSCursor columnResizeCursorInDirections:] or +[NSCursor frameResizeCursorFromPosition:inDirections:] instead, depending on whether a divider is being re-positioned or a rectangular frame is being resized.

pub fn resizeLeftRightCursor() -> Retained<NSCursor>

👎Deprecated: Use either +[NSCursor columnResizeCursorInDirections:] or +[NSCursor frameResizeCursorFromPosition:inDirections:] instead, depending on whether a divider is being re-positioned or a rectangular frame is being resized.

pub fn resizeUpCursor() -> Retained<NSCursor>

👎Deprecated: Use either +[NSCursor rowResizeCursorInDirections:] or +[NSCursor frameResizeCursorFromPosition:inDirections:] instead, depending on whether a divider is being re-positioned or a rectangular frame is being resized.

pub fn resizeDownCursor() -> Retained<NSCursor>

👎Deprecated: Use either +[NSCursor rowResizeCursorInDirections:] or +[NSCursor frameResizeCursorFromPosition:inDirections:] instead, depending on whether a divider is being re-positioned or a rectangular frame is being resized.

pub fn resizeUpDownCursor() -> Retained<NSCursor>

👎Deprecated: Use either +[NSCursor rowResizeCursorInDirections:] or +[NSCursor frameResizeCursorFromPosition:inDirections:] instead, depending on whether a divider is being re-positioned or a rectangular frame is being resized.

impl NSCursor

NSDeprecated.

pub unsafe fn initWithImage_foregroundColorHint_backgroundColorHint_hotSpot( this: Allocated<Self>, new_image: &NSImage, fg: Option<&NSColor>, bg: Option<&NSColor>, hot_spot: NSPoint, ) -> Retained<Self>

👎Deprecated: Color hints are ignored. Use -initWithImage:hotSpot: instead

Available on crate features NSColor and NSImage only.

pub unsafe fn setOnMouseExited(&self, flag: bool)

👎Deprecated: setOnMouseExited is unused and should not be called

pub unsafe fn setOnMouseEntered(&self, flag: bool)

👎Deprecated: setOnMouseEntered is unused and should not be called

pub unsafe fn isSetOnMouseExited(&self) -> bool

👎Deprecated: isSetOnMouseExited is unused

pub unsafe fn isSetOnMouseEntered(&self) -> bool

👎Deprecated: isSetOnMouseEntered is unused

pub unsafe fn mouseEntered(&self, event: &NSEvent)

👎Deprecated: mouseEntered: is unused and should not be called

Available on crate feature NSEvent only.

pub unsafe fn mouseExited(&self, event: &NSEvent)

👎Deprecated: mouseExited: is unused and should not be called

Available on crate feature NSEvent 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 NSAccessibilityConstants 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 NSAccessibilityConstants 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 NSAccessibilityConstants 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 NSCursor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSCursor> for NSCursor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSCursor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSCursor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSCursor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSCursor

const NAME: &'static str = "NSCursor"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSCursor 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 NSCursor

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

Formats the value using the given formatter.

impl Deref for NSCursor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSCursor

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 NSCursor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSCursor

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 NSCursor

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 NSSecureCoding for NSCursor

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSCursor

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 NSCursor

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

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

impl DowncastTarget for NSCursor

impl Eq for NSCursor