Struct EKCalendar

Source

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

Available on crate features EKCalendar and EKObject only.

Expand description

The EKCalendar class represents a calendar for events.

Implementations§

Source §

impl EKCalendar

Source

pub unsafe fn calendarWithEventStore( event_store: &EKEventStore, ) -> Retained<EKCalendar>

Available on crate feature EKEventStore only.

Source

pub unsafe fn calendarForEntityType_eventStore( entity_type: EKEntityType, event_store: &EKEventStore, ) -> Retained<EKCalendar>

Available on crate features EKEventStore and EKTypes only.

Creates a new autoreleased calendar that may contain the given entity type.

You can only create calendars that accept either reminders or events via our API. However, other servers might allow mixing the two (though it is not common).

Parameter entityType: The entity type that this calendar may support.

Parameter eventStore: The event store in which to create this calendar.

Source

pub unsafe fn source(&self) -> Option<Retained<EKSource>>

Available on crate feature EKSource only.

The source representing the ‘account’ this calendar belongs to. This is only settable when initially creating a calendar and then effectively read-only after that. That is, you can create a calendar, but you cannot move it to another source.

This will be nil for new calendars until you set it.

Source

pub unsafe fn setSource(&self, source: Option<&EKSource>)

Available on crate feature EKSource only.

Setter for source.

Source

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

A unique identifier for the calendar. It is not sync-proof in that a full sync will lose this identifier, so you should always have a back up plan for dealing with a calendar that is no longer fetchable by this property, e.g. by title, type, color, etc. Use [EKEventStore calendarWithIdentifier:] to look up the calendar by this value.

Source

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

The title of the calendar.

Source

pub unsafe fn setTitle(&self, title: &NSString)

Setter for title.

Source

pub unsafe fn type(&self) -> EKCalendarType

Available on crate feature EKTypes only.

The type of the calendar as a EKCalendarType. This is actually based on what source the calendar is in, as well as whether it is a subscribed calendar.

CalDAV subscribed calendars have type EKCalendarTypeCalDAV with isSubscribed = YES.

Source

pub unsafe fn allowsContentModifications(&self) -> bool

Represents whether you can this add, remove, or modify items in this calendar.

Source

pub unsafe fn isSubscribed(&self) -> bool

YES if this calendar is a subscribed calendar.

Source

pub unsafe fn isImmutable(&self) -> bool

If this is set to YES, it means you cannot modify any attributes of the calendar or delete it. It does NOT imply that you cannot add events or reminders to the calendar.

Source

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

Available on crate feature objc2-core-graphics only.

Returns the calendar color as a CGColorRef.

This will be nil for new calendars until you set it.

Source

pub unsafe fn setCGColor(&self, cg_color: Option<&CGColor>)

Available on crate feature objc2-core-graphics only.

Setter for CGColor.

Source

pub unsafe fn color(&self) -> Retained<NSColor>

Available on crate feature objc2-app-kit and macOS only.

Returns the calendar color as a NSColor.

This will be nil for new calendars until you set it.

Source

pub unsafe fn setColor(&self, color: Option<&NSColor>)

Available on crate feature objc2-app-kit and macOS only.

Setter for color.

Source

pub unsafe fn supportedEventAvailabilities( &self, ) -> EKCalendarEventAvailabilityMask

Available on crate feature EKTypes only.

Returns a bitfield of supported event availabilities, or EKCalendarEventAvailabilityNone if this calendar does not support setting availability on an event.

Source

pub unsafe fn allowedEntityTypes(&self) -> EKEntityMask

Available on crate feature EKTypes only.

Source §

impl EKCalendar

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = EKObject>§

Source

pub unsafe fn refresh(&self) -> bool

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