Struct NSScrollView

Source

pub struct NSScrollView { /* private fields */ }

Available on crate features NSResponder and NSScrollView and NSView only.

Expand description

Apple’s documentation

§Safety

horizontal_scroller_class probably has further requirements.
vertical_scroller_class probably has further requirements.

Source

pub unsafe fn contentSizeForFrameSize_horizontalScrollerClass_verticalScrollerClass_borderType_controlSize_scrollerStyle( f_size: NSSize, horizontal_scroller_class: Option<&AnyClass>, vertical_scroller_class: Option<&AnyClass>, type: NSBorderType, control_size: NSControlSize, scroller_style: NSScrollerStyle, mtm: MainThreadMarker, ) -> NSSize

Available on crate features NSCell and NSScroller only.

§Safety

horizontal_scroller_class probably has further requirements.
vertical_scroller_class probably has further requirements.

Source

pub fn frameSizeForContentSize_hasHorizontalScroller_hasVerticalScroller_borderType( c_size: NSSize, h_flag: bool, v_flag: bool, type: NSBorderType, mtm: MainThreadMarker, ) -> NSSize

👎Deprecated: Use +frameSizeForContentSize:horizontalScrollerClass:verticalScrollerClass:borderType:controlSize:scrollerStyle: instead

Source

pub fn contentSizeForFrameSize_hasHorizontalScroller_hasVerticalScroller_borderType( f_size: NSSize, h_flag: bool, v_flag: bool, type: NSBorderType, mtm: MainThreadMarker, ) -> NSSize

👎Deprecated: +contentSizeForFrameSize:horizontalScrollerClass:verticalScrollerClass:borderType:controlSize:scrollerStyle: instead

Source

pub fn contentView(&self) -> Retained<NSClipView>

Available on crate feature NSClipView only.

Source

pub fn setContentView(&self, content_view: &NSClipView)

Available on crate feature NSClipView only.

Setter for contentView.

Source

pub fn documentCursor(&self) -> Option<Retained<NSCursor>>

Available on crate feature NSCursor only.

Source

pub fn setDocumentCursor(&self, document_cursor: Option<&NSCursor>)

Available on crate feature NSCursor only.

Setter for documentCursor.

Source

pub fn borderType(&self) -> NSBorderType

Source

pub fn setBorderType(&self, border_type: NSBorderType)

Setter for borderType.

Available on crate features NSControl and NSScroller only.

Source

pub fn setVerticalScroller(&self, vertical_scroller: Option<&NSScroller>)

Available on crate features NSControl and NSScroller only.

Setter for verticalScroller.

Source

pub fn horizontalScroller(&self) -> Option<Retained<NSScroller>>

Available on crate features NSControl and NSScroller only.

Source

pub fn setHorizontalScroller(&self, horizontal_scroller: Option<&NSScroller>)

Available on crate features NSControl and NSScroller only.

Setter for horizontalScroller.

Source

pub fn autohidesScrollers(&self) -> bool

Source

Available on crate feature objc2-core-foundation only.

pub fn scrollerStyle(&self) -> NSScrollerStyle

Available on crate feature NSScroller only.

Source

pub fn setScrollerStyle(&self, scroller_style: NSScrollerStyle)

Available on crate feature NSScroller only.

Setter for scrollerStyle.

Source

pub fn scrollerKnobStyle(&self) -> NSScrollerKnobStyle

Available on crate feature NSScroller only.

Source

pub fn setScrollerKnobStyle(&self, scroller_knob_style: NSScrollerKnobStyle)

Available on crate feature NSScroller only.

Available on crate feature objc2-core-foundation only.

Setter for rulerViewClass.

§Safety

ruler_view_class probably has further requirements.
ruler_view_class might not allow None.

Setter for findBarPosition.

Available on crate feature NSLayoutConstraint only.

Setter for needsUpdateConstraints.

Source

pub fn translatesAutoresizingMaskIntoConstraints(&self) -> bool

Available on crate feature NSLayoutConstraint only.

Source

pub fn setTranslatesAutoresizingMaskIntoConstraints( &self, translates_autoresizing_mask_into_constraints: bool, )

Available on crate feature NSLayoutConstraint only.

Available on crate feature NSLayoutConstraint only.

Setter for isHorizontalContentSizeConstraintActive.

Source

pub fn isVerticalContentSizeConstraintActive(&self) -> bool

Available on crate feature NSLayoutConstraint only.

Source

pub fn setVerticalContentSizeConstraintActive( &self, vertical_content_size_constraint_active: bool, )

Available on crate feature NSLayoutConstraint only.

pub fn setWantsBestResolutionOpenGLSurface( &self, wants_best_resolution_open_gl_surface: bool, )

👎Deprecated: Use NSOpenGLView instead.

Available on crate feature NSOpenGLView only.

Setter for wantsBestResolutionOpenGLSurface.

Source

pub fn wantsExtendedDynamicRangeOpenGLSurface(&self) -> bool

👎Deprecated: Use NSOpenGLView instead.

Available on crate feature NSOpenGLView only.

Source

pub fn setWantsExtendedDynamicRangeOpenGLSurface( &self, wants_extended_dynamic_range_open_gl_surface: bool, )

👎Deprecated: Use NSOpenGLView instead.

Available on crate feature NSOpenGLView only.

Setter for wantsExtendedDynamicRangeOpenGLSurface.

Source

pub fn pressureConfiguration(&self) -> Option<Retained<NSPressureConfiguration>>

Available on crate feature NSPressureConfiguration only.

Source

pub fn setPressureConfiguration( &self, pressure_configuration: Option<&NSPressureConfiguration>, )

Available on crate feature NSPressureConfiguration only.

§Safety

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

§Safety

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

Source

pub fn isHidden(&self) -> bool

Source

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

Source

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

Source

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const NSRect, count: *mut NSInteger, )

§Safety

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

Available on crate feature NSGraphics only.

Source

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.

Source

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

Available on crate feature NSWindow only.

pub fn resizeSubviewsWithOldSize(&self, old_size: NSSize)

Source

Source

pub fn frame(&self) -> NSRect

Source

pub fn setFrame(&self, frame: NSRect)

Setter for frame.

Source

pub fn frameRotation(&self) -> CGFloat

Setter for canDrawConcurrently.

Source

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.

Source

pub fn setNeedsDisplayInRect(&self, invalid_rect: NSRect)

Source

pub fn needsDisplay(&self) -> bool

Source

pub fn setNeedsDisplay(&self, needs_display: bool)

Setter for needsDisplay.

Source

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.

Source

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.

Source

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.

Source

pub fn lockFocusIfCanDrawInContext(&self, context: &NSGraphicsContext) -> bool

👎Deprecated: Use -[NSView displayRectIgnoringOpacity:inContext:] to draw a view subtree into a graphics context.

Available on crate feature NSGraphicsContext only.

Source

pub fn visibleRect(&self) -> NSRect

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 bitmapImageRepForCachingDisplayInRect( &self, rect: NSRect, ) -> Option<Retained<NSBitmapImageRep>>

Available on crate features NSBitmapImageRep and NSImageRep only.

Source

pub fn cacheDisplayInRect_toBitmapImageRep( &self, rect: NSRect, bitmap_image_rep: &NSBitmapImageRep, )

Available on crate features NSBitmapImageRep and NSImageRep only.

Source

pub fn viewWillDraw(&self)

Source

Available on crate feature NSEvent only.

Source

pub fn acceptsFirstMouse(&self, event: Option<&NSEvent>) -> bool

Available on crate feature NSEvent only.

Source

pub fn shouldDelayWindowOrderingForEvent(&self, event: &NSEvent) -> bool

Available on crate feature NSEvent only.

Source

pub fn needsPanelToBecomeKey(&self) -> bool

Source

pub fn mouseDownCanMoveWindow(&self) -> bool

Source

pub fn acceptsTouchEvents(&self) -> bool

👎Deprecated: Use allowedTouchTypes instead

Source

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Setter for canDrawSubviewsIntoLayer.

Source

pub fn layoutSubtreeIfNeeded(&self)

Source

pub fn layout(&self)

Source

pub fn needsLayout(&self) -> bool

Source

pub fn setNeedsLayout(&self, needs_layout: bool)

Setter for needsLayout.

Source

pub fn alphaValue(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

pub fn setAlphaValue(&self, alpha_value: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for alphaValue.

Source

pub fn layerUsesCoreImageFilters(&self) -> bool

Source

pub fn setLayerUsesCoreImageFilters(&self, layer_uses_core_image_filters: bool)

Setter for layerUsesCoreImageFilters.

Available on crate features NSEvent and NSMenu only.

A contextual menu is being opened from the receiving view. The view should update any visual state in response — such as making a selection.

Parameter menu: The contextual menu that is being opened on the view

Parameter event: The event that caused the menu to open.

Source

pub fn didCloseMenu_withEvent(&self, menu: &NSMenu, event: Option<&NSEvent>)

Available on crate features NSEvent and NSMenu only.

A contextual menu shown from the receiving view has been closed. This is only called if the menu had been opened and the view previously received -willOpenMenu:withEvent:.The view should update any visual state in response — such as removing a temporary selection.

Parameter menu: The contextual menu that was open on the view

Parameter event: The event that caused the menu to close. This may be nil if there is no specific event that triggered the closing.

Source

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

Source

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

Setter for toolTip.

This is copied when set.

Source

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

§Safety

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

Available on crate feature NSTextInputContext only.

Source

pub fn rectForSmartMagnificationAtPoint_inRect( &self, location: NSPoint, visible_rect: NSRect, ) -> NSRect

Source

pub fn userInterfaceLayoutDirection(&self) -> NSUserInterfaceLayoutDirection

Available on crate feature NSUserInterfaceLayout only.

Source

pub fn setUserInterfaceLayoutDirection( &self, user_interface_layout_direction: NSUserInterfaceLayoutDirection, )

Available on crate feature NSUserInterfaceLayout only.

Setter for userInterfaceLayoutDirection.

Source

pub fn prepareForReuse(&self)

Source

pub fn prepareContentInRect(&self, rect: NSRect)

Source

pub fn preparedContentRect(&self) -> NSRect

Source

pub fn setPreparedContentRect(&self, prepared_content_rect: NSRect)

Setter for preparedContentRect.

Source

pub fn allowsVibrancy(&self) -> bool

Source

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.

Source

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

§Safety

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

Source

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

Setter for nextKeyView.

Source

pub fn setKeyboardFocusRingNeedsDisplayInRect(&self, rect: NSRect)

Source

pub fn focusRingType(&self) -> NSFocusRingType

Available on crate feature NSGraphics only.

Source

pub fn setFocusRingType(&self, focus_ring_type: NSFocusRingType)

Available on crate feature NSGraphics only.

Setter for focusRingType.

Source

pub fn drawFocusRingMask(&self)

Source

pub fn registeredDraggedTypes(&self) -> Retained<NSArray<NSPasteboardType>>

Available on crate feature NSPasteboard only.

Source

pub fn registerForDraggedTypes(&self, new_types: &NSArray<NSPasteboardType>)

Available on crate feature NSPasteboard only.

Source

pub fn unregisterDraggedTypes(&self)

Source

pub unsafe fn enterFullScreenMode_withOptions( &self, screen: &NSScreen, options: Option<&NSDictionary<NSViewFullScreenModeOptionKey, AnyObject>>, ) -> bool

Available on crate feature NSScreen only.

§Safety

options generic should be of the correct type.

Source

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

§Safety

options generic should be of the correct type.

Source

pub fn isInFullScreenMode(&self) -> bool

Source

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

Source

pub fn addGestureRecognizer(&self, gesture_recognizer: &NSGestureRecognizer)

Available on crate feature NSGestureRecognizer only.

Source

pub fn removeGestureRecognizer(&self, gesture_recognizer: &NSGestureRecognizer)

Available on crate feature NSGestureRecognizer only.

Source

pub fn allowedTouchTypes(&self) -> NSTouchTypeMask

Available on crate feature NSTouch only.

Source

pub fn setAllowedTouchTypes(&self, allowed_touch_types: NSTouchTypeMask)

Available on crate feature NSTouch only.

Setter for allowedTouchTypes.

Source

pub fn safeAreaInsets(&self) -> NSEdgeInsets

Source

pub fn additionalSafeAreaInsets(&self) -> NSEdgeInsets

Source

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

Setter for additionalSafeAreaInsets.

Source

pub fn safeAreaLayoutGuide(&self) -> Retained<NSLayoutGuide>

Available on crate feature NSLayoutGuide only.

Source

§Safety

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

Source

pub fn removeTrackingRect(&self, tag: NSTrackingRectTag)

Source

pub unsafe fn dragImage_at_offset_event_pasteboard_source_slideBack( &self, image: &NSImage, view_location: NSPoint, initial_offset: NSSize, event: &NSEvent, pboard: &NSPasteboard, source_obj: &AnyObject, slide_flag: bool, )

👎Deprecated: Use -beginDraggingSessionWithItems:event:source: instead

Available on crate features NSEvent and NSImage and NSPasteboard only.

§Safety

source_obj should be of the correct type.

Source

pub fn dragFile_fromRect_slideBack_event( &self, filename: &NSString, rect: NSRect, flag: bool, event: &NSEvent, ) -> bool

Available on crate feature NSWritingToolsCoordinator only.

Setter for writingToolsCoordinator.

Source

pub fn layoutGuideForLayoutRegion( &self, layout_region: &NSViewLayoutRegion, ) -> Retained<NSLayoutGuide>

Available on crate features NSViewLayoutRegion and NSLayoutGuide only.

Source

pub fn edgeInsetsForLayoutRegion( &self, layout_region: &NSViewLayoutRegion, ) -> NSEdgeInsets

Available on crate feature NSViewLayoutRegion only.

Source

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

§Safety

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

Source

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.

Source

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.

Handle a key event that should present a context menu at the user focus.

Most applications should not override this method. Instead, you should customize the context menu displayed from a keyboard event by implementing menuForEvent: and selectionAnchorRect, or showContextMenuForSelection:, rather than this method.

You should only override this method when you do not want the system-provided default behavior for the context menu hotkey, either for a specific key combination, or for the hotkey in general. For example, if your application already provides a different behavior for control-Return (the default context menu hotkey definition), and you want to preserve that behavior, you should override this method to handle that specific key combination, and then return without calling super. Note that the user may customize the hotkey to a different key combination, so in this example, if any other key combination is passed to your method, you would call super.

An implementation of this method should call [super contextMenuKeyDown:event] to pass the request up the responder chain. If the message reaches the application object, NSApplication’s implementation of this method will send showContextMenuForSelection: to the responder chain. If you do not call super, then no further handling of the key event will be performed.

Note: In some cases, showContextMenuForSelection: will be called without a prior call to contextMenuKeyDown:. This occurs when a view receives an Accessibility ShowMenu action, or when the user has created a Cocoa Text key binding to map a different key combination to the showContextMenuForSelection: action.

Parameter event: The key down event that matches the system-wide context menu hotkey combination.

See also: showContextMenuForSelection:

Source

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

§Safety

event_selector must be a valid selector.

Source

pub fn acceptsFirstResponder(&self) -> bool

Source

pub fn becomeFirstResponder(&self) -> bool

Source

pub fn resignFirstResponder(&self) -> bool

Source

pub fn interpretKeyEvents(&self, event_array: &NSArray<NSEvent>)

Available on crate feature NSEvent only.

Source

Available on crate feature NSEvent only.

Source

pub fn shouldBeTreatedAsInkEvent(&self, event: &NSEvent) -> bool

Available on crate feature NSEvent only.

Source

pub fn wantsScrollEventsForSwipeTrackingOnAxis( &self, axis: NSEventGestureAxis, ) -> bool

Available on crate feature NSEvent only.

Source

pub fn wantsForwardedScrollEventsForAxis( &self, axis: NSEventGestureAxis, ) -> bool

Available on crate feature NSEvent only.

Source

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 touchBar(&self) -> Option<Retained<NSTouchBar>>

Available on crate feature NSTouchBar only.

Source

pub fn setTouchBar(&self, touch_bar: Option<&NSTouchBar>)

Available on crate feature NSTouchBar only.

Setter for touchBar.

Source

pub fn makeTouchBar(&self) -> Option<Retained<NSTouchBar>>

Available on crate feature NSTouchBar only.

Source

pub fn userActivity(&self) -> Option<Retained<NSUserActivity>>

Available on crate feature NSUserActivity only.

Source

pub fn setUserActivity(&self, user_activity: Option<&NSUserActivity>)

Available on crate feature NSUserActivity only.

Setter for userActivity.

Available on crate feature NSWindowRestoration only.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Available on crate feature 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());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Available on crate feature 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.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Available on crate feature 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`
    }
}