SearchControl

LibraryDescription
"A search control which offers some advantages over the built in one."

Note on heights: macOS before Tahoe wants 22 points in height, macOS Tahoe wants 26 points in height, Windows ants 22 points and we suggest 27 points on Linux. Your application will need to implement logic to account for this if you want to perfect the look when cross compiling.

By default it will set the height to 26 if your IDE is on Tahoe, and 27 points if your IDE is on Linux, else 22 points.

RectControl
SearchControl

control SearchControl

Properties

AccessibilityLabel	Label used by the macOS accessibility manager for various of disability settings and devices.
AccessibilityTitle	Title used by the macOS accessibility manager for various of disability settings and devices.
AllowFocusRing	If True, the SearchField will display a focus ring when it has the focus.
DebugDataSize	Used for internal quality control of the plugin.
Enabled (Inherited)	Determines if the control should be enabled when the owning window is opened.
Handle (Inherited)	Returns a handle to the control.
HasCancelButton	If set to true then the control will have a cancel button on its right side.
HasMenu	If set to true then the left button will host a menu.
Height (Inherited)	The height (in points) of the control.
Index (Inherited)	If the control is used in a control set, this specifies the control's index in the set.
Left (Inherited)	The left side of the control in local coordinates (relative to the window)
MacBorderStyle	Sets the BorderStyle on mac to Rounded (default) or Square
MenuItemCount	Returns the count of menu items.
MouseX (Inherited)	The X coordinate of the mouse (points). Measured from the top-left corner of the window.
MouseY (Inherited)	The Y coordinate of the mouse (points). Measured from the top-left corner of the window.
PanelIndex (Inherited)	If the control has been placed on a TabPanel or PagePanel control, this is the panel (page/tab) that the control is on. If the control is not on a panel, it returns -1.
PlaceHolderText	A property to set or get placeholder which is used to display placeholder text as grey text in the control when it has no search text entered and the control does not have focus.
SendSearchStringImmediately	If set to true then search event will be fired right away as text is typed.
SendWholeSearchString	If set to true then search events are only sent when the user presses enter key or presses the search icon.
Text	Sets or gets the search text in the control.
Top (Inherited)	The top of the control in local coordinates (relative to the window).
Visible (Inherited)	Determines whether the control is visible when its owning window is opened. The default is True: the control is visible.
Width (Inherited)	The width (in points) of the control.
Window (Inherited)	The control's parent window.

Methods

AddMenuItem	Adds a MenuItem to the menu in the left icon button.
CancelEventAction	To cancel a events internal action then call this method from within a event.
ClearMenu	Clears the menu.
Close (Inherited)	Closes a control.
MenuItem	Returns a MenuItem by a given index
SetFocus	Sets focus to the control.
SyncMenu	Syncs the menu items if you have made changes to menu items after adding them. This is needed for the MacOS X native control.

Events

CancelButtonAction	This event is fired when the cancel button is clicked.
Close (Inherited)	The control is about to close.
ConstructContextualMenu (Inherited)	This event is called when it is appropriate to display a contextual menu for the control.
ContextualMenuItemSelected (Inherited)	Fires when a contextual menuitem selectedItem was selected but the MenuItemSelected event and the MenuHandler for the MenuItem did not handle the menu selection.
DragEnter (Inherited)	Fires when the passed DragItem enters the RectControl.
DragExit (Inherited)	Fires when the passed DragItem exits the RectControl.
DragOver (Inherited)	Fires when the DragItem is over the RectControl.
DropObject (Inherited)	The item represented by Obj has been dropped on the control.
GotFocus	This event is fired when the control gets the focus.
HandleSpecialKey	This event is fired when special key such as Tab or Return is pressed giving you opportunity to do something there instead of default built in functionality.
KeyDown (Inherited)	The user has pressed the Key passed while the control has the focus.
KeyUp (Inherited)	Fires when the passed Key is released in the control that has the focus.
LostFocus	This event is fired when the control looses the focus.
MenuClick	This event is fire when a MenuItem was clicked in the left button Menu.
MouseDrag (Inherited)	The mouse button was pressed inside the control and moved (dragged) at the location local to the control passed in to x, y. The user has moved the mouse inside the control while the mouse button is held down. This event handler receives parameters that indicate where the mouse is in coordinates local to the control.
MouseEnter (Inherited)	The mouse has entered the area of the control.
MouseExit	The mouse has left the area of the control.
MouseMove	The mouse has moved within the control to the coordinates passed. The coordinates are local to the control, not to the window.
MouseWheel (Inherited)	The mouse wheel has been moved.
RequestBuddyControl	Used on Windows to manually assign TextField to the control if you’re having embedding issues.
Search	This event is fired when your application should do search.
TextChange	This event is fired when the text changes.