Platforms to show: All Mac Windows Linux Cross-Platform
CustomNSSearchFieldMBS class
Super class: NSSearchFieldMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Cocoa Controls | MBS MacCocoa Plugin | 12.4 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Some events will not fire as Searchfield eats them itself.
Subclass of the NSSearchFieldMBS class.
- 46 events
- event acceptsFirstMouse(e as NSEventMBS) as boolean
- event acceptsFirstResponder as boolean
- event becomeFirstResponder as boolean
- event beginGestureWithEvent(e as NSEventMBS) as boolean
- event canBecomeKeyView as boolean
- event Close
- event concludeDragOperation(sender as NSDraggingInfoMBS)
- event draggingEnded(sender as NSDraggingInfoMBS)
- event draggingEntered(sender as NSDraggingInfoMBS) as Integer
- event draggingExited(sender as NSDraggingInfoMBS)
- event draggingSessionEndedAtPoint(session as NSDraggingSessionMBS, screenPoint as NSPointMBS, operation as Integer)
- event draggingSessionMovedToPoint(session as NSDraggingSessionMBS, screenPoint as NSPointMBS)
- event draggingSessionSourceOperationMaskForDraggingContext(session as NSDraggingSessionMBS, context as Integer) as Integer
- event draggingSessionWillBeginAtPoint(session as NSDraggingSessionMBS, screenPoint as NSPointMBS)
- event draggingUpdated(sender as NSDraggingInfoMBS) as Integer
- event endGestureWithEvent(e as NSEventMBS) as boolean
- event ignoreModifierKeysForDraggingSession(session as NSDraggingSessionMBS) as boolean
- event isOpaque as boolean
- event keyDown(e as NSEventMBS) as boolean
- event keyUp(e as NSEventMBS) as boolean
- event magnifyWithEvent(e as NSEventMBS) as boolean
- event menuForEvent(e as NSEventMBS, defaultMenu as NSMenuMBS) as NSMenuMBS
- event mouseDown(e as NSEventMBS, x as Double, y as Double) as boolean
- event mouseDownCanMoveWindow as boolean
- event mouseDragged(e as NSEventMBS, x as Double, y as Double) as boolean
- event mouseEntered(e as NSEventMBS, x as Double, y as Double) as boolean
- event mouseExited(e as NSEventMBS, x as Double, y as Double) as boolean
- event mouseMoved(e as NSEventMBS, x as Double, y as Double) as boolean
- event mouseUp(e as NSEventMBS, x as Double, y as Double) as boolean
- event Open
- event otherMouseDown(e as NSEventMBS, x as Double, y as Double) as boolean
- event otherMouseDragged(e as NSEventMBS, x as Double, y as Double) as boolean
- event otherMouseUp(e as NSEventMBS, x as Double, y as Double) as boolean
- event performDragOperation(sender as NSDraggingInfoMBS) as boolean
- event prepareForDragOperation(sender as NSDraggingInfoMBS) as boolean
- event pressureChange(e as NSEventMBS) as boolean
- event resignFirstResponder as boolean
- event rightMouseDown(e as NSEventMBS, x as Double, y as Double) as boolean
- event rightMouseDragged(e as NSEventMBS, x as Double, y as Double) as boolean
- event rightMouseUp(e as NSEventMBS, x as Double, y as Double) as boolean
- event rotateWithEvent(e as NSEventMBS) as boolean
- event scrollWheel(e as NSEventMBS) as boolean
- event swipeWithEvent(e as NSEventMBS) as boolean
- event updateDraggingItemsForDrag(sender as NSDraggingInfoMBS)
- event viewDidMoveToWindow
- event wantsPeriodicDraggingUpdates as boolean
- 4 methods
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method Destructor
Super class NSSearchFieldMBS
- 6 properties
- property Scrollable as Boolean
- property maximumRecents as Integer
- property recentsAutosaveName as string
- property searchMenuTemplate as NSMenuMBS
- property sendsSearchStringImmediately as boolean
- property sendsWholeSearchString as boolean
- 5 methods
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method recentSearches as string()
- method setRecentSearches(values() as string)
- 4 constants
Search menu template constants
Constant | Value | Description |
---|---|---|
NSSearchFieldClearRecentsMenuItemTag | 1002 |
Identifies the menu item for clearing the current set of recent string searches in the menu. This item is hidden if there are no recent strings. |
NSSearchFieldNoRecentsMenuItemTag | 1003 |
Identifies the menu item that describes a lack of recent search strings (for example, "No recent searches"). This item is hidden if there have been recent searches. |
NSSearchFieldRecentsMenuItemTag | 1001 |
Identifies where recent search strings should appear in the "recents" menu group. |
NSSearchFieldRecentsTitleMenuItemTag | 1000 | Identifies the menu item that is the title of the menu group for recent search strings. more |
Super class NSTextFieldMBS
- 14 properties
- property AllowsCharacterPickerTouchBarItem as Boolean
- property allowsEditingTextAttributes as boolean
- property AutomaticTextCompletionEnabled as Boolean
- property backgroundColor as NSColorMBS
- property Bezeled as boolean
- property bezelStyle as Integer
- property Bordered as boolean
- property drawsBackground as boolean
- property Editable as boolean
- property importsGraphics as boolean
- property placeholderAttributedString as NSAttributedStringMBS
- property placeholderString as String
- property Selectable as boolean
- property textColor as NSColorMBS
- 4 methods
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method selectText
- 2 constants
Constants
Constant | Value | Description |
---|---|---|
NSTextFieldRoundedBezel | 1 |
One of the constants for the bezelStyle property.
Corners are rounded. |
NSTextFieldSquareBezel | 0 |
One of the constants for the bezelStyle property.
Corners are square. |
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
- 14 methods
- method abortEditing as Boolean New in 24.5
- 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 sendAction New in 24.5
- 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
- 62 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 adjustScroll(rect as NSRectMBS) as NSRectMBS New in 24.5
- method ancestorSharedWithView(view as NSViewMBS) as NSViewMBS
- method animator as NSViewMBS
- method autoscroll(e as NSEventMBS) as Boolean New in 24.5
- 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
- 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 scrollPoint(x as double, y as double) New in 24.5
- method scrollRectToVisible(rect as NSRectMBS) as Boolean New in 24.5
- 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
- 124 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 showWritingTools New in 24.5
- 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
This class has no sub classes.
Some examples using this class:
Blog Entries
- MBS Xojo / Real Studio Plugins, version 17.0pr1
- MBS Real Studio Plugins, version 13.1pr11
- MBS Real Studio Plugins, version 12.5pr1
- MBS Real Studio Plugins, version 12.4pr9
Release notes
- Version 17.0
- Fixed becomeFirstResponder for Cocoa controls event, e.g. in CustomNSSearchFieldMBS.
The items on this page are in the following plugins: MBS MacBase Plugin, MBS MacCocoa Plugin.
CustomNSScrollerMBS - CustomNSSharingServiceMBS