#[repr(C)]pub struct NSRulerMarker { /* private fields */ }
NSRulerMarker
only.Expand description
Implementations§
Source§impl NSRulerMarker
impl NSRulerMarker
Sourcepub unsafe fn initWithRulerView_markerLocation_image_imageOrigin(
this: Allocated<Self>,
ruler: &NSRulerView,
location: CGFloat,
image: &NSImage,
image_origin: NSPoint,
) -> Retained<Self>
Available on crate features NSImage
and NSResponder
and NSRulerView
and NSView
and objc2-core-foundation
only.
pub unsafe fn initWithRulerView_markerLocation_image_imageOrigin( this: Allocated<Self>, ruler: &NSRulerView, location: CGFloat, image: &NSImage, image_origin: NSPoint, ) -> Retained<Self>
NSImage
and NSResponder
and NSRulerView
and NSView
and objc2-core-foundation
only.************************** Initialization ***************************
pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Retained<Self>
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
Sourcepub unsafe fn ruler(
&self,
mtm: MainThreadMarker,
) -> Option<Retained<NSRulerView>>
Available on crate features NSResponder
and NSRulerView
and NSView
only.
pub unsafe fn ruler( &self, mtm: MainThreadMarker, ) -> Option<Retained<NSRulerView>>
NSResponder
and NSRulerView
and NSView
only.********************* Query/Set basic attributes **********************
pub unsafe fn markerLocation(&self) -> CGFloat
objc2-core-foundation
only.Sourcepub unsafe fn setMarkerLocation(&self, marker_location: CGFloat)
Available on crate feature objc2-core-foundation
only.
pub unsafe fn setMarkerLocation(&self, marker_location: CGFloat)
objc2-core-foundation
only.Setter for markerLocation
.
pub unsafe fn image(&self) -> Retained<NSImage>
NSImage
only.Sourcepub unsafe fn setImage(&self, image: &NSImage)
Available on crate feature NSImage
only.
pub unsafe fn setImage(&self, image: &NSImage)
NSImage
only.Setter for image
.
pub unsafe fn imageOrigin(&self) -> NSPoint
Sourcepub unsafe fn setImageOrigin(&self, image_origin: NSPoint)
pub unsafe fn setImageOrigin(&self, image_origin: NSPoint)
Setter for imageOrigin
.
pub unsafe fn isMovable(&self) -> bool
Sourcepub unsafe fn setMovable(&self, movable: bool)
pub unsafe fn setMovable(&self, movable: bool)
Setter for isMovable
.
pub unsafe fn isRemovable(&self) -> bool
Sourcepub unsafe fn setRemovable(&self, removable: bool)
pub unsafe fn setRemovable(&self, removable: bool)
Setter for isRemovable
.
pub unsafe fn isDragging(&self) -> bool
pub unsafe fn representedObject( &self, ) -> Option<Retained<ProtocolObject<dyn NSCopying>>>
Sourcepub unsafe fn setRepresentedObject(
&self,
represented_object: Option<&ProtocolObject<dyn NSCopying>>,
)
pub unsafe fn setRepresentedObject( &self, represented_object: Option<&ProtocolObject<dyn NSCopying>>, )
Setter for representedObject
.
Sourcepub unsafe fn imageRectInRuler(&self) -> NSRect
pub unsafe fn imageRectInRuler(&self) -> NSRect
************************ Ruler facilities *************************
pub unsafe fn thicknessRequiredInRuler(&self) -> CGFloat
objc2-core-foundation
only.pub unsafe fn drawRect(&self, rect: NSRect)
pub unsafe fn trackMouse_adding( &self, mouse_down_event: &NSEvent, is_adding: bool, ) -> bool
NSEvent
only.Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
Available on crate feature NSAccessibilityConstants
only.
pub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.Available on crate feature NSAccessibilityConstants
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Available on crate feature NSAccessibilityConstants
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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`
}
}
Trait Implementations§
Source§impl AsRef<AnyObject> for NSRulerMarker
impl AsRef<AnyObject> for NSRulerMarker
Source§impl AsRef<NSObject> for NSRulerMarker
impl AsRef<NSObject> for NSRulerMarker
Source§impl AsRef<NSRulerMarker> for NSRulerMarker
impl AsRef<NSRulerMarker> for NSRulerMarker
Source§impl Borrow<AnyObject> for NSRulerMarker
impl Borrow<AnyObject> for NSRulerMarker
Source§impl Borrow<NSObject> for NSRulerMarker
impl Borrow<NSObject> for NSRulerMarker
Source§impl ClassType for NSRulerMarker
impl ClassType for NSRulerMarker
Source§const NAME: &'static str = "NSRulerMarker"
const NAME: &'static str = "NSRulerMarker"
Source§type ThreadKind = <<NSRulerMarker as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSRulerMarker as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for NSRulerMarker
impl CopyingHelper for NSRulerMarker
Source§type Result = NSRulerMarker
type Result = NSRulerMarker
Self
if the type has no
immutable counterpart. Read moreSource§impl Debug for NSRulerMarker
impl Debug for NSRulerMarker
Source§impl Deref for NSRulerMarker
impl Deref for NSRulerMarker
Source§impl Hash for NSRulerMarker
impl Hash for NSRulerMarker
Source§impl Message for NSRulerMarker
impl Message for NSRulerMarker
Source§impl NSCoding for NSRulerMarker
impl NSCoding for NSRulerMarker
Source§impl NSCopying for NSRulerMarker
impl NSCopying for NSRulerMarker
Source§impl NSObjectProtocol for NSRulerMarker
impl NSObjectProtocol for NSRulerMarker
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref