Skip to main content

LensStudio:Ui.SearchableMenu

Class

Menu with search/filter functionality.

Index

Example

export class SearchableMenuPanel extends PanelPlugin {
connections: any[];
static descriptor() {
const d = new Descriptor();
d.id = 'com.docs.UiSearchableMenuExample';
d.name = 'SearchableMenu Example';
d.defaultDockState = DockState.Detached;
d.defaultSize = new Size(350, 200);
return d;
}
constructor(pluginSystem: Editor.PluginSystem, descriptor?: Descriptor) {
super(pluginSystem, descriptor);
this.connections = [];
}
createWidget(parent: Widget): Widget {
const root = new Widget(parent);
const layout = new BoxLayout();
layout.setDirection(Direction.TopToBottom);
layout.spacing = 8;
root.layout = layout;

const title = new Label(root);
title.text = 'SearchableMenu Demo';
title.fontRole = FontRole.TitleBold;
layout.addWidget(title);

const status = new Label(root);
status.text = 'Click button to open a searchable menu.';
status.wordWrap = true;
layout.addWidget(status);

const btn = new PushButton(root);
btn.text = 'Open Searchable Menu';
layout.addWidget(btn);

// SearchableMenu has a built-in search field that filters items
const menu = new SearchableMenu(root);
const items = ['Camera', 'Light', 'Mesh', 'Script', 'Image', 'Audio'];
for (const name of items) {
const action = new Action(root);
action.text = name;
menu.addAction(action);
this.connections.push(
action.onTrigger.connect(() => {
status.text = 'Selected: ' + name;
})
);
}

this.connections.push(
btn.onClick.connect(() => {
menu.popup(btn);
})
);

return root;
}
deinit(): void {
this.connections.forEach((c: any) => c?.disconnect());
this.connections = [];
}
}

Extends

Constructors

Constructor

new SearchableMenu(parent): SearchableMenu

Constructs a new SearchableMenu widget with a built-in search field for filtering menu items.

Parameters

ParameterType
parentWidget

Returns

SearchableMenu

Overrides

AbstractMenu.constructor

Properties

autoFillBackground

autoFillBackground: boolean

Whether the widget automatically fills its background before painting.

Inherited from

AbstractMenu.autoFillBackground


backgroundRole

backgroundRole: ColorRole

The color role used for the widget's background.

Inherited from

AbstractMenu.backgroundRole


className

readonly className: string

Class name of the underlying widget type.

Inherited from

AbstractMenu.className


contextMenuPolicy

contextMenuPolicy: ContextMenuPolicy

Controls how the widget handles context menu requests.

Inherited from

AbstractMenu.contextMenuPolicy


devicePixelRatio

readonly devicePixelRatio: number

The ratio between physical and logical pixels for the widget's display.

Inherited from

AbstractMenu.devicePixelRatio


enabled

enabled: boolean

Whether the widget is interactive and accepts user input.

Inherited from

AbstractMenu.enabled


fontRole

fontRole: FontRole

The font role applied to the widget's text rendering.

Inherited from

AbstractMenu.fontRole


foregroundRole

foregroundRole: ColorRole

The color role used for the widget's foreground elements.

Inherited from

AbstractMenu.foregroundRole


hasFocus

readonly hasFocus: boolean

True when the widget currently holds keyboard focus.

Inherited from

AbstractMenu.hasFocus


height

readonly height: number

Current height of the widget in pixels.

Inherited from

AbstractMenu.height


hidden

hidden: boolean

Whether the widget is hidden from view.

Inherited from

AbstractMenu.hidden


isNull

readonly isNull: boolean

True if the underlying native widget object has been destroyed.

Inherited from

AbstractMenu.isNull


isTransparentForMouseEvents

isTransparentForMouseEvents: boolean

When true, mouse events pass through the widget to widgets below.

Inherited from

AbstractMenu.isTransparentForMouseEvents


layout

layout: Layout

The layout manager assigned to arrange child widgets.

Inherited from

AbstractMenu.layout


objectName

objectName: string

Identifier by which the widget can be located via findChild.

Inherited from

AbstractMenu.objectName


onClose

readonly onClose: signal1<CloseEvent, void>

Signal emitted when the widget is closed.

Inherited from

AbstractMenu.onClose


onFocusIn

readonly onFocusIn: signal0<void>

Emitted when the widget gains keyboard focus.

Inherited from

AbstractMenu.onFocusIn


onFocusOut

readonly onFocusOut: signal0<void>

Emitted when the widget loses keyboard focus.

Inherited from

AbstractMenu.onFocusOut


onHide

readonly onHide: signal0<void>

Signal emitted when the widget becomes hidden.

Inherited from

AbstractMenu.onHide


onKeyPress

readonly onKeyPress: signal1<number, void>

Signal emitted when a key is pressed while the widget has focus.

Inherited from

AbstractMenu.onKeyPress


onMouseDoubleClick

readonly onMouseDoubleClick: signal1<MouseEvent, void>

Signal emitted when the user double-clicks on the widget.

Inherited from

AbstractMenu.onMouseDoubleClick


onMouseMove

readonly onMouseMove: signal1<MouseEvent, void>

Signal emitted when the mouse moves over the widget.

Inherited from

AbstractMenu.onMouseMove


onMousePress

readonly onMousePress: signal1<MouseEvent, void>

Signal emitted when a mouse button is pressed on the widget.

Inherited from

AbstractMenu.onMousePress


onMouseRelease

readonly onMouseRelease: signal1<MouseEvent, void>

Signal emitted when a mouse button is released on the widget.

Inherited from

AbstractMenu.onMouseRelease


onResize

readonly onResize: signal2<number, number, void>

Signal emitted when the widget is resized.

Inherited from

AbstractMenu.onResize


onShow

readonly onShow: signal0<void>

Signal emitted when the widget becomes visible.

Inherited from

AbstractMenu.onShow


toolTip

toolTip: string

Text displayed in a tooltip when the user hovers over the widget.

Inherited from

AbstractMenu.toolTip


visible

visible: boolean

Whether the widget is currently visible.

Inherited from

AbstractMenu.visible


width

readonly width: number

Current width of the widget in pixels.

Inherited from

AbstractMenu.width


windowTitle

windowTitle: string

Title text displayed in the widget's title bar when shown as a window.

Inherited from

AbstractMenu.windowTitle

Methods

actions()

actions(): Action[]

Returns

Action[]

Inherited from

AbstractMenu.actions


activateWindow()

activateWindow(): void

Brings the widget's top-level window to the foreground and gives it focus.

Returns

void

Inherited from

AbstractMenu.activateWindow


addAction()

addAction(action): void

Add an action to the menu.

Parameters

ParameterType
actionAction

Returns

void

Inherited from

AbstractMenu.addAction


addMenu()

addMenu(caption): AbstractMenu

Add a submenu with the given caption.

Parameters

ParameterType
captionstring

Returns

AbstractMenu

Inherited from

AbstractMenu.addMenu


addSeparator()

addSeparator(): void

Add a separator to the menu.

Returns

void

Inherited from

AbstractMenu.addSeparator


adjustSize()

adjustSize(): void

Resizes the widget to fit its contents based on the size hint.

Returns

void

Inherited from

AbstractMenu.adjustSize


blockSignals()

blockSignals(blocked): void

Blocks or unblocks signal emission from the widget.

Parameters

ParameterType
blockedboolean

Returns

void

Inherited from

AbstractMenu.blockSignals


close()

close(): void

Closes the widget, hiding it and emitting the onClose signal.

Returns

void

Inherited from

AbstractMenu.close


deleteLater()

deleteLater(): void

Schedules the widget for deletion after the current event loop iteration.

Returns

void

Inherited from

AbstractMenu.deleteLater


findChild()

findChild(objectName): Widget

Returns the descendant widget with the given object name, or null if none matches.

Parameters

ParameterType
objectNamestring

Returns

Widget

Inherited from

AbstractMenu.findChild


getProperty()

getProperty(name): any

Returns the value of the dynamic property with the given name.

Parameters

ParameterType
namestring

Returns

any

Inherited from

AbstractMenu.getProperty


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

AbstractMenu.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

AbstractMenu.getTypeName


grab()

grab(): Pixmap

Captures the widget's current rendered content as a Pixmap.

Returns

Pixmap

Inherited from

AbstractMenu.grab


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

AbstractMenu.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

AbstractMenu.isSame


mapToGlobal()

mapToGlobal(x, y): Point

Parameters

ParameterType
xnumber
ynumber

Returns

Point

Inherited from

AbstractMenu.mapToGlobal


move()

move(ax, ay): void

Moves the widget to the specified position.

Parameters

ParameterType
axnumber
aynumber

Returns

void

Inherited from

AbstractMenu.move


popup(target): void

Display the menu at the target widget's location.

Parameters

ParameterType
targetWidget

Returns

void

Inherited from

AbstractMenu.popup


raise()

raise(): void

Raises the widget to the top of the parent widget's stack.

Returns

void

Inherited from

AbstractMenu.raise


resize()

resize(width, height): void

Resizes the widget to the specified width and height.

Parameters

ParameterType
widthnumber
heightnumber

Returns

void

Inherited from

AbstractMenu.resize


setContentsMargins()

setContentsMargins(left, top, right, bottom): void

Sets the margins around the widget's contents.

Parameters

ParameterType
leftnumber
topnumber
rightnumber
bottomnumber

Returns

void

Inherited from

AbstractMenu.setContentsMargins


setCursor()

setCursor(shape): void

Sets the cursor shape displayed when the mouse is over the widget.

Parameters

ParameterType
shapeCursorShape

Returns

void

Inherited from

AbstractMenu.setCursor


setCursorPixmap()

setCursorPixmap(pixmap): void

Sets a custom pixmap as the cursor when the mouse is over the widget.

Parameters

ParameterType
pixmapPixmap

Returns

void

Inherited from

AbstractMenu.setCursorPixmap


setFixedHeight()

setFixedHeight(height): void

Locks the widget's height to the given value, preventing resizing.

Parameters

ParameterType
heightnumber

Returns

void

Inherited from

AbstractMenu.setFixedHeight


setFixedWidth()

setFixedWidth(width): void

Locks the widget's width to the given value, preventing resizing.

Parameters

ParameterType
widthnumber

Returns

void

Inherited from

AbstractMenu.setFixedWidth


setFocus()

setFocus(): void

Gives keyboard input focus to the widget.

Returns

void

Inherited from

AbstractMenu.setFocus


setMaximumHeight()

setMaximumHeight(height): void

Sets the maximum height the widget can be resized to.

Parameters

ParameterType
heightnumber

Returns

void

Inherited from

AbstractMenu.setMaximumHeight


setMaximumWidth()

setMaximumWidth(width): void

Sets the maximum width the widget can be resized to.

Parameters

ParameterType
widthnumber

Returns

void

Inherited from

AbstractMenu.setMaximumWidth


setMinimumHeight()

setMinimumHeight(height): void

Sets the minimum height the widget must maintain.

Parameters

ParameterType
heightnumber

Returns

void

Inherited from

AbstractMenu.setMinimumHeight


setMinimumWidth()

setMinimumWidth(width): void

Sets the minimum width the widget must maintain.

Parameters

ParameterType
widthnumber

Returns

void

Inherited from

AbstractMenu.setMinimumWidth


setProperty()

setProperty(name, value): boolean

Sets the dynamic property with the given name to the given value.

Parameters

ParameterType
namestring
valueany

Returns

boolean

Inherited from

AbstractMenu.setProperty


setSizePolicy()

setSizePolicy(horizontal, vertical): void

Controls how the widget grows or shrinks relative to its layout.

Parameters

ParameterType
horizontalPolicy
verticalPolicy

Returns

void

Inherited from

AbstractMenu.setSizePolicy


setUndoable()

setUndoable(undoable): void

Marks property changes on this widget as undoable via the undo stack.

Parameters

ParameterType
undoableboolean

Returns

void

Inherited from

AbstractMenu.setUndoable


setUndoableRecursive()

setUndoableRecursive(undoable): void

Marks property changes on this widget and all its children as undoable.

Parameters

ParameterType
undoableboolean

Returns

void

Inherited from

AbstractMenu.setUndoableRecursive


show()

show(): void

Makes the widget visible.

Returns

void

Inherited from

AbstractMenu.show


unsetCursor()

unsetCursor(): void

Resets the cursor to the parent widget's cursor.

Returns

void

Inherited from

AbstractMenu.unsetCursor