Struct IKSlideshow

Source

pub struct IKSlideshow { /* private fields */ }

Available on crate feature IKSlideshow only.

Expand description

IKSlideshow handles a slideshow with images, PDFs & more.

Implementations§

Source §

impl IKSlideshow

Source

pub unsafe fn autoPlayDelay(&self) -> NSTimeInterval

Available on crate feature ImageKit only.

Array of filters reflecting the current user adjustments in the adjust or effects tab.

Source

pub unsafe fn setAutoPlayDelay(&self, auto_play_delay: NSTimeInterval)

Available on crate feature ImageKit only.

Setter for autoPlayDelay.

Source

pub unsafe fn sharedSlideshow() -> Option<Retained<IKSlideshow>>

Available on crate feature ImageKit only.

shared instance of the IKSlideshow.

Source

pub unsafe fn runSlideshowWithDataSource_inMode_options( &self, data_source: Option<&ProtocolObject<dyn IKSlideshowDataSource>>, slideshow_mode: Option<&NSString>, slideshow_options: Option<&NSDictionary>, )

Available on crate feature ImageKit only.

start the slideshow (slideshowOptions can be NULL).

§Safety

data_source might not allow None.
slideshow_mode might not allow None.
slideshow_options generic should be of the correct type.
slideshow_options might not allow None.

Source

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

Available on crate feature ImageKit only.

stop the slideshow.

§Safety

sender should be of the correct type.
sender might not allow None.

Source

pub unsafe fn reloadData(&self)

Available on crate feature ImageKit only.

reloadData.

Source

pub unsafe fn reloadSlideshowItemAtIndex(&self, index: NSUInteger)

Available on crate feature ImageKit only.

reloadSlideshowItemAtIndex.

Source

pub unsafe fn indexOfCurrentSlideshowItem(&self) -> NSUInteger

Available on crate feature ImageKit only.

Returns index of current slideshow item.

Source

pub unsafe fn canExportToApplication( application_bundle_identifier: Option<&NSString>, ) -> bool

Available on crate feature ImageKit only.

Is exporting to a given application possible (application installed?, right version?, …).

§Safety

application_bundle_identifier might not allow None.

Source

pub unsafe fn exportSlideshowItem_toApplication( item: Option<&AnyObject>, application_bundle_identifier: Option<&NSString>, )

Available on crate feature ImageKit only.

export an item to the given application.

The item can be either: NSImage, NSString, NSURL, or a NSArray of NSImage / NSString / NSURL.

§Safety

item should be of the correct type.
item might not allow None.
application_bundle_identifier might not allow None.

Source §

impl IKSlideshow

Methods declared on superclass NSObject.

Source

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

Available on crate feature ImageKit only.

Source

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

Available on crate feature ImageKit only.

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

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.

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,

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