Struct ScreenSaverView 

pub struct ScreenSaverView { /* private fields */ }

Available on crate features ScreenSaverView and objc2-app-kit only.

An abstract class that defines the interface for subclassers to interact with the screen saver infrastructure.

ScreenSaverView provides the interface for your screen saver, including the content you animate onscreen and an optional configuration sheet. Create your own custom subclass and add it to your screen saver bundle. Use your subclass to create the animations that you want to appear onscreen, and to specify additional animation details.

• Note: When someone previews your screen saver in System Preferences, the system instantiates your ScreenSaverView subclass.

You can draw from your view’s ScreenSaverView/drawRect: method, or you can draw directly from the ScreenSaverView/animateOneFrame method. If you prefer to use the ScreenSaverView/drawRect: method, use the ScreenSaverView/animateOneFrame method to call the <doc ://com.apple.documentation/documentation/appkit/nsview/1483475-setneedsdisplayinrect> method and specify the portions of your view that require updates.

See also Apple’s documentation

Implementations

impl ScreenSaverView

pub unsafe fn backingStoreType(mtm: MainThreadMarker) -> NSBackingStoreType

Returns the type of backing store you want for your screen saver’s window.

Overview

This method returns <doc ://com.apple.documentation/documentation/appkit/nsbackingstoretype/nsbackingstorebuffered> by default. If you want to change the backing store type, override this method and return a new value. If you override the method, you don’t need to call the inherited version.

pub unsafe fn performGammaFade(mtm: MainThreadMarker) -> bool

Indicates whether to perform a gradual screen fade when the system starts and stops your screen saver’s animation.

Overview

This class method allows the screen saver view to select how the desktop visibly transitions to the screen saver view. When this method returns <doc ://com.apple.documentation/documentation/objectivec/yes>, the screen gradually darkens before the animation begins. When it returns <doc ://com.apple.documentation/documentation/objectivec/no>, the screen transitions immediately to the screen saver. The latter behavior is more appropriate if the screen saver animates a screenshot of the desktop, as is the case for optical lens effects. The default is <doc ://com.apple.documentation/documentation/objectivec/yes>.

pub unsafe fn initWithFrame_isPreview( this: Allocated<Self>, frame: NSRect, is_preview: bool, ) -> Option<Retained<Self>>

Creates a newly allocated screen saver view with the specified frame rectangle and preview information.

Overview

The screen saver application installs the new view object into the view hierarchy of an <doc ://com.apple.documentation/documentation/appkit/nswindow> before the animation begins. This method is the designated initializer for the ScreenSaver/ScreenSaverView class. Returns self.

• Parameters:

• frame: The frame rectangle for the view.

• isPreview: <doc ://com.apple.documentation/documentation/objectivec/yes> if this view provides a preview for system settings, or <doc ://com.apple.documentation/documentation/objectivec/no> if the system fills the screen with your view’s contents.

pub unsafe fn animationTimeInterval(&self) -> NSTimeInterval

The time interval between animation frames.

If your screen saver has particular requirements for time between animation frames, call this method to set the animation rate to a reasonable value.

pub unsafe fn setAnimationTimeInterval( &self, animation_time_interval: NSTimeInterval, )

Setter for animationTimeInterval.

pub unsafe fn startAnimation(&self)

Activates the periodic timer that animates the screen saver.

Overview

The system calls this method when it’s time for you to start animating your screen saver’s content. The system calls this method only once at the start of animations. Use this method to set up any initial state information you require or to allocate expensive resources. If you override this method, you must call the inherited implementation at some point.

See also

• ScreenSaver/ScreenSaverView/stopAnimation

pub unsafe fn stopAnimation(&self)

Deactivates the timer that advances the animation.

Overview

The system calls this method when it’s time for you to stop animating your screen saver’s content. The system calls this method only once at the end of animations. Use this method to unload expensive resources or to reset your screen saver to a known state. If you override this method, you must call the inherited implementation at some point.

See also

• ScreenSaver/ScreenSaverView/startAnimation

pub unsafe fn isAnimating(&self) -> bool

A Boolean value that indicates whether the screen saver is animating.

Overview

The value of this property is <doc ://com.apple.documentation/documentation/objectivec/yes> when the screen saver is animating, and <doc ://com.apple.documentation/documentation/objectivec/no> when it isn’t.

See also

• ScreenSaver/ScreenSaverView/stopAnimation
• ScreenSaver/ScreenSaverView/startAnimation

pub unsafe fn drawRect(&self, rect: NSRect)

Draws the screen saver view.

Overview

ScreenSaver/ScreenSaverView implements ScreenSaver/ScreenSaverView/drawRect: to draw a black background. Subclasses can do their drawing here or in ScreenSaver/ScreenSaverView/animateOneFrame.

See also

• ScreenSaver/ScreenSaverView/stopAnimation
• ScreenSaver/ScreenSaverView/animateOneFrame
• ScreenSaver/ScreenSaverView/startAnimation

pub unsafe fn animateOneFrame(&self)

Advances the screen saver’s animation by a single frame.

Overview

The system calls this method each time the timer animating the screen saver fires. The time between calls to this method is always at least ScreenSaver/ScreenSaverView/animationTimeInterval. The system locks focus on your view before it calls this method, so you can use this method to draw content. You can also let ScreenSaver/ScreenSaverView/drawRect: perform the drawing, in which case you use this method to call <doc ://com.apple.documentation/documentation/appkit/nsview/1483475-setneedsdisplayinrect> to mark your view as dirty. The default implementation of this method does nothing.

See also

• ScreenSaver/ScreenSaverView/drawRect:

pub unsafe fn hasConfigureSheet(&self) -> bool

A Boolean value that indicates whether the screen saver has an associated configuration sheet.

If you provide a configuration sheet in your bundle, override this method and return <doc ://com.apple.documentation/documentation/objectivec/yes>.

See also

• ScreenSaver/ScreenSaverView/configureSheet

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

The window that contains the controls to configure the screen saver.

The system runs this window as a sheet, so include buttons that allow the user to end the modal session in which the sheet runs. When the user dismisses the sheet, the controller in charge of the sheet must end the document modal session by calling the <doc ://com.apple.documentation/documentation/appkit/nsapplication> method <doc ://com.apple.documentation/documentation/appkit/nsapplication/1428503-endsheet> with the sheet’s window as the argument.

See also

• ScreenSaver/ScreenSaverView/hasConfigureSheet

pub unsafe fn isPreview(&self) -> bool

A Boolean value that indicates whether the screen saver view is set to a size suitable for previewing its content.

Overview

The system sets the value of this property to <doc ://com.apple.documentation/documentation/objectivec/yes> when it creates a smaller preview of your screen saver. When the value is <doc ://com.apple.documentation/documentation/objectivec/no>, your view matches the size of the screen. Use this property to adjust the content you present. For example, you might change the drawing parameters or data you display in your view.

impl ScreenSaverView

Methods declared on superclass NSView.

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

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

Safety

coder possibly has further requirements.

impl ScreenSaverView

Methods declared on superclass NSResponder.

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

impl ScreenSaverView

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSView>

pub fn window(&self) -> Option<Retained<NSWindow>>

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

Safety

This is not retained internally, you must ensure the object is still alive.

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

pub fn setSubviews(&self, subviews: &NSArray<NSView>)

Setter for subviews.

This is copied when set.

pub fn isDescendantOf(&self, view: &NSView) -> bool

pub fn ancestorSharedWithView(&self, view: &NSView) -> Option<Retained<NSView>>

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

Safety

This is not retained internally, you must ensure the object is still alive.

pub fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

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

Safety

• rects must be a valid pointer or null.
• count must be a valid pointer or null.

pub fn needsToDrawRect(&self, rect: CGRect) -> bool

pub fn wantsDefaultClipping(&self) -> bool

pub fn viewDidHide(&self)

pub fn viewDidUnhide(&self)

pub fn addSubview(&self, view: &NSView)

pub fn addSubview_positioned_relativeTo( &self, view: &NSView, place: NSWindowOrderingMode, other_view: Option<&NSView>, )

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

Safety

• compare must be implemented correctly.
• context must be a valid pointer or null.

pub fn viewWillMoveToWindow(&self, new_window: Option<&NSWindow>)

pub fn viewDidMoveToWindow(&self)

pub fn viewWillMoveToSuperview(&self, new_superview: Option<&NSView>)

pub fn viewDidMoveToSuperview(&self)

pub fn didAddSubview(&self, subview: &NSView)

pub fn willRemoveSubview(&self, subview: &NSView)

pub fn removeFromSuperview(&self)

pub fn replaceSubview_with(&self, old_view: &NSView, new_view: &NSView)

pub fn removeFromSuperviewWithoutNeedingDisplay(&self)

pub fn viewDidChangeBackingProperties(&self)

pub fn postsFrameChangedNotifications(&self) -> bool

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

Setter for postsFrameChangedNotifications.

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

pub fn resizeWithOldSuperviewSize(&self, old_size: CGSize)

pub fn autoresizesSubviews(&self) -> bool

pub fn setAutoresizesSubviews(&self, autoresizes_subviews: bool)

Setter for autoresizesSubviews.

pub fn autoresizingMask(&self) -> NSAutoresizingMaskOptions

pub fn setAutoresizingMask(&self, autoresizing_mask: NSAutoresizingMaskOptions)

Setter for autoresizingMask.

pub fn setFrameOrigin(&self, new_origin: CGPoint)

pub fn setFrameSize(&self, new_size: CGSize)

pub fn frame(&self) -> CGRect

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

pub fn setBoundsOrigin(&self, new_origin: CGPoint)

pub fn setBoundsSize(&self, new_size: CGSize)

pub fn translateOriginToPoint(&self, translation: CGPoint)

pub fn scaleUnitSquareToSize(&self, new_unit_size: CGSize)

pub fn bounds(&self) -> CGRect

pub fn setBounds(&self, bounds: CGRect)

Setter for bounds.

pub fn isFlipped(&self) -> bool

pub fn isRotatedFromBase(&self) -> bool

pub fn isRotatedOrScaledFromBase(&self) -> bool

pub fn isOpaque(&self) -> bool

pub fn convertPoint_fromView( &self, point: CGPoint, view: Option<&NSView>, ) -> CGPoint

pub fn convertPoint_toView( &self, point: CGPoint, view: Option<&NSView>, ) -> CGPoint

pub fn convertSize_fromView( &self, size: CGSize, view: Option<&NSView>, ) -> CGSize

pub fn convertSize_toView(&self, size: CGSize, view: Option<&NSView>) -> CGSize

pub fn convertRect_fromView( &self, rect: CGRect, view: Option<&NSView>, ) -> CGRect

pub fn convertRect_toView(&self, rect: CGRect, view: Option<&NSView>) -> CGRect

pub fn backingAlignedRect_options( &self, rect: CGRect, options: NSAlignmentOptions, ) -> CGRect

pub fn centerScanRect(&self, rect: CGRect) -> CGRect

pub fn convertPointToBacking(&self, point: CGPoint) -> CGPoint

pub fn convertPointFromBacking(&self, point: CGPoint) -> CGPoint

pub fn convertSizeToBacking(&self, size: CGSize) -> CGSize

pub fn convertSizeFromBacking(&self, size: CGSize) -> CGSize

pub fn convertRectToBacking(&self, rect: CGRect) -> CGRect

pub fn convertRectFromBacking(&self, rect: CGRect) -> CGRect

pub fn convertPointToLayer(&self, point: CGPoint) -> CGPoint

pub fn convertPointFromLayer(&self, point: CGPoint) -> CGPoint

pub fn convertSizeToLayer(&self, size: CGSize) -> CGSize

pub fn convertSizeFromLayer(&self, size: CGSize) -> CGSize

pub fn convertRectToLayer(&self, rect: CGRect) -> CGRect

pub fn convertRectFromLayer(&self, rect: CGRect) -> CGRect

pub fn canDrawConcurrently(&self) -> bool

pub unsafe fn setCanDrawConcurrently(&self, can_draw_concurrently: bool)

Setter for canDrawConcurrently.

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

pub fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

pub fn needsDisplay(&self) -> bool

pub fn setNeedsDisplay(&self, needs_display: bool)

Setter for needsDisplay.

pub fn lockFocus(&self)

👎Deprecated: To draw, subclass NSView and implement -drawRect:; AppKit’s automatic deferred display mechanism will call -drawRect: as necessary to display the view.

pub fn unlockFocus(&self)

👎Deprecated: To draw, subclass NSView and implement -drawRect:; AppKit’s automatic deferred display mechanism will call -drawRect: as necessary to display the view.

pub fn lockFocusIfCanDraw(&self) -> bool

👎Deprecated: To draw, subclass NSView and implement -drawRect:; AppKit’s automatic deferred display mechanism will call -drawRect: as necessary to display the view.

pub fn visibleRect(&self) -> CGRect

The portion of the view that isn’t clipped by its superviews.

Visibility, as reflected by this property, doesn’t account for whether other view or window objects overlap the current view or whether the current view is installed in a window at all. This value of this property is NSZeroRect if the current view is effectively hidden.

During a printing operation, the visible rectangle is further clipped to the page being imaged.

pub fn display(&self)

pub fn displayIfNeeded(&self)

pub fn displayIfNeededIgnoringOpacity(&self)

pub fn displayRect(&self, rect: CGRect)

pub fn displayIfNeededInRect(&self, rect: CGRect)

pub fn displayRectIgnoringOpacity(&self, rect: CGRect)

pub fn displayIfNeededInRectIgnoringOpacity(&self, rect: CGRect)

pub fn drawRect(&self, dirty_rect: CGRect)

pub fn viewWillDraw(&self)

pub fn scrollPoint(&self, point: CGPoint)

pub fn scrollRectToVisible(&self, rect: CGRect) -> bool

pub fn adjustScroll(&self, new_visible: CGRect) -> CGRect

pub fn scrollRect_by(&self, rect: CGRect, delta: CGSize)

👎Deprecated: Use NSScrollView to achieve scrolling views.

pub fn translateRectsNeedingDisplayInRect_by( &self, clip_rect: CGRect, delta: CGSize, )

pub fn hitTest(&self, point: CGPoint) -> Option<Retained<NSView>>

pub fn mouse_inRect(&self, point: CGPoint, rect: CGRect) -> bool

pub fn viewWithTag(&self, tag: isize) -> Option<Retained<NSView>>

pub fn tag(&self) -> isize

pub fn needsPanelToBecomeKey(&self) -> bool

pub fn mouseDownCanMoveWindow(&self) -> bool

pub fn acceptsTouchEvents(&self) -> bool

👎Deprecated: Use allowedTouchTypes instead

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Setter for acceptsTouchEvents.

pub fn wantsRestingTouches(&self) -> bool

pub fn setWantsRestingTouches(&self, wants_resting_touches: bool)

Setter for wantsRestingTouches.

pub fn layerContentsRedrawPolicy(&self) -> NSViewLayerContentsRedrawPolicy

pub fn setLayerContentsRedrawPolicy( &self, layer_contents_redraw_policy: NSViewLayerContentsRedrawPolicy, )

Setter for layerContentsRedrawPolicy.

pub fn layerContentsPlacement(&self) -> NSViewLayerContentsPlacement

pub fn setLayerContentsPlacement( &self, layer_contents_placement: NSViewLayerContentsPlacement, )

Setter for layerContentsPlacement.

pub fn wantsLayer(&self) -> bool

pub fn setWantsLayer(&self, wants_layer: bool)

Setter for wantsLayer.

pub fn wantsUpdateLayer(&self) -> bool

pub fn updateLayer(&self)

pub fn canDrawSubviewsIntoLayer(&self) -> bool

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Setter for canDrawSubviewsIntoLayer.

pub fn layoutSubtreeIfNeeded(&self)

pub fn layout(&self)

pub fn needsLayout(&self) -> bool

pub fn setNeedsLayout(&self, needs_layout: bool)

Setter for needsLayout.

pub fn layerUsesCoreImageFilters(&self) -> bool

pub fn setLayerUsesCoreImageFilters(&self, layer_uses_core_image_filters: bool)

Setter for layerUsesCoreImageFilters.

pub fn clipsToBounds(&self) -> bool

pub fn setClipsToBounds(&self, clips_to_bounds: bool)

Setter for clipsToBounds.

pub fn postsBoundsChangedNotifications(&self) -> bool

pub fn setPostsBoundsChangedNotifications( &self, posts_bounds_changed_notifications: bool, )

Setter for postsBoundsChangedNotifications.

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

pub fn setToolTip(&self, tool_tip: Option<&NSString>)

Setter for toolTip.

This is copied when set.

pub unsafe fn addToolTipRect_owner_userData( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, ) -> isize

Safety

• owner should be of the correct type.
• data must be a valid pointer or null.

pub fn removeToolTip(&self, tag: isize)

pub fn removeAllToolTips(&self)

pub fn viewWillStartLiveResize(&self)

pub fn viewDidEndLiveResize(&self)

pub fn inLiveResize(&self) -> bool

pub fn preservesContentDuringLiveResize(&self) -> bool

pub fn rectPreservedDuringLiveResize(&self) -> CGRect

pub fn rectForSmartMagnificationAtPoint_inRect( &self, location: CGPoint, visible_rect: CGRect, ) -> CGRect

pub fn prepareForReuse(&self)

pub fn prepareContentInRect(&self, rect: CGRect)

pub fn preparedContentRect(&self) -> CGRect

pub fn setPreparedContentRect(&self, prepared_content_rect: CGRect)

Setter for preparedContentRect.

pub fn allowsVibrancy(&self) -> bool

pub fn viewDidChangeEffectiveAppearance(&self)

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

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

Safety

This is not retained internally, you must ensure the object is still alive.

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

Setter for nextKeyView.

Safety

This is unretained, you must ensure the object is kept alive while in use.

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

Safety

This is not retained internally, you must ensure the object is still alive.

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

Safety

This is not retained internally, you must ensure the object is still alive.

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

Safety

This is not retained internally, you must ensure the object is still alive.

pub fn canBecomeKeyView(&self) -> bool

pub fn setKeyboardFocusRingNeedsDisplayInRect(&self, rect: CGRect)

pub fn focusRingType(&self) -> NSFocusRingType

pub fn setFocusRingType(&self, focus_ring_type: NSFocusRingType)

Setter for focusRingType.

pub fn drawFocusRingMask(&self)

pub fn focusRingMaskBounds(&self) -> CGRect

pub fn noteFocusRingMaskChanged(&self)

pub fn dataWithEPSInsideRect(&self, rect: CGRect) -> Retained<NSData>

pub fn dataWithPDFInsideRect(&self, rect: CGRect) -> Retained<NSData>

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

Safety

sender should be of the correct type.

pub unsafe fn knowsPageRange(&self, range: *mut NSRange) -> bool

Safety

range must be a valid pointer.

pub fn rectForPage(&self, page: isize) -> CGRect

pub fn locationOfPrintRect(&self, rect: CGRect) -> CGPoint

pub fn drawPageBorderWithSize(&self, border_size: CGSize)

pub fn pageHeader(&self) -> Retained<NSAttributedString>

pub fn pageFooter(&self) -> Retained<NSAttributedString>

pub fn drawSheetBorderWithSize(&self, border_size: CGSize)

👎Deprecated: This is never invoked and the NSView implementation does nothing

• This method is obsolete. It will never be invoked from within AppKit, and NSView’s implementation of it does nothing. **

pub fn printJobTitle(&self) -> Retained<NSString>

pub fn beginDocument(&self)

pub fn endDocument(&self)

pub fn beginPageInRect_atPlacement(&self, rect: CGRect, location: CGPoint)

pub fn endPage(&self)

pub fn unregisterDraggedTypes(&self)

pub unsafe fn exitFullScreenModeWithOptions( &self, options: Option<&NSDictionary<NSString>>, )

Safety

options generic should be of the correct type.

pub fn isInFullScreenMode(&self) -> bool

pub fn showDefinitionForAttributedString_atPoint( &self, attr_string: Option<&NSAttributedString>, text_baseline_origin: CGPoint, )

pub fn isDrawingFindIndicator(&self) -> bool

pub fn safeAreaInsets(&self) -> NSEdgeInsets

pub fn additionalSafeAreaInsets(&self) -> NSEdgeInsets

pub fn setAdditionalSafeAreaInsets( &self, additional_safe_area_insets: NSEdgeInsets, )

Setter for additionalSafeAreaInsets.

pub fn safeAreaRect(&self) -> CGRect

pub fn prefersCompactControlSizeMetrics(&self) -> bool

When this property is true, any NSControls in the view or its descendants will be sized with compact metrics compatible with macOS 15 and earlier. Defaults to false

pub fn setPrefersCompactControlSizeMetrics( &self, prefers_compact_control_size_metrics: bool, )

Setter for prefersCompactControlSizeMetrics.

pub fn updateTrackingAreas(&self)

pub fn discardCursorRects(&self)

pub fn resetCursorRects(&self)

pub unsafe fn addTrackingRect_owner_userData_assumeInside( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, flag: bool, ) -> isize

Safety

• owner should be of the correct type.
• data must be a valid pointer or null.

pub fn removeTrackingRect(&self, tag: isize)

pub fn convertPointToBase(&self, point: CGPoint) -> CGPoint

👎Deprecated

pub fn convertPointFromBase(&self, point: CGPoint) -> CGPoint

👎Deprecated

pub fn convertSizeToBase(&self, size: CGSize) -> CGSize

👎Deprecated

pub fn convertSizeFromBase(&self, size: CGSize) -> CGSize

👎Deprecated

pub fn convertRectToBase(&self, rect: CGRect) -> CGRect

👎Deprecated

pub fn convertRectFromBase(&self, rect: CGRect) -> CGRect

👎Deprecated

pub fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

pub fn shouldDrawColor(&self) -> bool

👎Deprecated: This method no longer does anything

pub fn gState(&self) -> isize

👎Deprecated

pub fn allocateGState(&self)

👎Deprecated

pub fn setUpGState(&self)

👎Deprecated

pub fn renewGState(&self)

👎Deprecated

Methods from Deref<Target = NSResponder>

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

Safety

This is not retained internally, you must ensure the object is still alive.

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

Setter for nextResponder.

Safety

This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn tryToPerform_with( &self, action: Sel, object: Option<&AnyObject>, ) -> bool

Safety

• action must be a valid selector.
• object should be of the correct type.

pub unsafe fn noResponderFor(&self, event_selector: Sel)

Safety

event_selector must be a valid selector.

pub fn acceptsFirstResponder(&self) -> bool

pub fn becomeFirstResponder(&self) -> bool

pub fn resignFirstResponder(&self) -> bool

pub fn flushBufferedKeyEvents(&self)

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

Safety

sender should be of the correct type.

pub unsafe fn supplementalTargetForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

Safety

• action must be a valid selector.
• sender should be of the correct type.

pub fn undoManager(&self) -> Option<Retained<NSUndoManager>>

pub unsafe fn presentError_modalForWindow_delegate_didPresentSelector_contextInfo( &self, error: &NSError, window: &NSWindow, delegate: Option<&AnyObject>, did_present_selector: Option<Sel>, context_info: *mut c_void, )

Safety

• delegate should be of the correct type.
• did_present_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn presentError(&self, error: &NSError) -> bool

pub fn willPresentError(&self, error: &NSError) -> Retained<NSError>

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

pub fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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

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.

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

Trait Implementations

impl AsRef<AnyObject> for ScreenSaverView

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for ScreenSaverView

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSResponder> for ScreenSaverView

fn as_ref(&self) -> &NSResponder

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSView> for ScreenSaverView

fn as_ref(&self) -> &NSView

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ScreenSaverView> for ScreenSaverView

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for ScreenSaverView

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ScreenSaverView

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for ScreenSaverView

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSView> for ScreenSaverView

fn borrow(&self) -> &NSView

Immutably borrows from an owned value.

impl ClassType for ScreenSaverView

const NAME: &'static str = "ScreenSaverView"

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

type Super = NSView

The superclass of this class.

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

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

fn class() -> &'static AnyClass

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

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for ScreenSaverView

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ScreenSaverView

type Target = NSView

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for ScreenSaverView

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for ScreenSaverView

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSAccessibility for ScreenSaverView

fn isAccessibilityElement(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityElement(&self, accessibility_element: bool)

where Self: Sized + Message,

Setter for isAccessibilityElement.

fn accessibilityFrame(&self) -> CGRect

where Self: Sized + Message,

fn setAccessibilityFrame(&self, accessibility_frame: CGRect)

where Self: Sized + Message,

Setter for accessibilityFrame.

fn isAccessibilityFocused(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityFocused(&self, accessibility_focused: bool)

where Self: Sized + Message,

Setter for isAccessibilityFocused.

fn accessibilityActivationPoint(&self) -> CGPoint

where Self: Sized + Message,

fn setAccessibilityActivationPoint( &self, accessibility_activation_point: CGPoint, )

where Self: Sized + Message,

Setter for accessibilityActivationPoint.

fn accessibilityTopLevelUIElement(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityTopLevelUIElement( &self, accessibility_top_level_ui_element: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityTopLevelUIElement.

fn accessibilityURL(&self) -> Option<Retained<NSURL>>

where Self: Sized + Message,

fn setAccessibilityURL(&self, accessibility_url: Option<&NSURL>)

where Self: Sized + Message,

Setter for accessibilityURL.

fn accessibilityValue(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityValue(&self, accessibility_value: Option<&AnyObject>)

where Self: Sized + Message,

Setter for accessibilityValue.

fn accessibilityValueDescription(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityValueDescription( &self, accessibility_value_description: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilityValueDescription.

fn accessibilityVisibleChildren(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityVisibleChildren( &self, accessibility_visible_children: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityVisibleChildren.

fn accessibilityTitle(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityTitle(&self, accessibility_title: Option<&NSString>)

where Self: Sized + Message,

Setter for accessibilityTitle.

fn accessibilityTitleUIElement(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityTitleUIElement( &self, accessibility_title_ui_element: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityTitleUIElement.

fn accessibilityNextContents(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityNextContents( &self, accessibility_next_contents: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityNextContents.

fn accessibilityOverflowButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityOverflowButton( &self, accessibility_overflow_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityOverflowButton.

fn accessibilityParent(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityParent( &self, accessibility_parent: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityParent.

fn accessibilityPlaceholderValue(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityPlaceholderValue( &self, accessibility_placeholder_value: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilityPlaceholderValue.

fn accessibilityPreviousContents(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityPreviousContents( &self, accessibility_previous_contents: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityPreviousContents.

fn accessibilityRoleDescription(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityRoleDescription( &self, accessibility_role_description: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilityRoleDescription.

fn accessibilitySearchButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilitySearchButton( &self, accessibility_search_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilitySearchButton.

fn accessibilitySearchMenu(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilitySearchMenu( &self, accessibility_search_menu: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilitySearchMenu.

fn isAccessibilitySelected(&self) -> bool

where Self: Sized + Message,

fn setAccessibilitySelected(&self, accessibility_selected: bool)

where Self: Sized + Message,

Setter for isAccessibilitySelected.

fn accessibilitySelectedChildren(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilitySelectedChildren( &self, accessibility_selected_children: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilitySelectedChildren.

fn accessibilityServesAsTitleForUIElements(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityServesAsTitleForUIElements( &self, accessibility_serves_as_title_for_ui_elements: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityServesAsTitleForUIElements.

fn accessibilityShownMenu(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityShownMenu( &self, accessibility_shown_menu: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityShownMenu.

fn accessibilityMinValue(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityMinValue( &self, accessibility_min_value: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityMinValue.

fn accessibilityMaxValue(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityMaxValue( &self, accessibility_max_value: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityMaxValue.

fn accessibilityLinkedUIElements(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityLinkedUIElements( &self, accessibility_linked_ui_elements: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityLinkedUIElements.

fn accessibilityWindow(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityWindow( &self, accessibility_window: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityWindow.

fn accessibilityIdentifier(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityIdentifier( &self, accessibility_identifier: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilityIdentifier.

fn accessibilityHelp(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityHelp(&self, accessibility_help: Option<&NSString>)

where Self: Sized + Message,

Setter for accessibilityHelp.

fn accessibilityFilename(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityFilename(&self, accessibility_filename: Option<&NSString>)

where Self: Sized + Message,

Setter for accessibilityFilename.

fn isAccessibilityExpanded(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityExpanded(&self, accessibility_expanded: bool)

where Self: Sized + Message,

Setter for isAccessibilityExpanded.

fn isAccessibilityEdited(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityEdited(&self, accessibility_edited: bool)

where Self: Sized + Message,

Setter for isAccessibilityEdited.

fn isAccessibilityEnabled(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityEnabled(&self, accessibility_enabled: bool)

where Self: Sized + Message,

Setter for isAccessibilityEnabled.

fn accessibilityChildren(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityChildren( &self, accessibility_children: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityChildren.

fn accessibilityChildrenInNavigationOrder( &self, ) -> Option<Retained<NSArray<ProtocolObject<dyn NSAccessibilityElementProtocol>>>>

where Self: Sized + Message,

fn setAccessibilityChildrenInNavigationOrder( &self, accessibility_children_in_navigation_order: Option<&NSArray<ProtocolObject<dyn NSAccessibilityElementProtocol>>>, )

where Self: Sized + Message,

Setter for accessibilityChildrenInNavigationOrder.

fn accessibilityClearButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityClearButton( &self, accessibility_clear_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityClearButton.

fn accessibilityCancelButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityCancelButton( &self, accessibility_cancel_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityCancelButton.

fn isAccessibilityProtectedContent(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityProtectedContent( &self, accessibility_protected_content: bool, )

where Self: Sized + Message,

Setter for isAccessibilityProtectedContent.

fn accessibilityContents(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityContents( &self, accessibility_contents: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityContents.

fn accessibilityLabel(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityLabel(&self, accessibility_label: Option<&NSString>)

where Self: Sized + Message,

Setter for accessibilityLabel.

fn isAccessibilityAlternateUIVisible(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityAlternateUIVisible( &self, accessibility_alternate_ui_visible: bool, )

where Self: Sized + Message,

Setter for isAccessibilityAlternateUIVisible.

fn accessibilitySharedFocusElements(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilitySharedFocusElements( &self, accessibility_shared_focus_elements: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilitySharedFocusElements.

fn isAccessibilityRequired(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityRequired(&self, accessibility_required: bool)

where Self: Sized + Message,

Setter for isAccessibilityRequired.

fn accessibilityUserInputLabels(&self) -> Option<Retained<NSArray<NSString>>>

where Self: Sized + Message,

fn setAccessibilityUserInputLabels( &self, accessibility_user_input_labels: Option<&NSArray<NSString>>, )

where Self: Sized + Message,

Setter for accessibilityUserInputLabels.

fn accessibilityAttributedUserInputLabels( &self, ) -> Option<Retained<NSArray<NSAttributedString>>>

where Self: Sized + Message,

fn setAccessibilityAttributedUserInputLabels( &self, accessibility_attributed_user_input_labels: Option<&NSArray<NSAttributedString>>, )

where Self: Sized + Message,

Setter for accessibilityAttributedUserInputLabels.

fn accessibilityApplicationFocusedUIElement( &self, ) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityApplicationFocusedUIElement( &self, accessibility_application_focused_ui_element: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityApplicationFocusedUIElement.

fn accessibilityMainWindow(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityMainWindow( &self, accessibility_main_window: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityMainWindow.

fn isAccessibilityHidden(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityHidden(&self, accessibility_hidden: bool)

where Self: Sized + Message,

Setter for isAccessibilityHidden.

fn isAccessibilityFrontmost(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityFrontmost(&self, accessibility_frontmost: bool)

where Self: Sized + Message,

Setter for isAccessibilityFrontmost.

fn accessibilityFocusedWindow(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityFocusedWindow( &self, accessibility_focused_window: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityFocusedWindow.

fn accessibilityWindows(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityWindows( &self, accessibility_windows: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityWindows.

fn accessibilityExtrasMenuBar(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityExtrasMenuBar( &self, accessibility_extras_menu_bar: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityExtrasMenuBar.

fn accessibilityMenuBar(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityMenuBar( &self, accessibility_menu_bar: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityMenuBar.

fn accessibilityColumnTitles(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityColumnTitles( &self, accessibility_column_titles: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityColumnTitles.

fn isAccessibilityOrderedByRow(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityOrderedByRow(&self, accessibility_ordered_by_row: bool)

where Self: Sized + Message,

Setter for isAccessibilityOrderedByRow.

fn accessibilityHorizontalUnitDescription(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityHorizontalUnitDescription( &self, accessibility_horizontal_unit_description: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilityHorizontalUnitDescription.

fn accessibilityVerticalUnitDescription(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityVerticalUnitDescription( &self, accessibility_vertical_unit_description: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilityVerticalUnitDescription.

fn accessibilityLayoutPointForScreenPoint(&self, point: CGPoint) -> CGPoint

where Self: Sized + Message,

fn accessibilityLayoutSizeForScreenSize(&self, size: CGSize) -> CGSize

where Self: Sized + Message,

fn accessibilityScreenPointForLayoutPoint(&self, point: CGPoint) -> CGPoint

where Self: Sized + Message,

fn accessibilityScreenSizeForLayoutSize(&self, size: CGSize) -> CGSize

where Self: Sized + Message,

fn accessibilityHandles(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityHandles( &self, accessibility_handles: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityHandles.

fn accessibilityWarningValue(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityWarningValue( &self, accessibility_warning_value: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityWarningValue.

fn accessibilityCriticalValue(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityCriticalValue( &self, accessibility_critical_value: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityCriticalValue.

fn isAccessibilityDisclosed(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityDisclosed(&self, accessibility_disclosed: bool)

where Self: Sized + Message,

Setter for isAccessibilityDisclosed.

fn accessibilityDisclosedByRow(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityDisclosedByRow( &self, accessibility_disclosed_by_row: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityDisclosedByRow.

fn accessibilityDisclosedRows(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityDisclosedRows( &self, accessibility_disclosed_rows: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityDisclosedRows.

fn accessibilityDisclosureLevel(&self) -> isize

where Self: Sized + Message,

fn setAccessibilityDisclosureLevel(&self, accessibility_disclosure_level: isize)

where Self: Sized + Message,

Setter for accessibilityDisclosureLevel.

fn accessibilityMarkerUIElements(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityMarkerUIElements( &self, accessibility_marker_ui_elements: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityMarkerUIElements.

fn accessibilityMarkerValues(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityMarkerValues( &self, accessibility_marker_values: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityMarkerValues.

fn accessibilityMarkerGroupUIElement(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityMarkerGroupUIElement( &self, accessibility_marker_group_ui_element: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityMarkerGroupUIElement.

fn accessibilityUnitDescription(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityUnitDescription( &self, accessibility_unit_description: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilityUnitDescription.

fn accessibilityMarkerTypeDescription(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityMarkerTypeDescription( &self, accessibility_marker_type_description: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilityMarkerTypeDescription.

fn accessibilityHorizontalScrollBar(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityHorizontalScrollBar( &self, accessibility_horizontal_scroll_bar: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityHorizontalScrollBar.

fn accessibilityVerticalScrollBar(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityVerticalScrollBar( &self, accessibility_vertical_scroll_bar: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityVerticalScrollBar.

fn accessibilityAllowedValues(&self) -> Option<Retained<NSArray<NSNumber>>>

where Self: Sized + Message,

fn setAccessibilityAllowedValues( &self, accessibility_allowed_values: Option<&NSArray<NSNumber>>, )

where Self: Sized + Message,

Setter for accessibilityAllowedValues.

fn accessibilityLabelUIElements(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityLabelUIElements( &self, accessibility_label_ui_elements: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityLabelUIElements.

fn accessibilityLabelValue(&self) -> f32

where Self: Sized + Message,

fn setAccessibilityLabelValue(&self, accessibility_label_value: f32)

where Self: Sized + Message,

Setter for accessibilityLabelValue.

fn accessibilitySplitters(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilitySplitters( &self, accessibility_splitters: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilitySplitters.

fn accessibilityDecrementButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityDecrementButton( &self, accessibility_decrement_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityDecrementButton.

fn accessibilityIncrementButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityIncrementButton( &self, accessibility_increment_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityIncrementButton.

fn accessibilityTabs(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityTabs(&self, accessibility_tabs: Option<&NSArray>)

where Self: Sized + Message,

Setter for accessibilityTabs.

fn accessibilityHeader(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityHeader( &self, accessibility_header: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityHeader.

fn accessibilityColumnCount(&self) -> isize

where Self: Sized + Message,

fn setAccessibilityColumnCount(&self, accessibility_column_count: isize)

where Self: Sized + Message,

Setter for accessibilityColumnCount.

fn accessibilityRowCount(&self) -> isize

where Self: Sized + Message,

fn setAccessibilityRowCount(&self, accessibility_row_count: isize)

where Self: Sized + Message,

Setter for accessibilityRowCount.

fn accessibilityIndex(&self) -> isize

where Self: Sized + Message,

fn setAccessibilityIndex(&self, accessibility_index: isize)

where Self: Sized + Message,

Setter for accessibilityIndex.

fn accessibilityColumns(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityColumns( &self, accessibility_columns: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityColumns.

fn accessibilityRows(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityRows(&self, accessibility_rows: Option<&NSArray>)

where Self: Sized + Message,

Setter for accessibilityRows.

fn accessibilityVisibleRows(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityVisibleRows( &self, accessibility_visible_rows: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityVisibleRows.

fn accessibilitySelectedRows(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilitySelectedRows( &self, accessibility_selected_rows: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilitySelectedRows.

fn accessibilityVisibleColumns(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityVisibleColumns( &self, accessibility_visible_columns: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityVisibleColumns.

fn accessibilitySelectedColumns(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilitySelectedColumns( &self, accessibility_selected_columns: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilitySelectedColumns.

fn accessibilityRowHeaderUIElements(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityRowHeaderUIElements( &self, accessibility_row_header_ui_elements: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityRowHeaderUIElements.

fn accessibilitySelectedCells(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilitySelectedCells( &self, accessibility_selected_cells: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilitySelectedCells.

fn accessibilityVisibleCells(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityVisibleCells( &self, accessibility_visible_cells: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityVisibleCells.

fn accessibilityColumnHeaderUIElements(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilityColumnHeaderUIElements( &self, accessibility_column_header_ui_elements: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilityColumnHeaderUIElements.

fn accessibilityCellForColumn_row( &self, column: isize, row: isize, ) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

fn accessibilityRowIndexRange(&self) -> NSRange

where Self: Sized + Message,

fn setAccessibilityRowIndexRange(&self, accessibility_row_index_range: NSRange)

where Self: Sized + Message,

Setter for accessibilityRowIndexRange.

fn accessibilityColumnIndexRange(&self) -> NSRange

where Self: Sized + Message,

fn setAccessibilityColumnIndexRange( &self, accessibility_column_index_range: NSRange, )

where Self: Sized + Message,

Setter for accessibilityColumnIndexRange.

fn accessibilityInsertionPointLineNumber(&self) -> isize

where Self: Sized + Message,

fn setAccessibilityInsertionPointLineNumber( &self, accessibility_insertion_point_line_number: isize, )

where Self: Sized + Message,

Setter for accessibilityInsertionPointLineNumber.

fn accessibilitySharedCharacterRange(&self) -> NSRange

where Self: Sized + Message,

fn setAccessibilitySharedCharacterRange( &self, accessibility_shared_character_range: NSRange, )

where Self: Sized + Message,

Setter for accessibilitySharedCharacterRange.

fn accessibilitySharedTextUIElements(&self) -> Option<Retained<NSArray>>

where Self: Sized + Message,

unsafe fn setAccessibilitySharedTextUIElements( &self, accessibility_shared_text_ui_elements: Option<&NSArray>, )

where Self: Sized + Message,

Setter for accessibilitySharedTextUIElements.

fn accessibilityVisibleCharacterRange(&self) -> NSRange

where Self: Sized + Message,

fn setAccessibilityVisibleCharacterRange( &self, accessibility_visible_character_range: NSRange, )

where Self: Sized + Message,

Setter for accessibilityVisibleCharacterRange.

fn accessibilityNumberOfCharacters(&self) -> isize

where Self: Sized + Message,

fn setAccessibilityNumberOfCharacters( &self, accessibility_number_of_characters: isize, )

where Self: Sized + Message,

Setter for accessibilityNumberOfCharacters.

fn accessibilitySelectedText(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilitySelectedText( &self, accessibility_selected_text: Option<&NSString>, )

where Self: Sized + Message,

Setter for accessibilitySelectedText.

fn accessibilitySelectedTextRange(&self) -> NSRange

where Self: Sized + Message,

fn setAccessibilitySelectedTextRange( &self, accessibility_selected_text_range: NSRange, )

where Self: Sized + Message,

Setter for accessibilitySelectedTextRange.

fn accessibilitySelectedTextRanges(&self) -> Option<Retained<NSArray<NSValue>>>

where Self: Sized + Message,

fn setAccessibilitySelectedTextRanges( &self, accessibility_selected_text_ranges: Option<&NSArray<NSValue>>, )

where Self: Sized + Message,

Setter for accessibilitySelectedTextRanges.

fn accessibilityAttributedStringForRange( &self, range: NSRange, ) -> Option<Retained<NSAttributedString>>

where Self: Sized + Message,

fn accessibilityRangeForLine(&self, line: isize) -> NSRange

where Self: Sized + Message,

fn accessibilityStringForRange( &self, range: NSRange, ) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn accessibilityRangeForPosition(&self, point: CGPoint) -> NSRange

where Self: Sized + Message,

fn accessibilityRangeForIndex(&self, index: isize) -> NSRange

where Self: Sized + Message,

fn accessibilityFrameForRange(&self, range: NSRange) -> CGRect

where Self: Sized + Message,

fn accessibilityRTFForRange(&self, range: NSRange) -> Option<Retained<NSData>>

where Self: Sized + Message,

fn accessibilityStyleRangeForIndex(&self, index: isize) -> NSRange

where Self: Sized + Message,

fn accessibilityLineForIndex(&self, index: isize) -> isize

where Self: Sized + Message,

fn accessibilityToolbarButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityToolbarButton( &self, accessibility_toolbar_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityToolbarButton.

fn isAccessibilityModal(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityModal(&self, accessibility_modal: bool)

where Self: Sized + Message,

Setter for isAccessibilityModal.

fn accessibilityProxy(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityProxy(&self, accessibility_proxy: Option<&AnyObject>)

where Self: Sized + Message,

Setter for accessibilityProxy.

fn isAccessibilityMain(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityMain(&self, accessibility_main: bool)

where Self: Sized + Message,

Setter for isAccessibilityMain.

fn accessibilityFullScreenButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityFullScreenButton( &self, accessibility_full_screen_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityFullScreenButton.

fn accessibilityGrowArea(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityGrowArea( &self, accessibility_grow_area: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityGrowArea.

fn accessibilityDocument(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setAccessibilityDocument(&self, accessibility_document: Option<&NSString>)

where Self: Sized + Message,

Setter for accessibilityDocument.

fn accessibilityDefaultButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityDefaultButton( &self, accessibility_default_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityDefaultButton.

fn accessibilityCloseButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityCloseButton( &self, accessibility_close_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityCloseButton.

fn accessibilityZoomButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityZoomButton( &self, accessibility_zoom_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityZoomButton.

fn accessibilityMinimizeButton(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

unsafe fn setAccessibilityMinimizeButton( &self, accessibility_minimize_button: Option<&AnyObject>, )

where Self: Sized + Message,

Setter for accessibilityMinimizeButton.

fn isAccessibilityMinimized(&self) -> bool

where Self: Sized + Message,

fn setAccessibilityMinimized(&self, accessibility_minimized: bool)

where Self: Sized + Message,

Setter for isAccessibilityMinimized.

fn accessibilityPerformCancel(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformConfirm(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformDecrement(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformDelete(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformIncrement(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformPick(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformPress(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformRaise(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformShowAlternateUI(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformShowDefaultUI(&self) -> bool

where Self: Sized + Message,

fn accessibilityPerformShowMenu(&self) -> bool

where Self: Sized + Message,

unsafe fn isAccessibilitySelectorAllowed(&self, selector: Sel) -> bool

where Self: Sized + Message,

Safety

impl NSAccessibilityElementProtocol for ScreenSaverView

fn accessibilityFrame(&self) -> CGRect

where Self: Sized + Message,

fn accessibilityParent(&self) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

fn isAccessibilityFocused(&self) -> bool

where Self: Sized + Message,

fn accessibilityIdentifier(&self) -> Retained<NSString>

where Self: Sized + Message,

impl NSAnimatablePropertyContainer for ScreenSaverView

fn animator(&self) -> Retained<Self>

where Self: Sized + Message,

fn animations(&self) -> Retained<NSDictionary<NSString>>

where Self: Sized + Message,

unsafe fn setAnimations(&self, animations: &NSDictionary<NSString>)

where Self: Sized + Message,

Setter for animations.

fn animationForKey(&self, key: &NSString) -> Option<Retained<AnyObject>>

where Self: Sized + Message,

fn defaultAnimationForKey(key: &NSString) -> Option<Retained<AnyObject>>

where Self: Sized + ClassType,

impl NSAppearanceCustomization for ScreenSaverView

fn appearance(&self) -> Option<Retained<NSAppearance>>

where Self: Sized + Message,

fn setAppearance(&self, appearance: Option<&NSAppearance>)

where Self: Sized + Message,

Setter for appearance.

fn effectiveAppearance(&self) -> Retained<NSAppearance>

where Self: Sized + Message,

impl NSCoding for ScreenSaverView

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSDraggingDestination for ScreenSaverView

fn draggingEntered( &self, sender: &ProtocolObject<dyn NSDraggingInfo>, ) -> NSDragOperation

where Self: Sized + Message,

fn draggingUpdated( &self, sender: &ProtocolObject<dyn NSDraggingInfo>, ) -> NSDragOperation

where Self: Sized + Message,

fn draggingExited(&self, sender: Option<&ProtocolObject<dyn NSDraggingInfo>>)

where Self: Sized + Message,

fn prepareForDragOperation( &self, sender: &ProtocolObject<dyn NSDraggingInfo>, ) -> bool

where Self: Sized + Message,

fn performDragOperation( &self, sender: &ProtocolObject<dyn NSDraggingInfo>, ) -> bool

where Self: Sized + Message,

fn concludeDragOperation( &self, sender: Option<&ProtocolObject<dyn NSDraggingInfo>>, )

where Self: Sized + Message,

fn draggingEnded(&self, sender: &ProtocolObject<dyn NSDraggingInfo>)

where Self: Sized + Message,

fn wantsPeriodicDraggingUpdates(&self) -> bool

where Self: Sized + Message,

fn updateDraggingItemsForDrag( &self, sender: Option<&ProtocolObject<dyn NSDraggingInfo>>, )

where Self: Sized + Message,

impl NSObjectProtocol for ScreenSaverView

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

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

fn hash(&self) -> usize

where Self: Sized + Message,

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

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.

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

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSUserInterfaceItemIdentification for ScreenSaverView

fn identifier(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setIdentifier(&self, identifier: Option<&NSString>)

where Self: Sized + Message,

Setter for identifier.

impl PartialEq for ScreenSaverView

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

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

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for ScreenSaverView

const ENCODING_REF: Encoding = <NSView as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for ScreenSaverView

impl Eq for ScreenSaverView