Struct RowButton 

#[repr(C)]
pub(crate) struct RowButton {
    __superclass: ManuallyDrop<<NSButton as ClassType>::__SubclassingType>,
    __phantom: PhantomData<(<Self as DefinedClass>::Ivars, ThreadKindAutoTraits<<Self as ClassType>::ThreadKind>)>,
}

Fields

__superclass: ManuallyDrop<<NSButton as ClassType>::__SubclassingType>

__phantom: PhantomData<(<Self as DefinedClass>::Ivars, ThreadKindAutoTraits<<Self as ClassType>::ThreadKind>)>

Implementations

impl RowButton

extern "C-unwind" fn mouse_entered( &self, _: Sel, _event: <&NSEvent as ConvertArgument>::__Inner, )

extern "C-unwind" fn mouse_exited( &self, _: Sel, _event: <&NSEvent as ConvertArgument>::__Inner, )

extern "C-unwind" fn mouse_down( &self, _: Sel, event: <&NSEvent as ConvertArgument>::__Inner, )

NSButton tracks the click inside mouseDown: and returns once the mouse is up.

impl RowButton

fn new( mtm: MainThreadMarker, title: &str, target: &ClickTarget, look: Rc<RowLook>, ) -> Retained<Self>

Methods from Deref<Target = NSButton>

pub fn setButtonType(&self, type: NSButtonType)

Sets the button’s type, which affects its user interface and behavior when clicked. See the NSButtonType enumeration for possible options and their behaviors.

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

The title displayed on the button when it’s in an off state, or an empty string if the button does not display a title. By default, a button’s title is “Button”.

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

Setter for title.

This is copied when set.

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

The button’s title, expressed as an attributed string.

pub fn setAttributedTitle(&self, attributed_title: &NSAttributedString)

Setter for attributedTitle.

This is copied when set.

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

The title that the button displays when the button is in an on state, or an empty string if there is no such title. Note that some button types do not display an alternate title.

pub fn setAlternateTitle(&self, alternate_title: &NSString)

Setter for alternateTitle.

This is copied when set.

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

The alternate title, expressed as an attributed string.

pub fn setAttributedAlternateTitle( &self, attributed_alternate_title: &NSAttributedString, )

Setter for attributedAlternateTitle.

This is copied when set.

pub fn hasDestructiveAction(&self) -> bool

Indicates whether the button’s action has a destructive effect on user data. AppKit may guard a destructive-actioned button against accidental presses, and may give the button a special appearance in certain contexts to caution against unintentional use. Defaults to NO.

pub fn setHasDestructiveAction(&self, has_destructive_action: bool)

Setter for hasDestructiveAction.

pub fn sound(&self) -> Option<Retained<NSSound>>

The sound that plays when the user clicks the button, or nil if the button should not play a sound. The default value is nil.

pub fn setSound(&self, sound: Option<&NSSound>)

Setter for sound.

pub fn isSpringLoaded(&self) -> bool

Sends action on deep-press or extended hover while dragging. Defaults to NO.

pub fn setSpringLoaded(&self, spring_loaded: bool)

Setter for isSpringLoaded.

pub fn maxAcceleratorLevel(&self) -> isize

Configures the maximum allowed level for an NSMultiLevelAcceleratorButton, allowed values range from [1,5]. Defaults to 2.

pub fn setMaxAcceleratorLevel(&self, max_accelerator_level: isize)

Setter for maxAcceleratorLevel.

pub fn setPeriodicDelay_interval(&self, delay: f32, interval: f32)

Sets the initial delay and repeat interval, in seconds, for repeated action messages sent when continuous is YES.

pub unsafe fn getPeriodicDelay_interval( &self, delay: NonNull<f32>, interval: NonNull<f32>, )

Gets the initial delay and repeat interval, in seconds, for repeated action messages sent when continuous is YES. Both parameters to this method must not be NULL.

Safety

• delay must be a valid pointer.
• interval must be a valid pointer.

pub fn bezelStyle(&self) -> NSBezelStyle

The bezel style of the button, which provides a set of bezel artwork, layout metrics, and content styling from a set of system-provided styles. See the NSBezelStyle enumeration for a list of available styles. The bezel style is not used if the bordered property is set to NO.

pub fn setBezelStyle(&self, bezel_style: NSBezelStyle)

Setter for bezelStyle.

pub fn isBordered(&self) -> bool

A Boolean value that determines whether the button draws a border.

pub fn setBordered(&self, bordered: bool)

Setter for isBordered.

pub fn isTransparent(&self) -> bool

A Boolean value that indicates whether the button is transparent. A transparent button never draws itself, but it receives mouse events, sends its action, and tracks the mouse properly.

pub fn setTransparent(&self, transparent: bool)

Setter for isTransparent.

pub fn showsBorderOnlyWhileMouseInside(&self) -> bool

pub fn setShowsBorderOnlyWhileMouseInside( &self, shows_border_only_while_mouse_inside: bool, )

Setter for showsBorderOnlyWhileMouseInside.

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

Applies a custom color to the button’s bezel, in appearances that support it. A nil value indicates an unmodified button appearance. The default value is nil.

pub fn setBezelColor(&self, bezel_color: Option<&NSColor>)

Setter for bezelColor.

This is copied when set.

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

Applies a tint color to template image and text content, in combination with other theme-appropriate effects. Only applicable to borderless buttons. A nil value indicates the standard set of effects without color modification. The default value is nil. Non-template images and attributed string values are not affected by the contentTintColor.

pub fn setContentTintColor(&self, content_tint_color: Option<&NSColor>)

Setter for contentTintColor.

This is copied when set.

pub fn tintProminence(&self) -> NSTintProminence

The tint prominence of the button. Use tint prominence to gently suggest a hierarchy when multiple buttons perform similar actions. A button with primary tint prominence suggests the most preferred option, while secondary prominence indicates a reasonable alternative. See NSTintProminence for a list of possible values.

pub fn setTintProminence(&self, tint_prominence: NSTintProminence)

Setter for tintProminence.

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

The image that appears on the button when it’s in an off state, or nil if there is no such image.

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

Setter for image.

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

An alternate image that appears on the button when the button is in an on state, or nil if there is no such image. Note that some button types do not display an alternate image.

pub fn setAlternateImage(&self, alternate_image: Option<&NSImage>)

Setter for alternateImage.

pub fn imagePosition(&self) -> NSCellImagePosition

The position of the button’s image relative to its title. See the NSCellImagePosition enumeration for possible values.

pub fn setImagePosition(&self, image_position: NSCellImagePosition)

Setter for imagePosition.

pub fn imageScaling(&self) -> NSImageScaling

The scaling mode applied to make the button’s image fit within its bounds.

pub fn setImageScaling(&self, image_scaling: NSImageScaling)

Setter for imageScaling.

pub fn imageHugsTitle(&self) -> bool

A Boolean value that determines how the button’s image and title are positioned together within the button bezel. If false, the image is positioned according to the imagePosition property at the edge of the button bezel, and the title is positioned within the remaining space. If true, the button’s image is positioned directly adjacent to the title based on the imagePosition property, and the image and title are positioned within the button bezel as a single unit.

pub fn setImageHugsTitle(&self, image_hugs_title: bool)

Setter for imageHugsTitle.

pub fn symbolConfiguration( &self, ) -> Option<Retained<NSImageSymbolConfiguration>>

Specifies a combination of point size, weight, and scale to use when sizing and displaying symbol images. If a symbol configuration isn’t provided, the symbol is matched to the button’s font property. The default value is nil.

pub fn setSymbolConfiguration( &self, symbol_configuration: Option<&NSImageSymbolConfiguration>, )

Setter for symbolConfiguration.

This is copied when set.

pub fn state(&self) -> isize

The button’s state. Buttons support the off and on states, and an additional mixed state depending on the value of the allowsMixedState property.

pub fn setState(&self, state: isize)

Setter for state.

pub fn allowsMixedState(&self) -> bool

A Boolean value that indicates whether the button allows a mixed state. If NO, the button has two states (on and off), and if YES, the button has three states (on, off, and mixed). The mixed state is commonly used with checkboxes and radio buttons to indicate a value which is partially on.

pub fn setAllowsMixedState(&self, allows_mixed_state: bool)

Setter for allowsMixedState.

pub fn setNextState(&self)

Sets the button to its next eligible state. If the button allows mixed state, this cycles through the states in the order: on, off, mixed, on, etc. If the button does not allow mixed state, it toggles between off and on.

pub fn highlight(&self, flag: bool)

Highlights, or un-highlights, the button. Highlighting makes the button appear “pressed”, which may include showing an illuminated bezel, or showing the alternate image or title, depending on the type of button.

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

This property contains the button’s key equivalent, or the empty string if no equivalent has been defined. Buttons don’t have a default key equivalent. Setting the key equivalent to the Return character causes it to act as the default button for its window.

pub fn setKeyEquivalent(&self, key_equivalent: &NSString)

Setter for keyEquivalent.

This is copied when set.

pub fn keyEquivalentModifierMask(&self) -> NSEventModifierFlags

A bitmask specifying the modifier keys that are applied to the button’s key equivalent. Mask bits are defined by the NSEventModifierFlags option set. The only mask bits relevant in button key-equivalent modifier masks are NSEventModifierFlagControl, NSEventModifierFlagOption, and NSEventModifierFlagCommand.

pub fn setKeyEquivalentModifierMask( &self, key_equivalent_modifier_mask: NSEventModifierFlags, )

Setter for keyEquivalentModifierMask.

pub fn performKeyEquivalent(&self, key: &NSEvent) -> bool

If the event parameter matches the button’s key equivalent, the button briefly highlights and performs its action, and then returns YES. Otherwise, returns NO.

pub fn compressWithPrioritizedCompressionOptions( &self, prioritized_options: &NSArray<NSUserInterfaceCompressionOptions>, )

pub fn minimumSizeWithPrioritizedCompressionOptions( &self, prioritized_options: &NSArray<NSUserInterfaceCompressionOptions>, ) -> CGSize

pub fn activeCompressionOptions( &self, ) -> Retained<NSUserInterfaceCompressionOptions>

pub fn borderShape(&self) -> NSControlBorderShape

pub fn setBorderShape(&self, border_shape: NSControlBorderShape)

Setter for borderShape.

pub unsafe fn setTitleWithMnemonic( &self, string_with_ampersand: Option<&NSString>, )

👎Deprecated:

Mnemonics are not used on macOS. Set the title property directly instead.

Safety

string_with_ampersand might not allow None.

Methods from Deref<Target = NSControl>

pub fn target(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setTarget(&self, target: Option<&AnyObject>)

Setter for target.

This is a [weak property][objc2::topics::weak_property].

Safety

target should be of the correct type.

pub fn action(&self) -> Option<Sel>

pub unsafe fn setAction(&self, action: Option<Sel>)

Setter for action.

Safety

action must be a valid selector.

pub fn tag(&self) -> isize

pub fn setTag(&self, tag: isize)

Setter for tag.

pub fn ignoresMultiClick(&self) -> bool

pub fn setIgnoresMultiClick(&self, ignores_multi_click: bool)

Setter for ignoresMultiClick.

pub fn isContinuous(&self) -> bool

pub fn setContinuous(&self, continuous: bool)

Setter for isContinuous.

pub fn isEnabled(&self) -> bool

pub fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub fn refusesFirstResponder(&self) -> bool

pub fn setRefusesFirstResponder(&self, refuses_first_responder: bool)

Setter for refusesFirstResponder.

pub fn isHighlighted(&self) -> bool

pub fn setHighlighted(&self, highlighted: bool)

Setter for isHighlighted.

pub fn controlSize(&self) -> NSControlSize

pub fn setControlSize(&self, control_size: NSControlSize)

Setter for controlSize.

pub fn formatter(&self) -> Option<Retained<NSFormatter>>

pub fn setFormatter(&self, formatter: Option<&NSFormatter>)

Setter for formatter.

pub fn objectValue(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setObjectValue(&self, object_value: Option<&AnyObject>)

Setter for objectValue.

This is copied when set.

Safety

object_value should be of the correct type.

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

pub fn setStringValue(&self, string_value: &NSString)

Setter for stringValue.

This is copied when set.

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

pub fn setAttributedStringValue( &self, attributed_string_value: &NSAttributedString, )

Setter for attributedStringValue.

This is copied when set.

pub fn intValue(&self) -> i32

pub fn setIntValue(&self, int_value: i32)

Setter for intValue.

pub fn integerValue(&self) -> isize

pub fn setIntegerValue(&self, integer_value: isize)

Setter for integerValue.

pub fn floatValue(&self) -> f32

pub fn setFloatValue(&self, float_value: f32)

Setter for floatValue.

pub fn doubleValue(&self) -> f64

pub fn setDoubleValue(&self, double_value: f64)

Setter for doubleValue.

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

pub fn sizeToFit(&self)

pub fn sendActionOn(&self, mask: NSEventMask) -> isize

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

Safety

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

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

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

Safety

sender should be of the correct type.

pub fn font(&self) -> Option<Retained<NSFont>>

pub fn setFont(&self, font: Option<&NSFont>)

Setter for font.

This is copied when set.

pub fn usesSingleLineMode(&self) -> bool

pub fn setUsesSingleLineMode(&self, uses_single_line_mode: bool)

Setter for usesSingleLineMode.

pub fn lineBreakMode(&self) -> NSLineBreakMode

pub fn setLineBreakMode(&self, line_break_mode: NSLineBreakMode)

Setter for lineBreakMode.

pub fn alignment(&self) -> NSTextAlignment

pub fn setAlignment(&self, alignment: NSTextAlignment)

Setter for alignment.

pub fn baseWritingDirection(&self) -> NSWritingDirection

pub fn setBaseWritingDirection( &self, base_writing_direction: NSWritingDirection, )

Setter for baseWritingDirection.

pub fn allowsExpansionToolTips(&self) -> bool

pub fn setAllowsExpansionToolTips(&self, allows_expansion_tool_tips: bool)

Setter for allowsExpansionToolTips.

pub fn expansionFrameWithFrame(&self, content_frame: CGRect) -> CGRect

pub fn drawWithExpansionFrame_inView( &self, content_frame: CGRect, view: &NSView, )

pub fn currentEditor(&self) -> Option<Retained<NSText>>

pub fn abortEditing(&self) -> bool

pub fn validateEditing(&self)

pub unsafe fn editWithFrame_editor_delegate_event( &self, rect: CGRect, text_obj: &NSText, delegate: Option<&AnyObject>, event: &NSEvent, )

Safety

delegate should be of the correct type.

pub unsafe fn selectWithFrame_editor_delegate_start_length( &self, rect: CGRect, text_obj: &NSText, delegate: Option<&AnyObject>, sel_start: isize, sel_length: isize, )

Safety

delegate should be of the correct type.

pub fn endEditing(&self, text_obj: &NSText)

pub fn setFloatingPointFormat_left_right( &self, auto_range: bool, left_digits: usize, right_digits: usize, )

👎Deprecated

pub fn cell(&self) -> Option<Retained<NSCell>>

pub fn setCell(&self, cell: Option<&NSCell>)

Setter for cell.

pub fn selectedCell(&self) -> Option<Retained<NSCell>>

pub fn selectedTag(&self) -> isize

pub fn setNeedsDisplay(&self)

👎Deprecated:

Set the needsDisplay property to YES instead

pub fn calcSize(&self)

👎Deprecated:

Override -layout instead. This method should never be called

pub fn updateCell(&self, cell: &NSCell)

pub fn updateCellInside(&self, cell: &NSCell)

pub fn drawCellInside(&self, cell: &NSCell)

pub fn drawCell(&self, cell: &NSCell)

pub fn selectCell(&self, cell: &NSCell)

pub fn invalidateIntrinsicContentSizeForCell(&self, cell: &NSCell)

Methods from Deref<Target = NSView>

pub fn candidateListTouchBarItem( &self, ) -> Option<Retained<NSCandidateListTouchBarItem>>

pub fn reflectScrolledClipView(&self, clip_view: &NSClipView)

pub fn scrollClipView_toPoint(&self, clip_view: &NSClipView, point: CGPoint)

pub fn leadingAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

pub fn trailingAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

pub fn leftAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

pub fn rightAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

pub fn topAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

pub fn bottomAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

pub fn widthAnchor(&self) -> Retained<NSLayoutDimension>

pub fn heightAnchor(&self) -> Retained<NSLayoutDimension>

pub fn centerXAnchor(&self) -> Retained<NSLayoutXAxisAnchor>

pub fn centerYAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

pub fn firstBaselineAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

pub fn lastBaselineAnchor(&self) -> Retained<NSLayoutYAxisAnchor>

pub fn constraints(&self) -> Retained<NSArray<NSLayoutConstraint>>

pub fn addConstraint(&self, constraint: &NSLayoutConstraint)

pub fn addConstraints(&self, constraints: &NSArray<NSLayoutConstraint>)

pub fn removeConstraint(&self, constraint: &NSLayoutConstraint)

pub fn removeConstraints(&self, constraints: &NSArray<NSLayoutConstraint>)

pub fn updateConstraintsForSubtreeIfNeeded(&self)

pub fn updateConstraints(&self)

pub fn needsUpdateConstraints(&self) -> bool

pub fn setNeedsUpdateConstraints(&self, needs_update_constraints: bool)

Setter for needsUpdateConstraints.

pub fn translatesAutoresizingMaskIntoConstraints(&self) -> bool

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

Setter for translatesAutoresizingMaskIntoConstraints.

pub fn alignmentRectForFrame(&self, frame: CGRect) -> CGRect

pub fn frameForAlignmentRect(&self, alignment_rect: CGRect) -> CGRect

pub fn alignmentRectInsets(&self) -> NSEdgeInsets

pub fn firstBaselineOffsetFromTop(&self) -> f64

pub fn lastBaselineOffsetFromBottom(&self) -> f64

pub fn baselineOffsetFromBottom(&self) -> f64

pub fn intrinsicContentSize(&self) -> CGSize

pub fn invalidateIntrinsicContentSize(&self)

pub fn contentHuggingPriorityForOrientation( &self, orientation: NSLayoutConstraintOrientation, ) -> f32

pub fn setContentHuggingPriority_forOrientation( &self, priority: f32, orientation: NSLayoutConstraintOrientation, )

pub fn contentCompressionResistancePriorityForOrientation( &self, orientation: NSLayoutConstraintOrientation, ) -> f32

pub fn setContentCompressionResistancePriority_forOrientation( &self, priority: f32, orientation: NSLayoutConstraintOrientation, )

pub fn isHorizontalContentSizeConstraintActive(&self) -> bool

pub fn setHorizontalContentSizeConstraintActive( &self, horizontal_content_size_constraint_active: bool, )

Setter for isHorizontalContentSizeConstraintActive.

pub fn isVerticalContentSizeConstraintActive(&self) -> bool

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

Setter for isVerticalContentSizeConstraintActive.

pub fn fittingSize(&self) -> CGSize

pub fn constraintsAffectingLayoutForOrientation( &self, orientation: NSLayoutConstraintOrientation, ) -> Retained<NSArray<NSLayoutConstraint>>

pub fn hasAmbiguousLayout(&self) -> bool

pub fn exerciseAmbiguityInLayout(&self)

pub fn addLayoutGuide(&self, guide: &NSLayoutGuide)

pub fn removeLayoutGuide(&self, guide: &NSLayoutGuide)

pub fn layoutGuides(&self) -> Retained<NSArray<NSLayoutGuide>>

pub fn enclosingMenuItem(&self) -> Option<Retained<NSMenuItem>>

pub fn wantsBestResolutionOpenGLSurface(&self) -> bool

👎Deprecated:

Use NSOpenGLView instead.

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

👎Deprecated:

Use NSOpenGLView instead.

Setter for wantsBestResolutionOpenGLSurface.

pub fn wantsExtendedDynamicRangeOpenGLSurface(&self) -> bool

👎Deprecated:

Use NSOpenGLView instead.

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

👎Deprecated:

Use NSOpenGLView instead.

Setter for wantsExtendedDynamicRangeOpenGLSurface.

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

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

Setter for pressureConfiguration.

pub fn rulerView_shouldMoveMarker( &self, ruler: &NSRulerView, marker: &NSRulerMarker, ) -> bool

pub fn rulerView_willMoveMarker_toLocation( &self, ruler: &NSRulerView, marker: &NSRulerMarker, location: f64, ) -> f64

pub fn rulerView_didMoveMarker( &self, ruler: &NSRulerView, marker: &NSRulerMarker, )

pub fn rulerView_shouldRemoveMarker( &self, ruler: &NSRulerView, marker: &NSRulerMarker, ) -> bool

pub fn rulerView_didRemoveMarker( &self, ruler: &NSRulerView, marker: &NSRulerMarker, )

pub fn rulerView_shouldAddMarker( &self, ruler: &NSRulerView, marker: &NSRulerMarker, ) -> bool

pub fn rulerView_willAddMarker_atLocation( &self, ruler: &NSRulerView, marker: &NSRulerMarker, location: f64, ) -> f64

pub fn rulerView_didAddMarker( &self, ruler: &NSRulerView, marker: &NSRulerMarker, )

pub fn rulerView_handleMouseDown(&self, ruler: &NSRulerView, event: &NSEvent)

pub fn rulerView_willSetClientView( &self, ruler: &NSRulerView, new_client: &NSView, )

pub fn rulerView_locationForPoint( &self, ruler: &NSRulerView, point: CGPoint, ) -> f64

pub fn rulerView_pointForLocation( &self, ruler: &NSRulerView, point: f64, ) -> CGPoint

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 frameRotation(&self) -> f64

pub fn setFrameRotation(&self, frame_rotation: f64)

Setter for frameRotation.

pub fn frameCenterRotation(&self) -> f64

pub fn setFrameCenterRotation(&self, frame_center_rotation: f64)

Setter for frameCenterRotation.

pub fn setBoundsOrigin(&self, new_origin: CGPoint)

pub fn setBoundsSize(&self, new_size: CGSize)

pub fn boundsRotation(&self) -> f64

pub fn setBoundsRotation(&self, bounds_rotation: f64)

Setter for boundsRotation.

pub fn translateOriginToPoint(&self, translation: CGPoint)

pub fn scaleUnitSquareToSize(&self, new_unit_size: CGSize)

pub fn rotateByAngle(&self, angle: f64)

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 lockFocusIfCanDrawInContext(&self, context: &NSGraphicsContext) -> bool

👎Deprecated:

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

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 displayRectIgnoringOpacity_inContext( &self, rect: CGRect, context: &NSGraphicsContext, )

pub fn bitmapImageRepForCachingDisplayInRect( &self, rect: CGRect, ) -> Option<Retained<NSBitmapImageRep>>

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

pub fn viewWillDraw(&self)

pub fn scrollPoint(&self, point: CGPoint)

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

pub fn autoscroll(&self, event: &NSEvent) -> 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 performKeyEquivalent(&self, event: &NSEvent) -> bool

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

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

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 makeBackingLayer(&self) -> Retained<CALayer>

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 layer(&self) -> Option<Retained<CALayer>>

pub fn setLayer(&self, layer: Option<&CALayer>)

Setter for layer.

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 alphaValue(&self) -> f64

pub fn setAlphaValue(&self, alpha_value: f64)

Setter for alphaValue.

pub fn layerUsesCoreImageFilters(&self) -> bool

pub fn setLayerUsesCoreImageFilters(&self, layer_uses_core_image_filters: bool)

Setter for layerUsesCoreImageFilters.

pub fn backgroundFilters(&self) -> Retained<NSArray<CIFilter>>

pub fn setBackgroundFilters(&self, background_filters: &NSArray<CIFilter>)

Setter for backgroundFilters.

This is copied when set.

pub fn compositingFilter(&self) -> Option<Retained<CIFilter>>

pub fn setCompositingFilter(&self, compositing_filter: Option<&CIFilter>)

Setter for compositingFilter.

pub fn contentFilters(&self) -> Retained<NSArray<CIFilter>>

pub fn setContentFilters(&self, content_filters: &NSArray<CIFilter>)

Setter for contentFilters.

This is copied when set.

pub fn shadow(&self) -> Option<Retained<NSShadow>>

pub fn setShadow(&self, shadow: Option<&NSShadow>)

Setter for shadow.

This is copied when set.

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 enclosingScrollView(&self) -> Option<Retained<NSScrollView>>

pub fn menuForEvent(&self, event: &NSEvent) -> Option<Retained<NSMenu>>

pub fn willOpenMenu_withEvent(&self, menu: &NSMenu, event: &NSEvent)

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.

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

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.

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 inputContext(&self) -> Option<Retained<NSTextInputContext>>

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

pub fn userInterfaceLayoutDirection(&self) -> NSUserInterfaceLayoutDirection

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

Setter for userInterfaceLayoutDirection.

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 writeEPSInsideRect_toPasteboard( &self, rect: CGRect, pasteboard: &NSPasteboard, )

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

pub fn writePDFInsideRect_toPasteboard( &self, rect: CGRect, pasteboard: &NSPasteboard, )

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 heightAdjustLimit(&self) -> f64

pub fn widthAdjustLimit(&self) -> f64

pub unsafe fn adjustPageWidthNew_left_right_limit( &self, new_right: NonNull<f64>, old_left: f64, old_right: f64, right_limit: f64, )

Safety

new_right must be a valid pointer.

pub unsafe fn adjustPageHeightNew_top_bottom_limit( &self, new_bottom: NonNull<f64>, old_top: f64, old_bottom: f64, bottom_limit: f64, )

Safety

new_bottom 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 beginDraggingSessionWithItems_event_source( &self, items: &NSArray<NSDraggingItem>, event: &NSEvent, source: &ProtocolObject<dyn NSDraggingSource>, ) -> Retained<NSDraggingSession>

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

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

pub fn unregisterDraggedTypes(&self)

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

Safety

options generic should be of the correct type.

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 unsafe fn showDefinitionForAttributedString_range_options_baselineOriginProvider( &self, attr_string: Option<&NSAttributedString>, target_range: NSRange, options: Option<&NSDictionary<NSString>>, origin_provider: Option<&Block<dyn Fn(NSRange) -> CGPoint>>, )

Safety

options generic should be of the correct type.

pub fn isDrawingFindIndicator(&self) -> bool

pub fn gestureRecognizers(&self) -> Retained<NSArray<NSGestureRecognizer>>

pub fn setGestureRecognizers( &self, gesture_recognizers: &NSArray<NSGestureRecognizer>, )

Setter for gestureRecognizers.

This is copied when set.

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

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

pub fn allowedTouchTypes(&self) -> NSTouchTypeMask

pub fn setAllowedTouchTypes(&self, allowed_touch_types: NSTouchTypeMask)

Setter for allowedTouchTypes.

pub fn safeAreaInsets(&self) -> NSEdgeInsets

pub fn additionalSafeAreaInsets(&self) -> NSEdgeInsets

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

Setter for additionalSafeAreaInsets.

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

pub fn safeAreaRect(&self) -> CGRect

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

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 addTrackingArea(&self, tracking_area: &NSTrackingArea)

pub fn removeTrackingArea(&self, tracking_area: &NSTrackingArea)

pub fn trackingAreas(&self) -> Retained<NSArray<NSTrackingArea>>

pub fn updateTrackingAreas(&self)

pub fn addCursorRect_cursor(&self, rect: CGRect, object: &NSCursor)

pub fn removeCursorRect_cursor(&self, rect: CGRect, object: &NSCursor)

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 unsafe fn displayLinkWithTarget_selector( &self, target: &AnyObject, selector: Sel, ) -> Retained<CADisplayLink>

Safety

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

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

👎Deprecated:

Use -beginDraggingSessionWithItems:event:source: instead

Safety

source_obj should be of the correct type.

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

👎Deprecated:

Use -beginDraggingSessionWithItems:event:source: instead

pub unsafe fn dragPromisedFilesOfTypes_fromRect_source_slideBack_event( &self, type_array: &NSArray<NSString>, rect: CGRect, source_object: &AnyObject, flag: bool, event: &NSEvent, ) -> bool

👎Deprecated:

Use -beginDraggingSessionWithItems:event:source: with an NSFilePromiseProvider instead

Safety

source_object should be of the correct type.

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

pub fn writingToolsCoordinator( &self, ) -> Option<Retained<NSWritingToolsCoordinator>>

pub fn setWritingToolsCoordinator( &self, writing_tools_coordinator: Option<&NSWritingToolsCoordinator>, )

Setter for writingToolsCoordinator.

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

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

pub fn rectForLayoutRegion(&self, layout_region: &NSViewLayoutRegion) -> CGRect

Methods from Deref<Target = NSResponder>

pub fn interfaceStyle(&self) -> usize

👎Deprecated

pub fn setInterfaceStyle(&self, interface_style: usize)

👎Deprecated

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 fn performKeyEquivalent(&self, event: &NSEvent) -> bool

pub fn validRequestorForSendType_returnType( &self, send_type: Option<&NSString>, return_type: Option<&NSString>, ) -> Option<Retained<AnyObject>>

pub fn mouseDown(&self, event: &NSEvent)

pub fn rightMouseDown(&self, event: &NSEvent)

pub fn otherMouseDown(&self, event: &NSEvent)

pub fn mouseUp(&self, event: &NSEvent)

pub fn rightMouseUp(&self, event: &NSEvent)

pub fn otherMouseUp(&self, event: &NSEvent)

pub fn mouseMoved(&self, event: &NSEvent)

pub fn mouseDragged(&self, event: &NSEvent)

pub fn mouseCancelled(&self, event: &NSEvent)

pub fn scrollWheel(&self, event: &NSEvent)

pub fn rightMouseDragged(&self, event: &NSEvent)

pub fn otherMouseDragged(&self, event: &NSEvent)

pub fn mouseEntered(&self, event: &NSEvent)

pub fn mouseExited(&self, event: &NSEvent)

pub fn keyDown(&self, event: &NSEvent)

pub fn keyUp(&self, event: &NSEvent)

pub fn flagsChanged(&self, event: &NSEvent)

pub fn tabletPoint(&self, event: &NSEvent)

pub fn tabletProximity(&self, event: &NSEvent)

pub fn cursorUpdate(&self, event: &NSEvent)

pub fn magnifyWithEvent(&self, event: &NSEvent)

pub fn rotateWithEvent(&self, event: &NSEvent)

pub fn swipeWithEvent(&self, event: &NSEvent)

pub fn beginGestureWithEvent(&self, event: &NSEvent)

pub fn endGestureWithEvent(&self, event: &NSEvent)

pub fn smartMagnifyWithEvent(&self, event: &NSEvent)

pub fn changeModeWithEvent(&self, event: &NSEvent)

pub fn touchesBeganWithEvent(&self, event: &NSEvent)

pub fn touchesMovedWithEvent(&self, event: &NSEvent)

pub fn touchesEndedWithEvent(&self, event: &NSEvent)

pub fn touchesCancelledWithEvent(&self, event: &NSEvent)

pub fn quickLookWithEvent(&self, event: &NSEvent)

pub fn pressureChangeWithEvent(&self, event: &NSEvent)

pub fn contextMenuKeyDown(&self, event: &NSEvent)

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:

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 interpretKeyEvents(&self, event_array: &NSArray<NSEvent>)

pub fn flushBufferedKeyEvents(&self)

pub fn menu(&self) -> Option<Retained<NSMenu>>

pub unsafe fn setMenu(&self, menu: Option<&NSMenu>)

Setter for menu.

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

Safety

sender should be of the correct type.

pub fn helpRequested(&self, event_ptr: &NSEvent)

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

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

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

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 fn validateProposedFirstResponder_forEvent( &self, responder: &NSResponder, event: Option<&NSEvent>, ) -> bool

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

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

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

Setter for touchBar.

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

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

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

Setter for userActivity.

pub fn updateUserActivityState(&self, user_activity: &NSUserActivity)

pub unsafe fn encodeRestorableStateWithCoder(&self, coder: &NSCoder)

Safety

coder possibly has further requirements.

pub unsafe fn encodeRestorableStateWithCoder_backgroundQueue( &self, coder: &NSCoder, queue: &NSOperationQueue, )

Safety

• coder possibly has further requirements.
• queue possibly has additional threading requirements.

pub unsafe fn restoreStateWithCoder(&self, coder: &NSCoder)

Safety

coder possibly has further requirements.

pub fn invalidateRestorableState(&self)

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 RowButton

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSButton> for RowButton

fn as_ref(&self) -> &NSButton

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

impl AsRef<NSControl> for RowButton

fn as_ref(&self) -> &NSControl

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

impl AsRef<NSObject> for RowButton

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for RowButton

fn as_ref(&self) -> &NSResponder

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

impl AsRef<NSView> for RowButton

fn as_ref(&self) -> &NSView

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

impl AsRef<RowButton> for RowButton

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for RowButton

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSButton> for RowButton

fn borrow(&self) -> &NSButton

Immutably borrows from an owned value.

impl Borrow<NSControl> for RowButton

fn borrow(&self) -> &NSControl

Immutably borrows from an owned value.

impl Borrow<NSObject> for RowButton

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for RowButton

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSView> for RowButton

fn borrow(&self) -> &NSView

Immutably borrows from an owned value.

impl ClassType for RowButton

const NAME: &'static str = "NiftyRowButton"

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

type Super = NSButton

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 RowButton

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

Formats the value using the given formatter.

impl DefinedClass for RowButton

type Ivars = Rc<RowLook>

A type representing the instance variables that this class carries.

fn ivars(&self) -> &Self::Ivars

where Self: Sized,

Get a reference to the instance variable data that this object carries.

impl Deref for RowButton

type Target = NSButton

The resulting type after dereferencing.

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

Dereferences the value.

impl DowncastTarget for RowButton

impl Message for RowButton

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

where Self: Sized,

Increment the reference count of the receiver.

impl RefEncode for RowButton

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

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