Platforms to show: All Mac Windows Linux Cross-Platform

Back to NSSearchFieldControlMBS control.

NSSearchFieldControlMBS.Action

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 13.4 ✅ Yes ❌ No ❌ No ❌ No
The action event run, when e.g. return key is pressed.

NSSearchFieldControlMBS.BoundsChanged

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The event called when the bounds, but not the frame, changed.

NSSearchFieldControlMBS.Close

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 13.4 ✅ Yes ❌ No ❌ No ❌ No

The control is about to close.
In Xojo version 2021r3 and newer this event is named Closing.

NSSearchFieldControlMBS.Closing

Type Topic Version
event Cocoa Controls 13.4

The control is about to close.
In older Xojo versions, this event is named Close.

NSSearchFieldControlMBS.ConstructContextualMenu(base as MenuItem, x as Integer, y as Integer) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 22.1 ✅ Yes ❌ No ❌ No ❌ No
This event is called when it is appropriate to display a contextual menu for the control.

NSSearchFieldControlMBS.ContextualMenuAction(hitItem as MenuItem) as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
Called when a menuitem is choosen.

This allows the control to react on its relevant menu items. Please return true if you handled it or false to give others a chance.

NSSearchFieldControlMBS.didCloseContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 24.1 ✅ Yes ❌ No ❌ No ❌ No
Did close contextual menu.

Allows you to restart any animation you may have stopped in the willShowContextualMenu event.

NSSearchFieldControlMBS.EnableMenuItems

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No

The event where you can enable menu items.
In Xojo version 2021r3 and newer this event is named MenuBarSelected.

NSSearchFieldControlMBS.FocusLost

Type Topic Version
event Cocoa Controls 16.5

The control lost focus.
In older Xojo versions, this event is named LostFocus.

This only fires if the control itself lost focus and not a sub control.

NSSearchFieldControlMBS.FocusReceived

Type Topic Version
event Cocoa Controls 16.5

The control itself got focus.
In older Xojo versions, this event is named GotFocus.

This only fires if the control itself got focus and not a sub control.

NSSearchFieldControlMBS.FrameChanged

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The event called when the frame changed.

This event notifies you, that the control changed it's bounding frame, which is position and/or size.

NSSearchFieldControlMBS.GotFocus

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 16.5 ✅ Yes ❌ No ❌ No ❌ No

The control itself got focus.
In Xojo version 2021r3 and newer this event is named FocusReceived.

This only fires if the control itself got focus and not a sub control.

NSSearchFieldControlMBS.LostFocus

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 16.5 ✅ Yes ❌ No ❌ No ❌ No

The control lost focus.
In Xojo version 2021r3 and newer this event is named FocusLost.

This only fires if the control itself lost focus and not a sub control.

NSSearchFieldControlMBS.MenuBarSelected

Type Topic Version
event Cocoa Controls 17.1

The event where you can enable menu items.
In older Xojo versions, this event is named EnableMenuItems.

NSSearchFieldControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The mouse button was pressed inside the control’s region at the location passed in to x, y.

The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the Control.
Return True if you are going to handle the MouseDown. In such a case:

  • The Action event, if any, will not execute and the state of the object will not change.
  • You will receive the MouseDrag and MouseUp events.
If you return False, the system handles the MouseDown so the above event handlers do not get called.

NSSearchFieldControlMBS.MouseDrag(x as Integer, y as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
This event fires continuously after the mouse button was pressed inside the Control.

Mouse location is local to the control passed in to x, y.
As this event is fired continuously (hundreds of time per second), it is your responsibility to determine if the mouse has really moved.

NSSearchFieldControlMBS.MouseUp(x as Integer, y as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The mouse button was released.

Use the x and y parameters to determine if the mouse button was released within the control's boundaries.

NSSearchFieldControlMBS.Open

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 13.4 ✅ Yes ❌ No ❌ No ❌ No

The control is about to was created and you can initialize it.
In Xojo version 2021r3 and newer this event is named Opening.

NSSearchFieldControlMBS.Opening

Type Topic Version
event Cocoa Controls 13.4

The control is about to was created and you can initialize it.
In older Xojo versions, this event is named Open.

NSSearchFieldControlMBS.ScaleFactorChanged(NewFactor as Double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 17.1 ✅ Yes ❌ No ❌ No ❌ No
The backing store scale factor has changed.

Please invalidate any cached bitmaps or other relevant state.

NSSearchFieldControlMBS.TextDidBeginEditing(fieldEditor as NSTextMBS, notification as NSNotificationMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 14.0 ✅ Yes ❌ No ❌ No ❌ No
Sent when a control with editable text begins an editing session.

Notification: The notification object. The name of the notification is always NSControlTextDidBeginEditingNotification.

This event is invoked when the user begins editing text in a control such as a text field or a form field. The control posts a NSControlTextDidBeginEditingNotification notification, and if the control's subclass implements this event, it is automatically registered to receive the notification. The field editor is also delivered for inspection.

NSSearchFieldControlMBS.TextDidChange(fieldEditor as NSTextMBS, notification as NSNotificationMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 14.0 ✅ Yes ❌ No ❌ No ❌ No
Sent when the text in the receiving control changes.

Notification: The notification object. The name of the notification is always NSControlTextDidChangeNotification.

This event is invoked when text in a control such as a text field or form changes. The control posts a NSControlTextDidChangeNotification notification, and if the control's subclass implements this event, it is automatically registered to receive the notification. The field editor is provided as parameter for inspection.

NSSearchFieldControlMBS.TextDidEndEditing(fieldEditor as NSTextMBS, notification as NSNotificationMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 14.0 ✅ Yes ❌ No ❌ No ❌ No
Sent when a control with editable text ends an editing session.

Notification: The notification object. The name of the notification is always NSControlTextDidEndEditingNotification.

This event is invoked when the user stops editing text in a control such as a text field or form. The control posts a NSControlTextDidEndEditingNotification notification, and if the control' subclass implements this event, it is automatically registered to receive the notification. The field editor is also provided for inspection.

NSSearchFieldControlMBS.textShouldBeginEditing(fieldEditor as NSTextMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 14.0 ✅ Yes ❌ No ❌ No ❌ No
The event called to decide whether text editing should be allowed.

Return true to allow text editing or false to deny.
Be aware that an event in Xojo without return will cause false to be returned.

NSSearchFieldControlMBS.textShouldEndEditing(fieldEditor as NSTextMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 14.0 ✅ Yes ❌ No ❌ No ❌ No
The event called to decide whether ending text editing should be allowed.

Return true to allow end of text editing or false to deny.
Be aware that an event in Xojo without return will cause false to be returned.

NSSearchFieldControlMBS.willShowContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)

Type Topic Plugin Version macOS Windows Linux iOS Targets
event Cocoa Controls MBS MacCocoa Plugin 24.1 ✅ Yes ❌ No ❌ No ❌ No
Will show contextual menu.

Your chance to modify the menu before it is shown, e.g. to add menu entries.

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


The biggest plugin in space...