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
An NSScroller object controls scrolling of a document view within an NSScrollView's clip view (or potentially another kind of container view).

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.

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

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

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

Sub classes:

Some methods using this class:

Some properties using for this class:

Some examples using this class:

Blog Entries

Xojo Developer Magazine


The items on this page are in the following plugins: MBS MacBase Plugin, MBS MacCocoa Plugin, MBS MacControls Plugin.


NSScreenMBS   -   NSScrollViewMBS


The biggest plugin in space...