Platforms to show: All Mac Windows Linux Cross-Platform
NSSearchFieldCellMBS class
Super class: NSTextFieldCellMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Cocoa Controls | MBS MacCocoa Plugin | 22.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Notes:
The NSSearchFieldCell class defines the programmatic interface for text fields that are optimized for text-based searches. An NSSearchFieldCell object is “wrapped” by an NSSearchFieldMBS control object, which directly inherits from the NSTextFieldMBS class. The search field implemented by these classes presents a standard user interface for searches, including a search button, a cancel button, and a pop-up icon menu for listing recent search strings and custom search categories.
When the user types and then pauses, the cell’s action message is sent to its target. You can query the cell’s string value for the current text to search for. Do not rely on the sender of the action to be an NSMenuMBS object because the menu may change. If you need to change the menu, modify the search menu template and update the value in the searchMenuTemplate property.
Subclass of the NSTextFieldCellMBS class.
- 7 properties
- property cancelButtonCell as NSButtonCellMBS
- property maximumRecents as Integer
- property recentsAutosaveName as String
- property searchButtonCell as NSButtonCellMBS
- property searchMenuTemplate as NSMenuMBS
- property sendsSearchStringImmediately as Boolean
- property sendsWholeSearchString as Boolean
- 6 methods
- method Constructor(image as NSImageMBS) Private
- method Constructor(text as string)
- method recentSearches as String()
- method resetCancelButtonCell
- method resetSearchButtonCell
- method setRecentSearches(RecentSearches() as String = nil)
- 4 constants
Menu Tags
Constant | Value | Description |
---|---|---|
ClearRecentsMenuItemTag | 1002 |
The menu item for clearing the current set of recent string searches in the menu. |
NoRecentsMenuItemTag | 1003 |
The menu item that describes a lack of recent search strings. |
RecentsMenuItemTag | 1001 |
The location of recent search strings in the “recents” menu group. |
RecentsTitleMenuItemTag | 1000 |
The menu item that provides the title of the menu group for recent search strings. |
Super class NSTextFieldCellMBS
- 6 properties
- property backgroundColor as NSColorMBS
- property bezelStyle as Integer
- property drawsBackground as boolean
- property placeholderAttributedString as NSAttributedStringMBS
- property placeholderString as string
- property textColor as NSColorMBS
- 5 methods
- method allowedInputSourceLocales as string()
- method Constructor(text as string)
- method setAllowedInputSourceLocales(Identifiers() as string)
- method setUpFieldEditorAttributes(textobj as NSTextMBS) as NSTextMBS
- method setWantsNotificationForMarkedText(value as boolean)
- 2 constants
- const NSTextFieldRoundedBezel=1
- const NSTextFieldSquareBezel=0
Super class NSActionCellMBS
- 2 methods
- method Constructor(image as NSImageMBS)
- method Constructor(text as string)
Super class NSCellMBS
- 48 properties
- property alignment as Integer
- property allowsEditingTextAttributes as boolean
- property allowsMixedState as boolean
- property allowsUndo as boolean
- property attributedStringValue as NSAttributedStringMBS
- property backgroundStyle as Integer
- property baseWritingDirection as Integer
- property Bezeled as boolean
- property Bordered as boolean
- property className as string
- property classPath as string
- property Continuous as boolean
- property controlSize as Integer
- property controlTint as Integer
- property controlView as NSViewMBS
- property doubleValue as Double
- property Editable as boolean
- property Enabled as boolean
- property floatValue as Double
- property font as NSFontMBS
- property Handle as Integer
- property hasValidObjectValue as boolean
- property Highlighted as boolean
- property image as NSImageMBS
- property importsGraphics as boolean
- property interiorBackgroundStyle as Integer
- property intValue as Integer
- property isOpaque as boolean
- property keyEquivalent as string
- property lineBreakMode as Integer
- property menu as NSMenuMBS
- property mnemonicLocation as Integer
- property refusesFirstResponder as boolean
- property Scrollable as boolean
- property Selectable as boolean
- property sendsActionOnEndEditing as boolean
- property showsFirstResponder as boolean
- property state as Integer
- property stringValue as string
- property tag as Integer
- property title as string
- property truncatesLastVisibleLine as boolean
- property type as Integer
- property userInterfaceLayoutDirection as Integer
- property usesSingleLineMode as boolean
- property wraps as boolean
- property cellAttribute(aParameter as Integer) as Integer
- property focusRingType as Integer
- 19 methods
- method acceptsFirstResponder as boolean
- method calcDrawInfo(theRect as NSRectMBS)
- method cellSize as NSSizeMBS
- method cellSizeForBounds(theRect as NSRectMBS) as NSSizeMBS
- method compare(otherCell as NSCellMBS) as Integer
- method Constructor(image as NSImageMBS)
- method Constructor(text as string)
- method drawingRectForBounds(theRect as NSRectMBS) as NSRectMBS
- method highlightColorWithFrame(theRect as NSRectMBS, controlView as NSViewMBS) as NSColorMBS
- method imageRectForBounds(theRect as NSRectMBS) as NSRectMBS
- method isEntryAcceptable(aString as string) as boolean
- method mnemonic as string
- method nextState as Integer
- method performClick
- method sendActionOn(mask as Integer) as Integer
- method setNextState
- method setTitleWithMnemonic(stringWithAmpersand as string)
- method titleRectForBounds(theRect as NSRectMBS) as NSRectMBS
- method wantsNotificationForMarkedText as boolean
- 3 shared methods
- shared method defaultFocusRingType as Integer
- shared method defaultMenu as NSMenuMBS
- shared method prefersTrackingUntilMouseUp as boolean
- 61 constants
This class has no sub classes.
Blog Entries
- News from the MBS Xojo Plugins Version 22.3
- MBS Xojo Plugins in version 22.3
- MBS Xojo Plugins, version 22.3pr2
The items on this page are in the following plugins: MBS MacCocoa Plugin.
NSScrollViewMBS - NSSearchFieldMBS
