Struct MKMarkerAnnotationView

Source

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

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

Methods declared on superclass MKAnnotationView.

Methods from Deref<Target = MKAnnotationView>§

Source

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

Source

pub unsafe fn prepareForReuse(&self)

Source

pub unsafe fn prepareForDisplay(&self)

Source

pub unsafe fn annotation( &self, ) -> Option<Retained<ProtocolObject<dyn MKAnnotation>>>

Available on crate feature MKAnnotation only.

Source

pub unsafe fn setAnnotation( &self, annotation: Option<&ProtocolObject<dyn MKAnnotation>>, )

Available on crate feature MKAnnotation only.

Setter for annotation.

Source

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

Source

Available on crate feature objc2-core-foundation only.

Source

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

Source

pub unsafe fn setClusteringIdentifier( &self, clustering_identifier: Option<&NSString>, )

Setter for clusteringIdentifier.

Source

Setter for subviews.

pub fn setPostsFrameChangedNotifications( &self, posts_frame_changed_notifications: bool, )

Setter for postsFrameChangedNotifications.

Source

pub unsafe fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Source

Source

pub fn frame(&self) -> CGRect

Source

pub unsafe fn setFrame(&self, frame: CGRect)

Setter for frame.

Setter for bounds.

Setter for canDrawConcurrently.

Source

pub unsafe fn canDraw(&self) -> bool

👎Deprecated: If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Source

pub unsafe fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Source

pub unsafe fn needsDisplay(&self) -> bool

Source

pub unsafe fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub unsafe fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub unsafe fn setCanDrawSubviewsIntoLayer( &self, can_draw_subviews_into_layer: bool, )

Setter for canDrawSubviewsIntoLayer.

Source

pub unsafe fn layoutSubtreeIfNeeded(&self)

Source

pub unsafe fn allowsVibrancy(&self) -> bool

Source

pub unsafe fn viewDidChangeEffectiveAppearance(&self)

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

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

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Setter for nextKeyView.

Setter for additionalSafeAreaInsets.

👎Deprecated

Methods from Deref<Target = NSResponder>§

Source

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

Source

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

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

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

Source §

type Super = MKAnnotationView

The superclass of this class. Read more

Source §

type ThreadKind = <<MKMarkerAnnotationView as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread. Read more

Source §

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more

Dereferences the value.

Source §

impl Hash for MKMarkerAnnotationView

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Message for MKMarkerAnnotationView

Source §

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more

Source §

unsafe fn animationForKey(&self, key: &NSString) -> Option<Retained<AnyObject>>
where Self: Sized + Message,

Source §

unsafe fn defaultAnimationForKey(key: &NSString) -> Option<Retained<AnyObject>>
where Self: Sized + ClassType,

Source §

impl NSAppearanceCustomization for MKMarkerAnnotationView

Source §

unsafe fn appearance(&self) -> Option<Retained<NSAppearance>>
where Self: Sized + Message,

Source §

unsafe fn setAppearance(&self, appearance: Option<&NSAppearance>)
where Self: Sized + Message,

Setter for appearance.

Check whether the object is equal to an arbitrary other object. Read more

Source §

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more

Source §

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

Source §

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

Source §

unsafe fn identifier(&self) -> Option<Retained<NSString>>
where Self: Sized + Message,

Source §

unsafe fn setIdentifier(&self, identifier: Option<&NSString>)
where Self: Sized + Message,

Setter for identifier.

Source §

impl PartialEq for MKMarkerAnnotationView

Source §

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

Struct MKMarkerAnnotationViewCopy item path

Implementations§

impl MKMarkerAnnotationView

pub unsafe fn titleVisibility(&self) -> MKFeatureVisibility

pub unsafe fn setTitleVisibility(&self, title_visibility: MKFeatureVisibility)

pub unsafe fn subtitleVisibility(&self) -> MKFeatureVisibility

pub unsafe fn setSubtitleVisibility( &self, subtitle_visibility: MKFeatureVisibility, )

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

pub unsafe fn setMarkerTintColor(&self, marker_tint_color: Option<&NSColor>)

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

pub unsafe fn setGlyphTintColor(&self, glyph_tint_color: Option<&NSColor>)

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

pub unsafe fn setGlyphText(&self, glyph_text: Option<&NSString>)

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

pub unsafe fn setGlyphImage(&self, glyph_image: Option<&NSImage>)

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

pub unsafe fn setSelectedGlyphImage( &self, selected_glyph_image: Option<&NSImage>, )

pub unsafe fn animatesWhenAdded(&self) -> bool

pub unsafe fn setAnimatesWhenAdded(&self, animates_when_added: bool)

impl MKMarkerAnnotationView

pub unsafe fn initWithAnnotation_reuseIdentifier( this: Allocated<Self>, annotation: Option<&ProtocolObject<dyn MKAnnotation>>, reuse_identifier: Option<&NSString>, ) -> Retained<Self>

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

impl MKMarkerAnnotationView

pub unsafe fn initWithFrame( this: Allocated<Self>, frame_rect: NSRect, ) -> Retained<Self>

impl MKMarkerAnnotationView

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

impl MKMarkerAnnotationView

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

Methods from Deref<Target = MKAnnotationView>§

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

pub unsafe fn prepareForReuse(&self)

pub unsafe fn prepareForDisplay(&self)

pub unsafe fn annotation( &self, ) -> Option<Retained<ProtocolObject<dyn MKAnnotation>>>

pub unsafe fn setAnnotation( &self, annotation: Option<&ProtocolObject<dyn MKAnnotation>>, )

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

pub unsafe fn setImage(&self, image: Option<&NSImage>)

pub unsafe fn centerOffset(&self) -> CGPoint

pub unsafe fn setCenterOffset(&self, center_offset: CGPoint)

pub unsafe fn accessoryOffset(&self) -> CGPoint

pub unsafe fn setAccessoryOffset(&self, accessory_offset: CGPoint)

pub unsafe fn calloutOffset(&self) -> CGPoint

pub unsafe fn setCalloutOffset(&self, callout_offset: CGPoint)

pub unsafe fn leftCalloutOffset(&self) -> CGPoint

pub unsafe fn setLeftCalloutOffset(&self, left_callout_offset: CGPoint)

pub unsafe fn rightCalloutOffset(&self) -> CGPoint

pub unsafe fn setRightCalloutOffset(&self, right_callout_offset: CGPoint)

pub unsafe fn isEnabled(&self) -> bool

pub unsafe fn setEnabled(&self, enabled: bool)

pub unsafe fn isHighlighted(&self) -> bool

pub unsafe fn setHighlighted(&self, highlighted: bool)

pub unsafe fn isSelected(&self) -> bool

pub unsafe fn setSelected(&self, selected: bool)

pub unsafe fn setSelected_animated(&self, selected: bool, animated: bool)

pub unsafe fn canShowCallout(&self) -> bool

pub unsafe fn setCanShowCallout(&self, can_show_callout: bool)

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

pub unsafe fn setLeftCalloutAccessoryView( &self, left_callout_accessory_view: Option<&NSView>, )

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

pub unsafe fn setRightCalloutAccessoryView( &self, right_callout_accessory_view: Option<&NSView>, )

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

pub unsafe fn setDetailCalloutAccessoryView( &self, detail_callout_accessory_view: Option<&NSView>, )

pub unsafe fn isDraggable(&self) -> bool

pub unsafe fn setDraggable(&self, draggable: bool)

pub unsafe fn dragState(&self) -> MKAnnotationViewDragState

pub unsafe fn setDragState(&self, drag_state: MKAnnotationViewDragState)

pub unsafe fn setDragState_animated( &self, new_drag_state: MKAnnotationViewDragState, animated: bool, )

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

pub unsafe fn setClusteringIdentifier( &self, clustering_identifier: Option<&NSString>, )

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

pub unsafe fn displayPriority(&self) -> MKFeatureDisplayPriority

pub unsafe fn setDisplayPriority( &self, display_priority: MKFeatureDisplayPriority, )

pub unsafe fn zPriority(&self) -> MKAnnotationViewZPriority

pub unsafe fn setZPriority(&self, z_priority: MKAnnotationViewZPriority)

pub unsafe fn selectedZPriority(&self) -> MKAnnotationViewZPriority

pub unsafe fn setSelectedZPriority( &self, selected_z_priority: MKAnnotationViewZPriority, )

pub unsafe fn collisionMode(&self) -> MKAnnotationViewCollisionMode

pub unsafe fn setCollisionMode( &self, collision_mode: MKAnnotationViewCollisionMode, )

Methods from Deref<Target = NSView>§

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

pub unsafe fn subviews(&self) -> Retained<NSArray<NSView>>

Struct MKMarkerAnnotationView

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )