Struct NSCustomImageRep

Source

pub struct NSCustomImageRep { /* private fields */ }

Available on crate features NSCustomImageRep and NSImageRep only.

Expand description

Apple’s documentation

Implementations§

Source §

impl NSCustomImageRep

Source

pub fn initWithSize_flipped_drawingHandler( this: Allocated<Self>, size: NSSize, drawing_handler_should_be_called_with_flipped_context: bool, drawing_handler: &DynBlock<dyn Fn(NSRect) -> Bool>, ) -> Retained<Self>

Available on crate feature block2 only.

Source

pub fn drawingHandler(&self) -> *mut DynBlock<dyn Fn(NSRect) -> Bool>

Available on crate feature block2 only.

Source

pub unsafe fn initWithDrawSelector_delegate( this: Allocated<Self>, selector: Sel, delegate: &AnyObject, ) -> Retained<Self>

§Safety

selector must be a valid selector.
delegate should be of the correct type.

Source

pub fn drawSelector(&self) -> Option<Sel>

Source

pub fn delegate(&self) -> Option<Retained<AnyObject>>

Source §

impl NSCustomImageRep

Methods declared on superclass NSImageRep.

Source

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

Source

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

§Safety

coder possibly has further requirements.

Source §

impl NSCustomImageRep

Methods declared on superclass NSObject.

Source

pub fn new() -> Retained<Self>

Methods from Deref<Target = NSImageRep>§

Source

pub unsafe fn drawInRect_fromRect_operation_fraction_respectFlipped_hints( &self, dst_space_portion_rect: NSRect, src_space_portion_rect: NSRect, op: NSCompositingOperation, requested_alpha: CGFloat, respect_context_is_flipped: bool, hints: Option<&NSDictionary<NSImageHintKey, AnyObject>>, ) -> bool

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

§Safety

hints generic should be of the correct type.

Source

pub fn size(&self) -> NSSize

Source

pub fn setSize(&self, size: NSSize)

Setter for size.

Source

pub fn hasAlpha(&self) -> bool

Source

pub fn setAlpha(&self, alpha: bool)

Setter for hasAlpha.

Source

pub fn isOpaque(&self) -> bool

Source

pub fn setOpaque(&self, opaque: bool)

Setter for isOpaque.

Source

pub fn colorSpaceName(&self) -> Retained<NSColorSpaceName>

Available on crate feature NSGraphics only.

Source

pub fn setColorSpaceName(&self, color_space_name: &NSColorSpaceName)

Available on crate feature NSGraphics only.

Setter for colorSpaceName.

This is copied when set.

Source

pub fn bitsPerSample(&self) -> NSInteger

Source

pub fn setBitsPerSample(&self, bits_per_sample: NSInteger)

Setter for bitsPerSample.

Source

pub fn pixelsWide(&self) -> NSInteger

Source

pub fn setPixelsWide(&self, pixels_wide: NSInteger)

Setter for pixelsWide.

Source

pub fn pixelsHigh(&self) -> NSInteger

Source

pub fn setPixelsHigh(&self, pixels_high: NSInteger)

Setter for pixelsHigh.

Source

pub fn layoutDirection(&self) -> NSImageLayoutDirection

Source

pub fn setLayoutDirection(&self, layout_direction: NSImageLayoutDirection)

Setter for layoutDirection.

Source

pub unsafe fn CGImageForProposedRect_context_hints( &self, proposed_dest_rect: *mut NSRect, context: Option<&NSGraphicsContext>, hints: Option<&NSDictionary<NSImageHintKey, AnyObject>>, ) -> Option<Retained<CGImage>>

Available on crate feature NSGraphicsContext and crate feature objc2-core-graphics and Apple only.

§Safety

proposed_dest_rect must be a valid pointer or null.
hints generic should be of the correct type.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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

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

Source

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