Platforms to show: All Mac Windows Linux Cross-Platform
NSButtonMBS class
Super class: NSControlMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Cocoa Controls | MBS MacControls Plugin | 7.8 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Subclass of the NSControlMBS class.
- 24 properties
- property allowsMixedState as boolean
- property alternateImage as NSImageMBS
- property alternateTitle as string
- property attributedAlternateTitle as NSAttributedStringMBS
- property attributedTitle as NSAttributedStringMBS
- property backgroundColor as NSColorMBS
- property bezelColor as NSColorMBS
- property bezelStyle as Integer
- property hasDestructiveAction as Boolean
- property image as NSImageMBS
- property imageDimsWhenDisabled as Boolean
- property imageHugsTitle as Boolean
- property imagePosition as Integer
- property imageScaling as Integer
- property isBordered as boolean
- property isTransparent as boolean
- property keyEquivalent as string
- property keyEquivalentModifierMask as Integer
- property maxAcceleratorLevel as Integer
- property showsBorderOnlyWhileMouseInside as boolean
- property sound as Variant
- property SpringLoaded as Boolean
- property state as Integer
- property title as string
- 6 methods
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method Constructor(Title as String, Image as NSImageMBS = nil, Type as Integer = 0)
- method setButtonType(buttonType as Integer)
- method setNextState
- 23 constants
Constants
Constant | Value | Description |
---|---|---|
NSCircularBezelStyle | 7 |
One of the button styles that can be specified using bezelStyle.
A round button with room for a small icon or a single character. This style has both regular and small variants, but the large variant is available only in gray at this time. |
NSDisclosureBezelStyle | 5 |
One of the button styles that can be specified using bezelStyle.
A bezel style for use with a disclosure triangle. To create the disclosure triangle, set the button bezel style to NSDisclosureBezelStyle and the button type to NSOnOffButton. |
NSHelpButtonBezelStyle | 9 |
One of the button styles that can be specified using bezelStyle.
A round button with a question mark providing the standard help button look. |
NSInlineBezelStyle | 15 |
One of the button styles that can be specified using bezelStyle.
Inline Style. |
NSMomentaryChangeButton | 5 | One of the button types that can be specified using ButtonType. While the button is held down, the alternate image and alternate title are displayed. more |
NSMomentaryLightButton | 0 | One of the button types that can be specified using ButtonType. While the button is held down it's shown as "lit," and also "pushed in" to the screen if the button is bordered. more |
NSMomentaryPushInButton | 7 | One of the button types that can be specified using ButtonType. While the button is held down it's shown as "lit." more |
NSOnOffButton | 6 |
One of the button types that can be specified using ButtonType.
The first click highlights the button; a second click returns it to the normal (unhighlighted) state. |
NSPushOnPushOffButton | 1 |
One of the button types that can be specified using ButtonType.
The first click both highlights and causes the button to be "pushed in" if the button is bordered; a second click returns it to its normal state. |
NSRadioButton | 4 |
One of the button types that can be specified using ButtonType.
This style is similar to NSSwitchButton, but it used to constrain a selection to a single element from several. |
NSRecessedBezelStyle | 13 |
One of the button styles that can be specified using bezelStyle.
A bezel style that matches the recessed buttons in Mail, Finder and Safari. |
NSRegularSquareBezelStyle | 2 |
One of the button styles that can be specified using bezelStyle.
A rectangular button with a 2 point border, designed for icons. |
NSRoundedBezelStyle | 1 |
One of the button styles that can be specified using bezelStyle.
A rounded rectangle button, designed for text. |
NSRoundedDisclosureBezelStyle | 14 |
One of the button styles that can be specified using bezelStyle.
A bezel style that matches the disclosure style used in the standard Save panel. |
NSRoundRectBezelStyle | 12 |
One of the button styles that can be specified using bezelStyle.
A bezel style that matches the search buttons in Finder and Mail. |
NSShadowlessSquareBezelStyle | 6 |
One of the button styles that can be specified using bezelStyle.
Similar to NSRegularSquareBezelStyle, but has no shadow so you can abut the cells without overlapping shadows. This style would be used in a tool palette, for example. |
NSSmallSquareBezelStyle | 10 |
One of the button styles that can be specified using bezelStyle.
A simple square bezel style. Buttons using this style can be scaled to any size. |
NSSwitchButton | 3 |
One of the button types that can be specified using ButtonType.
This style is a variant of NSToggleButton that has no border and is used to represent a checkbox. |
NSTexturedRoundedBezelStyle | 11 |
One of the button styles that can be specified using bezelStyle.
A textured (metal) bezel style similar in appearance to the Finder's action (gear) button. |
NSTexturedSquareBezelStyle | 8 |
One of the button styles that can be specified using bezelStyle.
A bezel style appropriate for use with textured (metal) windows. |
NSThickerSquareBezelStyle | 4 |
One of the button styles that can be specified using bezelStyle.
A rectangular button with a 4 point border, designed for icons. |
NSThickSquareBezelStyle | 3 |
One of the button styles that can be specified using bezelStyle.
A rectangular button with a 3 point border, designed for icons. |
NSToggleButton | 2 |
One of the button types that can be specified using ButtonType.
After the first click, the button displays its alternate image or title; a second click returns the button to its normal state. |
Super class NSControlMBS
- 6 events
- event Action
- event TextDidBeginEditing(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
- event TextDidChange(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
- event TextDidEndEditing(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
- event textShouldBeginEditing(fieldEditor as NSTextMBS) as boolean
- event textShouldEndEditing(fieldEditor as NSTextMBS) as boolean
- 19 properties
- property ActionSelector as String
- property alignment as Integer
- property attributedStringValue as NSAttributedStringMBS
- property baseWritingDirection as Integer
- property cell as Variant
- property controlSize as Integer
- property currentEditor as NSTextMBS
- property doubleValue as Double
- property font as NSFontMBS
- property ignoresMultiClick as boolean
- property integerValue as Integer
- property intValue as Integer
- property isContinuous as boolean
- property isEnabled as boolean
- property refusesFirstResponder as boolean
- property selectedCell as NSCellMBS
- property selectedTag as Integer
- property stringValue as string
- property tag as Integer
- 12 methods
- method calcSize
- method ConnectActionEvent
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method Destructor
- method EnableEvents
- method performClick
- method selectCell(Cell as NSCellMBS)
- method setNeedsDisplay
- method sizeToFit
- method validateEditing
- 4 constants
Constants
Constant | Value | Description |
---|---|---|
ControlSizeLarge | 3 |
One of the constants to specify a cell’s size.
A size larger than the default control size. |
ControlSizeMini | 2 |
One of the constants to specify a cell’s size.
The smallest control size. |
ControlSizeRegular | 0 |
One of the constants to specify a cell’s size.
The default control size. |
ControlSizeSmall | 1 | One of the constants to specify a cell’s size. A size smaller than the default control size. more |
Super class NSViewMBS
- 43 properties
- property acceptsTouchEvents as boolean
- property allowsVibrancy as Boolean
- property alphaValue as Double
- property autoresizesSubviews as boolean
- property autoresizingMask as Integer
- property bounds as NSRectMBS
- property boundsRotation as Double
- property canBecomeKeyView as boolean
- property canDraw as boolean
- property canDrawConcurrently as boolean
- property className as string
- property classPath as string
- property clipsToBounds as Boolean
- property focusRingType as Integer
- property frame as NSRectMBS
- property frameCenterRotation as Double
- property frameHeight as Double
- property frameLeft as Double
- property frameRotation as Double
- property frameTop as Double
- property frameWidth as Double
- property identifier as string
- property isFlipped as Boolean
- property isHidden as Boolean
- property isHiddenOrHasHiddenAncestor as Boolean
- property isOpaque as Boolean
- property isRotatedFromBase as Boolean
- property isRotatedOrScaledFromBase as Boolean
- property layer as Variant
- property layerUsesCoreImageFilters as Boolean
- property needsDisplay as Boolean
- property nextKeyView as NSViewMBS
- property opaqueAncestor as NSViewMBS
- property RetainCount as Integer
- property superview as NSViewMBS
- property toolTip as string
- property userInteractionEnabled as Boolean
- property visibleRect as NSRectMBS
- property wantsDefaultClipping as boolean
- property wantsLayer as Boolean
- property wantsRestingTouches as boolean
- property window as NSWindowMBS
- property compositingFilter as variant
- 58 methods
- method addSubview(subview as NSViewMBS)
- method addSubview(subview as NSViewMBS, positioned as Integer, relativeToView as NSViewMBS)
- method addToolTipRect(rect as NSRectMBS, tooltip as NSViewTooltipMBS)
- method ancestorSharedWithView(view as NSViewMBS) as NSViewMBS
- method animator as NSViewMBS
- method backgroundFilters as variant()
- method beginDraggingSessionWithItems(items() as Variant, e as NSEventMBS, source as NSViewMBS) as Variant
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method contentFilters as variant()
- method convertPointFromView(point as NSPointMBS, View as NSViewMBS) as NSPointMBS
- method convertPointToView(point as NSPointMBS, View as NSViewMBS) as NSPointMBS
- method convertRectFromView(rect as NSRectMBS, View as NSViewMBS) as NSRectMBS
- method convertRectToView(rect as NSRectMBS, View as NSViewMBS) as NSRectMBS
- method convertSizeFromView(Size as NSSizeMBS, View as NSViewMBS) as NSSizeMBS
- method convertSizeToView(Size as NSSizeMBS, View as NSViewMBS) as NSSizeMBS
- method dataWithEPSInsideRect(left as Double, top as Double, width as Double, height as Double) as Memoryblock
- method dataWithPDFInsideRect(left as Double, top as Double, width as Double, height as Double) as Memoryblock
- method dataWithPDFInsideRect(r as NSRectMBS) as Memoryblock
- method dragImage(image as NSImageMBS, viewLocation as NSPointMBS, offset as NSSizeMBS, NSEvent as NSEventMBS, pboard as NSPasteboardMBS, source as NSViewMBS, slideFlag as boolean)
- method drawFocusRingMask
- method enclosingMenuItem as Variant
- method enclosingScrollView as Variant
- method focusRingMaskBounds as NSRectMBS
- method hitTest(x as double, y as double) as NSViewMBS New in 24.4
- method isDescendantOf(view as NSViewMBS) as boolean
- method makeBackingLayer as Variant
- method nextValidKeyView as NSViewMBS
- method noteFocusRingMaskChanged
- method pageFooter as NSAttributedStringMBS
- method pageHeader as NSAttributedStringMBS
- method previousKeyView as NSViewMBS
- method previousValidKeyView as NSViewMBS
- method print
- method registeredDraggedTypes as string()
- method registerForDraggedTypes(Types() as string)
- method removeAllToolTips
- method removeFromSuperview
- method removeFromSuperviewWithoutNeedingDisplay
- method RenderImage(subviews as boolean = false, flipped as boolean = false) as variant
- method replaceSubview(oldView as NSViewMBS, newView as NSViewMBS)
- method rotateByAngle(angle as Double)
- method scaleUnitSquareToSize(size as NSSizeMBS)
- method Screenshot as Picture
- method setBackgroundFilters(Filters() as variant)
- method setBoundsOrigin(origin as NSPointMBS)
- method setBoundsOrigin(x as Double, y as Double)
- method setBoundsSize(size as NSSizeMBS)
- method setBoundsSize(width as Double, height as Double)
- method setContentFilters(Filters() as variant)
- method setFocus
- method setFrameOrigin(origin as NSPointMBS)
- method setFrameOrigin(x as Double, y as Double)
- method setFrameSize(size as NSSizeMBS)
- method setFrameSize(width as Double, height as Double)
- method subviews(recursive as boolean = false) as NSViewMBS()
- method unregisterDraggedTypes
- 5 shared methods
- shared method NSViewBoundsDidChangeNotification as string
- shared method NSViewDidUpdateTrackingAreasNotification as string
- shared method NSViewFocusDidChangeNotification as string
- shared method NSViewFrameDidChangeNotification as string
- shared method NSViewGlobalFrameDidChangeNotification as string
- 21 constants
Constants
Constant | Value | Description |
---|---|---|
NSBezelBorder | 2 |
One of the constants to specify the type of a view's border.
A concave border that makes the view look sunken. |
NSFocusRingTypeDefault | 0 |
One of the constants for the focusringtype property.
The default focus ring type for NSView or NSCell. |
NSFocusRingTypeExterior | 2 |
One of the constants for the focusringtype property.
The standard Aqua focus ring. |
NSFocusRingTypeNone | 1 |
One of the constants for the focusringtype property.
No focus ring. If you set the focus ring type to this value, NSView and NSCell will not draw any focus ring. |
NSGrooveBorder | 3 |
One of the constants to specify the type of a view's border.
A thin border that looks etched around the image. |
NSLineBorder | 1 |
One of the constants to specify the type of a view's border.
A black line border around the view. |
NSNoBorder | 0 |
One of the constants to specify the type of a view's border.
No border. |
NSViewHeightSizable | 16 |
One of the constants for the autoresizingMask property.
The receiver's height is flexible. |
NSViewLayerContentsRedrawBeforeViewResize | 3 | One of the view layer content redraw policy constants. |
NSViewLayerContentsRedrawDuringViewResize | 2 | One of the view layer content redraw policy constants. |
NSViewLayerContentsRedrawNever | 0 | One of the view layer content redraw policy constants. |
NSViewLayerContentsRedrawOnSetNeedsDisplay | 1 | One of the view layer content redraw policy constants. |
NSViewMaxXMargin | 4 |
One of the constants for the autoresizingMask property.
The right margin between the receiver and its superview is flexible. |
NSViewMaxYMargin | 32 |
One of the constants for the autoresizingMask property.
The top margin between the receiver and its superview is flexible. |
NSViewMinXMargin | 1 |
One of the constants for the autoresizingMask property.
The left margin between the receiver and its superview is flexible. |
NSViewMinYMargin | 8 |
One of the constants for the autoresizingMask property.
The bottom margin between the receiver and its superview is flexible. |
NSViewNotSizable | 0 |
One of the constants for the autoresizingMask property.
The receiver cannot be resized. |
NSViewWidthSizable | 2 |
One of the constants for the autoresizingMask property.
The receiver's width is flexible. |
Window Order Constants
Constant | Value | Description |
---|---|---|
NSWindowAbove | 1 |
Moves the window above the indicated window. |
NSWindowBelow | -1 |
Moves the window below the indicated window. |
NSWindowOut | 0 |
Moves the window off the screen. |
Super class NSResponderMBS
- 3 properties
- property Handle as Integer
- property menu as NSMenuMBS
- property nextResponder as NSResponderMBS
- 123 methods
- method beginGestureWithEvent(e as NSEventMBS)
- method cancelOperation
- method capitalizeWord
- method centerSelectionInVisibleArea
- method changeCaseOfLetter
- method complete
- method Constructor Private
- method cursorUpdate(e as NSEventMBS)
- method deleteBackward
- method deleteBackwardByDecomposingPreviousCharacter
- method deleteForward
- method deleteToBeginningOfLine
- method deleteToBeginningOfParagraph
- method deleteToEndOfLine
- method deleteToEndOfParagraph
- method deleteToMark
- method deleteWordBackward
- method deleteWordForward
- method endGestureWithEvent(e as NSEventMBS)
- method flagsChanged(e as NSEventMBS)
- method flushBufferedKeyEvents
- method helpRequested(e as NSEventMBS)
- method indent
- method insertBacktab
- method insertContainerBreak
- method insertDoubleQuoteIgnoringSubstitution
- method insertLineBreak
- method insertNewline
- method insertNewlineIgnoringFieldEditor
- method insertParagraphSeparator
- method insertSingleQuoteIgnoringSubstitution
- method insertTab
- method insertTabIgnoringFieldEditor
- method keyDown(e as NSEventMBS)
- method keyUp(e as NSEventMBS)
- method lowercaseWord
- method magnifyWithEvent(e as NSEventMBS)
- method makeBaseWritingDirectionLeftToRight
- method makeBaseWritingDirectionNatural
- method makeBaseWritingDirectionRightToLeft
- method makeTextWritingDirectionLeftToRight
- method makeTextWritingDirectionNatural
- method makeTextWritingDirectionRightToLeft
- method mouseDown(e as NSEventMBS)
- method mouseDragged(e as NSEventMBS)
- method mouseEntered(e as NSEventMBS)
- method mouseExited(e as NSEventMBS)
- method mouseMoved(e as NSEventMBS)
- method mouseUp(e as NSEventMBS)
- method moveBackward
- method moveBackwardAndModifySelection
- method moveDown
- method moveDownAndModifySelection
- method moveForward
- method moveForwardAndModifySelection
- method moveLeft
- method moveLeftAndModifySelection
- method moveParagraphBackwardAndModifySelection
- method moveParagraphForwardAndModifySelection
- method moveRight
- method moveRightAndModifySelection
- method moveToBeginningOfDocument
- method moveToBeginningOfDocumentAndModifySelection
- method moveToBeginningOfLine
- method moveToBeginningOfLineAndModifySelection
- method moveToBeginningOfParagraph
- method moveToBeginningOfParagraphAndModifySelection
- method moveToEndOfDocument
- method moveToEndOfDocumentAndModifySelection
- method moveToEndOfLine
- method moveToEndOfLineAndModifySelection
- method moveToEndOfParagraph
- method moveToEndOfParagraphAndModifySelection
- method moveToLeftEndOfLine
- method moveToLeftEndOfLineAndModifySelection
- method moveToRightEndOfLine
- method moveToRightEndOfLineAndModifySelection
- method moveUp
- method moveUpAndModifySelection
- method moveWordBackward
- method moveWordBackwardAndModifySelection
- method moveWordForward
- method moveWordForwardAndModifySelection
- method moveWordLeft
- method moveWordLeftAndModifySelection
- method moveWordRight
- method moveWordRightAndModifySelection
- method otherMouseDown(e as NSEventMBS)
- method otherMouseDragged(e as NSEventMBS)
- method otherMouseUp(e as NSEventMBS)
- method pageDown
- method pageDownAndModifySelection
- method pageUp
- method pageUpAndModifySelection
- method performMnemonic(theString as string) as boolean
- method presentError(e as NSErrorMBS) as boolean
- method rightMouseDown(e as NSEventMBS)
- method rightMouseDragged(e as NSEventMBS)
- method rightMouseUp(e as NSEventMBS)
- method rotateWithEvent(e as NSEventMBS)
- method scrollLineDown
- method scrollLineUp
- method scrollPageDown
- method scrollPageUp
- method scrollToBeginningOfDocument
- method scrollToEndOfDocument
- method scrollWheel(e as NSEventMBS)
- method selectAll
- method selectLine
- method selectParagraph
- method selectToMark
- method selectWord
- method setMark
- method showContextHelp
- method swapWithMark
- method swipeWithEvent(e as NSEventMBS)
- method tabletPoint(e as NSEventMBS)
- method tabletProximity(e as NSEventMBS)
- method transpose
- method transposeWords
- method undoManager as NSUndoManagerMBS
- method uppercaseWord
- method yank
Sub classes:
Some methods using this class:
- BevelButton.NSButtonMBS as NSButtonMBS
- CheckBox.NSButtonMBS as NSButtonMBS
- DesktopBevelButton.NSButtonMBS as NSButtonMBS
- DesktopButton.NSButtonMBS as NSButtonMBS
- DesktopCheckBox.NSButtonMBS as NSButtonMBS
- DesktopPopupMenu.NSButtonMBS as NSButtonMBS
- DesktopRadioButton.NSButtonMBS as NSButtonMBS
- DesktopRadioGroup.NSButtonsMBS as NSButtonMBS()
- DisclosureTriangle.NSButtonMBS as NSButtonMBS
- RadioButton.NSButtonMBS as NSButtonMBS
Some properties using for this class:
- DesktopNSButtonControlMBS.View as NSButtonMBS
- NSButtonControlMBS.View as NSButtonMBS
- NSCollectionViewSectionHeaderViewMBS.sectionCollapseButton as NSButtonMBS
Some examples using this class:
- /MacBase/Custom NSWindows/NSWindow like AppStore/AppStore NSWindow
- /MacCocoa/Dynamic FileOpenDialog
- /MacCocoa/Hide Window Buttons
- /MacControls/Listbox and TableView Demos/ListboxTV drop-in/Flat Only/ListBoxTV Database with DataSource
- /MacControls/Listbox and TableView Demos/ListboxTV drop-in/Flat Only/ListBoxTV Simple Demo with DataSource
- /MacControls/Listbox and TableView Demos/ListboxTV drop-in/Hierarchical & Flat/ListBoxTV OutlineView
- /MacControls/NSButton
- /MacControls/NSButton Control Array
- /MacControls/Toolbar/Toolbar buttons/Toolbar buttons
- /MacFrameworks/Cocoa Controls/NSButton test
Blog Entries
- MonkeyBread Software Releases the MBS Xojo Plugins in version 22.5
- MBS Xojo Plugins, version 22.5pr1
- MBS Xojo / Real Studio Plugins, version 16.5pr5
- MBS Xojo / Real Studio Plugins, version 15.2pr3
- MBS Xojo / Real Studio Plugins, version 14.2pr8
- Geoff's Cocoa update
Xojo Developer Magazine
Release notes
- Version 22.5
- Added hasDestructiveAction property for NSButtonMBS class.
The items on this page are in the following plugins: MBS MacBase Plugin, MBS MacCocoa Plugin, MBS MacControls Plugin.
NSButtonCellMBS - NSCachedURLResponseMBS