Quick Menu (quickmenu)

Quick Menu

A QuickMenu widget provides lists of actions organized in tabs with a quick search functionality.

class orangecanvas.document.quickmenu.QuickMenu(parent: Optional[PyQt5.QtWidgets.QWidget] = None, **kwargs: Any)

Bases: orangecanvas.gui.framelesswindow.FramelessWindow

A quick menu popup for the widgets.

The widgets are set using QuickMenu.setModel() which must be a model as returned by QtWidgetRegistry.model()

triggered(QAction)

hovered(QAction)

setSizeGripEnabled(enabled: bool) → None

Enable the resizing of the menu with a size grip in a bottom right corner (enabled by default).

sizeGripEnabled() → bool

Is the size grip enabled.

addPage(name: str, page: orangecanvas.document.quickmenu.MenuPage) → int

Add the page (MenuPage) with name and return it’s index. The page.icon() will be used as the icon in the tab bar.

createPage(index: PyQt5.QtCore.QModelIndex) → orangecanvas.document.quickmenu.MenuPage

Create a new page based on the contents of an index (QModeIndex) item.

setModel(model: PyQt5.QtCore.QAbstractItemModel) → None

Set the model containing the actions.

setSortingFunc(func: Optional[Callable[[Any, Any], bool]]) → None

Set a sorting function in the suggest (search) menu.

setFilterFunc(func: Optional[FilterFunc]) → None

Set a filter function.

popup(pos: Optional[PyQt5.QtCore.QPoint] = None, searchText: str = '') → None

Popup the menu at pos (in screen coordinates). ‘Search’ text field is initialized with searchText if provided.

exec(pos: Optional[PyQt5.QtCore.QPoint] = None, searchText: str = '') → Optional[PyQt5.QtWidgets.QAction]

Execute the menu at position pos (in global screen coordinates). Return the triggered QAction or None if no action was triggered. ‘Search’ text field is initialized with searchText if provided.

hideEvent(event)

Reimplemented from QWidget

setCurrentPage(page: orangecanvas.document.quickmenu.MenuPage) → None

Set the current shown page to page.

setCurrentIndex(index: int) → None

Set the current page index.

triggerSearch() → None

Trigger action search. This changes to current page to the ‘Suggest’ page and sets the keyboard focus to the search line edit.

class orangecanvas.document.quickmenu.MenuPage(parent: Optional[PyQt5.QtWidgets.QWidget] = None, title: str = '', icon: PyQt5.QtGui.QIcon = <PyQt5.QtGui.QIcon object>, **kwargs: Any)

Bases: orangecanvas.gui.tooltree.ToolTree

A menu page in a QuickMenu widget, showing a list of actions. Shown actions can be disabled by setting a filtering function using the setFilterFunc().

setTitle(title: str) → None

Set the title of the page.

title() → str

Return the title of this page.

setIcon(icon: PyQt5.QtGui.QIcon) → None

Set icon for this menu page.

icon() → PyQt5.QtGui.QIcon

Return the icon of this menu page.

setFilterFunc(func: Optional[Callable[[PyQt5.QtCore.QModelIndex], bool]]) → None

Set the filtering function. func should a function taking a single QModelIndex argument and returning True if the item at index should be disabled and False otherwise. To disable filtering func can be set to None.

setModel(model: PyQt5.QtCore.QAbstractItemModel) → None

Reimplemented from ToolTree.setModel().

setRootIndex(index: PyQt5.QtCore.QModelIndex) → None

Reimplemented from ToolTree.setRootIndex()

rootIndex() → PyQt5.QtCore.QModelIndex

Reimplemented from ToolTree.rootIndex()

sizeHint() → PyQt5.QtCore.QSize

Reimplemented from QWidget.sizeHint().

eventFilter(self, a0: Optional[QObject], a1: Optional[QEvent]) → bool