Struct UIPageControlTimerProgress

Source

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

Available on crate feature UIPageControlProgress only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIPageControlTimerProgress

Source

pub unsafe fn initWithPreferredDuration( this: Allocated<Self>, preferred_duration: NSTimeInterval, ) -> Retained<Self>

Creates a time interval progress with a specified preferred duration.

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn UIPageControlTimerProgressDelegate>>>

An object that defines the delegate of the page control progress.

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn UIPageControlTimerProgressDelegate>>, )

This is a weak property. Setter for delegate.

Source

pub unsafe fn resetsToInitialPageAfterEnd(&self) -> bool

Determines if the page control should loop back to page 0 after the last page. Default is NO.

Source

pub unsafe fn setResetsToInitialPageAfterEnd( &self, resets_to_initial_page_after_end: bool, )

Setter for resetsToInitialPageAfterEnd.

Source

pub unsafe fn isRunning(&self) -> bool

Returns YES if the timer is currently active.

Source

pub unsafe fn resumeTimer(&self)

Resume the timer if it is not currently active.

Source

pub unsafe fn pauseTimer(&self)

Pause the timer if it is active.

Source

pub unsafe fn preferredDuration(&self) -> NSTimeInterval

The preferred duration for the time interval progress, used when there is no custom page duration set for the current page. The preferred duration must be greater than 0.0

Source

pub unsafe fn setPreferredDuration(&self, preferred_duration: NSTimeInterval)

Setter for preferredDuration.

Source

pub unsafe fn setDuration_forPage( &self, duration: NSTimeInterval, page: NSInteger, )

Sets a custom duration for the specified page. Set 0.0 to remove the custom duration for the specified page.

Source

pub unsafe fn durationForPage(&self, page: NSInteger) -> NSTimeInterval

Returns the duration for the specified page, and preferredDuration when there is no custom duration set for the specified page.

Source

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

Source

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

Methods from Deref<Target = UIPageControlProgress>§

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn UIPageControlProgressDelegate>>>

An object that defines the delegate of the page control progress.

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn UIPageControlProgressDelegate>>, )

This is a weak property. Setter for delegate.

Source

pub unsafe fn currentProgress(&self) -> c_float

The current progress value of the active page control indicator, between 0 and 1. Values outside of [0…1] will be clamped.

Source

pub unsafe fn setCurrentProgress(&self, current_progress: c_float)

Setter for currentProgress.

Source

pub unsafe fn isProgressVisible(&self) -> bool

Returns YES if the progress indicator is visible. The progress indicator is hidden when the user is actively interacting with the UIPageControl.

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

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

Source

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