Platforms to show: All Mac Windows Linux Cross-Platform
NSScrollerMBS class
Super class: NSControlMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Cocoa Controls | MBS MacControls Plugin | 8.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
It typically displays a pair of buttons that the user can click to scroll by a small amount (called a line increment or decrement) and Alt-click to scroll by a large amount (called a page increment or decrement), plus a slot containing a knob that the user can drag directly to the desired location. The knob indicates both the position within the document view and, by varying in size within the slot, the amount visible relative to the size of the document view. You can configure whether an NSScroller object uses scroll buttons, but it always draws the knob when there's room for it.
Don't use an NSScroller when an NSSlider would be better. A slider represents a range of values for something in the application and lets the user choose a setting. A scroller represents the relative position of the visible portion of a view and lets the user choose which portion to view.
You can embed this view in a CustomNSViewMBS to get more events for mouse and keyboard.
Subclass of the NSControlMBS class.
- 6 properties
- property arrowsPosition as Integer
- property controlSize as Integer
- property controlTint as Integer
- property knobProportion as Double
- property knobStyle as Integer
- property scrollerStyle as Integer
- 16 methods
- method checkSpaceForParts
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method drawArrow(Arrow as Integer, highlight as boolean)
- method drawKnob
- method drawKnobSlotInRect(slotRect as NSRectMBS, highlight as boolean)
- method drawParts
- method highlight(flag as boolean)
- method hitPart as Integer
- method rectForPart(part as Integer) as NSRectMBS
- method setFloatValue(aFloat as Double, proportion as Double)
- method testPart(p as NSPointMBS) as Integer
- method trackKnob(theEvent as NSEventMBS)
- method trackScrollButtons(theEvent as NSEventMBS)
- method usableParts as Integer
- 5 shared methods
- shared method isCompatibleWithOverlayScrollers as boolean
- shared method NSPreferredScrollerStyleDidChangeNotification as string
- shared method preferredScrollerStyle as Integer
- shared method scrollerWidth as Double
- shared method scrollerWidthForControlSize(controlsize as Integer) as Double
- 28 constants
Constants
Constant | Value | Description |
---|---|---|
NSAllScrollerParts | 2 |
One of the constants to specify which parts of the scroller are visible.
Scroller has at least a knob, possibly also scroll buttons. |
NSBlueControlTint | 1 |
One of the constants to specify a the control tint.
Aqua control tint |
NSClearControlTint | 7 |
One of the constants to specify a the control tint.
Clear control tint |
NSDefaultControlTint | 0 |
One of the constants to specify a the control tint.
The current default tint setting |
NSGraphiteControlTint | 6 |
One of the constants to specify a the control tint.
Graphite control tint |
NSMiniControlSize | 2 |
One of the values for the ControlSize property.
The control has a smaller size than NSSmallControlSize. |
NSNoScrollerParts | 0 |
One of the constants to specify which parts of the scroller are visible.
Scroller has neither a knob nor scroll buttons, only the knob slot. |
NSOnlyScrollerArrows | 1 |
One of the constants to specify which parts of the scroller are visible.
Scroller has only scroll buttons, no knob. |
NSRegularControlSize | 0 |
One of the values for the ControlSize property.
The control is sized as regular. |
NSScrollerArrowsDefaultSetting | 0 |
One of the constants to specify where the scroller's buttons appear with the arrowsPosition property.
Contains the information from the AppleScrollBarVariant default value. |
NSScrollerArrowsMaxEnd | 0 |
One of the constants to specify where the scroller's buttons appear with the arrowsPosition property.
Buttons at bottom or right. This constant has been deprecated. |
NSScrollerArrowsMinEnd | 1 |
One of the constants to specify where the scroller's buttons appear with the arrowsPosition property.
Buttons at top or left. This has been deprecated. |
NSScrollerArrowsNone | 2 |
One of the constants to specify where the scroller's buttons appear with the arrowsPosition property.
No buttons. |
NSScrollerDecrementArrow | 1 |
One of the constants describe the two scroller buttons and are used by drawArrow.
The down or right scroll button. |
NSScrollerDecrementLine | 4 |
One of the constants to specify the different parts of the scroller.
Up or left by a small amount. |
NSScrollerDecrementPage | 1 |
One of the constants to specify the different parts of the scroller.
Up or left by a large amount. |
NSScrollerIncrementArrow | 0 |
One of the constants describe the two scroller buttons and are used by drawArrow.
The up or left scroll button. |
NSScrollerIncrementLine | 5 |
One of the constants to specify the different parts of the scroller.
Down or right by a small amount. |
NSScrollerIncrementPage | 3 |
One of the constants to specify the different parts of the scroller.
Down or right by a large amount. |
NSScrollerKnob | 2 |
One of the constants to specify the different parts of the scroller.
Directly to the NSScroller's value, as given by floatValue. |
NSScrollerKnobSlot | 6 |
One of the constants to specify the different parts of the scroller.
Directly to the NSScroller's value, as given by floatValue. |
NSScrollerNoPart | 0 |
One of the constants to specify the different parts of the scroller.
Don't scroll at all. |
NSSmallControlSize | 1 |
One of the values for the ControlSize property.
This constant is for controls that cannot be resized in one direction, such as push buttons, radio buttons, checkboxes, sliders, scroll bars, pop-up buttons, tabs, and progress indicators. You should use a small system font with a small control. |
Knob style constants
Constant | Value | Description |
---|---|---|
NSScrollerKnobStyleDark | 1 |
Specifies a dark knob. This style is particularly good against a light background. Available in Mac OS X v10.7 and later. |
NSScrollerKnobStyleDefault | 0 |
Specifies a dark knob with a light border. This is the default style; it is good against any background. Available in Mac OS X v10.7 and later. |
NSScrollerKnobStyleLight | 2 |
Specifies a light knob. This style is particularly good against a dark background. Available in Mac OS X v10.7 and later. |
Scroller Style Constants
Constant | Value | Description |
---|---|---|
NSScrollerStyleLegacy | 0 |
Specifies legacy-style scrollers as prior to Mac OS X v10.7. Available in Mac OS X v10.7 and later. |
NSScrollerStyleOverlay | 1 |
Specifies overlay-style scrollers in Mac OS X v10.7 and later. Available in Mac OS X v10.7 and later. |
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
- 57 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 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:
- DesktopListbox.HorizontalNSScrollerMBS as NSScrollerMBS
- DesktopListbox.VerticalNSScrollerMBS as NSScrollerMBS
- DesktopScrollBar.NSScrollerMBS as NSScrollerMBS
- Listbox.HorizontalNSScrollerMBS as NSScrollerMBS
- Listbox.VerticalNSScrollerMBS as NSScrollerMBS
- ScrollBar.NSScrollerMBS as NSScrollerMBS
Some properties using for this class:
- NSScrollViewMBS.horizontalScroller as NSScrollerMBS
- NSScrollViewMBS.verticalScroller as NSScrollerMBS
Some examples using this class:
Blog Entries
- Tip of the day: Autohide scrollbar
- Custom Scrollbars for Real Studio Cocoa Apps
- MBS Real Studio Plugins, version 11.3pr1
- MonkeyBread Software Releases the MBS REALbasic plug-ins 8.4
Xojo Developer Magazine
The items on this page are in the following plugins: MBS MacBase Plugin, MBS MacCocoa Plugin, MBS MacControls Plugin.