# NSButton

scottc@net-community.com
Generated at 2026-02-17 21:02:56 +0000

The button class

1996 Free Software Foundation, Inc.
Software documentation for the NSButton class
AppKit/NSButton.h
TODO Description
allowsMixedState
Description forthcoming.
alternateImage

Returns the NSButtonCell's alternate image.

See Also: -setAlternateImage: [NSButtonCell -alternateImage]

alternateTitle

Returns the NSButtonCell's alternate title.

See Also: -setAlternateTitle: [NSButtonCell -alternateTitle]

attributedAlternateTitle
Description forthcoming.
attributedTitle
Description forthcoming.
bezelStyle

Returns the style of the NSButtonCell's bezeled border. See NSBezelStyle for more information.

See Also: -setBezelStyle: [NSButtonCell -bezelStyle]

getPeriodicDelay:
delay
interval:
interval

Gets the NSButtonCell's delay and the interval parameters used when NSButton sends continouly action messages. By default delay is 0.4 and interval is 0.075.

See Also: [NSButtonCell -getPeriodicDelay:interval:] -setPeriodicDelay:interval: [NSCell -trackMouse:inRect:ofView:untilMouseUp:]

highlight:
flag

(Un)Highlights the NSButtonCell.

See Also: [NSButtonCell -highlight:withFrame:inView:]

image

Returns the NSButtonCell's image.

See Also: -setImage: [NSButtonCell -image]

imagePosition

Returns the position of the NSButtonCell's image. See NSCellImagePosition for more information.

See Also: -setImagePosition: [NSButtonCell -imagePosition]

isBordered

Returns whether the NSButton's cell has border.

See Also: -setBordered: [NSButtonCell -isBordered]

isTransparent

Returns whether the NSButton's cell is transparent.

See Also: -setTransparent: [NSButtonCell -isTransparent]

keyEquivalent

Returns the NSButtonCell's key equivalent. The key equivalent and its modifier mask are used to simulate the click of the button in -performKeyEquivalent: . Returns an empty string if no key equivalent is defined. By default NSButton hasn't key equivalent.

See Also: -setKeyEquivalent: -performKeyEquivalent: -keyEquivalentModifierMask [NSButtonCell -keyEquivalent]

keyEquivalentModifierMask

Returns the modifier mask of the NSButtonCell's key equivalent. The key equivalent and its modifier mask are used to simulate the click of the button in -performKeyEquivalent: . The default mask is NSCommandKeyMask.

See Also: -setKeyEquivalentModifierMask: -keyEquivalent [NSButtonCell -setKeyEquivalentModifierMask:]

performKeyEquivalent:
anEvent

Simulates the click of the button if the key equivalent and its modifier mask match the event anEvent. By default the key modifier mask is NSCommandKeyMask and there is no key equivalent

See Also: -keyEquivalent -keyEquivalentModifierMask [NSControl -performClick:] [NSEvent -charactersIgnoringModifiers] [NSEvent -modifierFlags]

Does nothing and returns `NO` if the receiver is disabled or if it is blocked by a modal window being run.
setAllowsMixedState:
flag
Description forthcoming.
setAlternateImage:
anImage

Sets the NSButtonCell's alternate image to anImage and marks self for display.

See Also: -alternateImage [NSButtonCell -setAlternateImage:]

setAlternateTitle:
aString

Sets the NSButtonCell's alternateTitle to aString and marks self for display.

See Also: -alternateTitle

setAttributedAlternateTitle:
aString
Description forthcoming.
setAttributedTitle:
aString
Description forthcoming.
setBezelStyle:
bezelStyle

Sets the style of the NSButtonCell's bezeled border and marks self for display. See NSBezelStyle for more information.

See Also: -bezelStyle [NSButtonCell -setBezelStyle:]

setBordered:
flag

Sets whether the NSButton's cell has border and marks self for display.

See Also: -isBordered [NSButtonCell -setBordered:]

setButtonType:
aType

Sets the NSButtonCell's type to aType and marks self for display.See NSButtonType for more information.

See Also: [NSButtonCell -setButtonType:]

setHighlightsBy:
aType
Description forthcoming.
setImage:
anImage

Sets the NSButtonCell's image to anImage and marks self for display.

See Also: -image [NSButtonCell -setImage:]

setImagePosition:
aPosition

Sets the postion of the NSButtonCell's image to aPosition and marks self for display. See NSCellImagePosition for more information.

See Also: -imagePosition [NSButtonCell -setImagePosition:]

setKeyEquivalent:
aKeyEquivalent

Sets the NSButtonCell's key equivalent to aKeyEquivalent. The key equivalent and its modifier mask are used to simulate the click of the button in -performKeyEquivalent: . By default NSButton hasn't key equivalent.

See Also: -keyEquivalent -setKeyEquivalentModifierMask: -performKeyEquivalent: [NSButtonCell -setKeyEquivalent:]

setKeyEquivalentModifierMask:
mask

Sets the modifier mask of the NSButtonCell's key equivalent to mask. The key equivalent and its modifier mask are used to simulate the click of the button in -performKeyEquivalent: . By default the mask is NSCommandKeyMask.

See Also: -keyEquivalentModifierMask -setKeyEquivalent: -performKeyEquivalent: [NSButtonCell -setKeyEquivalentModifierMask:]

setNextState

Sets the NSButtonCell to the next state and marks self for display.

See Also: [NSButtonCell -setNextState]

setPeriodicDelay:
delay
interval:
interval

Sets the NSButtonCell's delay and interval parameters used when NSButton sends continouly action messages. By default delay is 0.4 and interval is 0.075.

See Also: [NSButtonCell -setPeriodicDelay:interval:] -getPeriodicDelay:interval: [NSCell -trackMouse:inRect:ofView:untilMouseUp:]

setShowsBorderOnlyWhileMouseInside:
show
Description forthcoming.
setShowsStateBy:
aType
Description forthcoming.
setSound:
aSound
Description forthcoming.
setState:
value

Sets the NSButtonCell's state to value and marks self for display.

See Also: -state [NSButtonCell -setState:]

setTitle:
aString

Sets the NSButtonCell's title to aString and marks self for display.

See Also: -title

setTitleWithMnemonic:
aString
Description forthcoming.
setTransparent:
flag

Sets whether the NSButton's cell is transparent and marks self for display.

See Also: -isTransparent [NSButtonCell -setTransparent:]

showsBorderOnlyWhileMouseInside
Description forthcoming.
sound
Description forthcoming.
state

Returns the NSButtonCell's state.

See Also: -setState: [NSButtonCell -state]

title

Returns the NSButtonCell's title.

See Also: [NSButtonCell -title] -setTitle: