QMenu
The QMenu class provides a menu widget for use in menu bars, context menus, and other popup menus.
This class is a JS wrapper around Qt's QMenu class
Example
const { QMenu } = require("@nodegui/nodegui");
const menu = new QMenu();
Hierarchy
↳ QMenu
Index
Constructors
Properties
Methods
- _id
- acceptDrops
- accessibleDescription
- accessibleName
- actionAt
- actionGeometry
- activateWindow
- activeAction
- addAction
- addEventListener
- addMenu
- addSection
- addSeparator
- adjustSize
- autoFillBackground
- baseSize
- childAt
- children
- childrenRect
- clear
- clearFocus
- clearMask
- close
- colorCount
- contentsRect
- contextMenuPolicy
- defaultAction
- delete
- deleteLater
- depth
- devicePixelRatio
- devicePixelRatioF
- dumpObjectInfo
- dumpObjectTree
- ensurePolished
- eventProcessed
- exec
- focusProxy
- focusWidget
- font
- frameGeometry
- frameSize
- geometry
- getFlexNode
- grab
- grabKeyboard
- grabMouse
- hasFocus
- hasHeightForWidth
- hasMouseTracking
- hasTabletTracking
- height
- heightForWidth
- heightMM
- hide
- hideTearOffMenu
- icon
- inherits
- inputMethodHints
- insertMenu
- insertSection
- insertSeparator
- isActiveWindow
- isAncestorOf
- isEmpty
- isEnabled
- isEnabledTo
- isFullScreen
- isHidden
- isMaximized
- isMinimized
- isModal
- isTearOffEnabled
- isTearOffMenuVisible
- isVisible
- isVisibleTo
- isWindow
- isWindowModified
- killTimer
- layout
- logicalDpiX
- logicalDpiY
- lower
- mapFrom
- mapFromGlobal
- mapFromParent
- mapTo
- mapToGlobal
- mapToParent
- maximumHeight
- maximumSize
- maximumWidth
- menuAction
- minimumHeight
- minimumSize
- minimumSizeHint
- minimumWidth
- move
- nativeParentWidget
- nextInFocusChain
- normalGeometry
- objectName
- paintingActive
- parent
- parentWidget
- physicalDpiX
- physicalDpiY
- popup
- pos
- previousInFocusChain
- property
- raise
- rect
- releaseKeyboard
- releaseMouse
- releaseShortcut
- removeAction
- removeEventListener
- repaint
- repolish
- resize
- separatorsCollapsible
- setAcceptDrops
- setAccessibleDescription
- setAccessibleName
- setActiveAction
- setAsDockMenu
- setAttribute
- setAutoFillBackground
- setBaseSize
- setContentsMargins
- setContextMenuPolicy
- setCursor
- setDefaultAction
- setDisabled
- setEnabled
- setEventProcessed
- setFixedHeight
- setFixedSize
- setFixedWidth
- setFlexNodeSizeControlled
- setFocus
- setFocusPolicy
- setFocusProxy
- setFont
- setGeometry
- setGraphicsEffect
- setHidden
- setIcon
- setInlineStyle
- setInputMethodHints
- setLayout
- setMaximumHeight
- setMaximumSize
- setMaximumWidth
- setMinimumHeight
- setMinimumSize
- setMinimumWidth
- setMouseTracking
- setObjectName
- setParent
- setProperty
- setSeparatorsCollapsible
- setShortcutAutoRepeat
- setShortcutEnabled
- setSizeIncrement
- setSizePolicy
- setStatusTip
- setStyleSheet
- setTabletTracking
- setTearOffEnabled
- setTitle
- setToolTip
- setToolTipDuration
- setToolTipsVisible
- setUpdatesEnabled
- setVisible
- setWhatsThis
- setWindowFilePath
- setWindowFlag
- setWindowIcon
- setWindowModified
- setWindowOpacity
- setWindowRole
- setWindowState
- setWindowTitle
- show
- showFullScreen
- showMaximized
- showMinimized
- showNormal
- showTearOffMenu
- size
- sizeHint
- sizeIncrement
- stackUnder
- startTimer
- statusTip
- style
- styleSheet
- testAttribute
- title
- toolTip
- toolTipDuration
- toolTipsVisible
- underMouse
- unsetCursor
- unsetLayoutDirection
- unsetLocale
- update
- updateGeometry
- updateMicroFocus
- updatesEnabled
- whatsThis
- width
- widthMM
- winId
- window
- windowFilePath
- windowHandle
- windowIcon
- windowOpacity
- windowRole
- windowState
- windowTitle
- x
- y
Constructors
constructor
+ new QMenu(arg?
: QWidget‹QWidgetSignals› | NativeElement): QMenu
Overrides QAbstractSlider.constructor
Parameters:
Name | Type |
---|---|
arg? | QWidget‹QWidgetSignals› | NativeElement |
Returns: QMenu
Properties
_rawInlineStyle
• _rawInlineStyle: string
Inherited from QMenu._rawInlineStyle
native
• native: NativeElement | null
Inherited from Component.native
type
• type: string
Methods
_id
▸ _id(): number
Get an ID identifying the underlying C++ object.
This can be useful when debugging memory problems with help from
setLogCreateQObject()
and setLogDestroyQObject()
. The number is
hash of the memory address of the C++ object.
Returns: number
a unique number which is valid for the lifetime of the C++ object.
acceptDrops
▸ acceptDrops(): boolean
Inherited from QMenu.acceptDrops
Returns: boolean
accessibleDescription
▸ accessibleDescription(): string
Inherited from QMenu.accessibleDescription
Returns: string
accessibleName
▸ accessibleName(): string
Inherited from QMenu.accessibleName
Returns: string
actionAt
▸ actionAt(pt
: QPoint): QAction
Parameters:
Name | Type |
---|---|
pt | QPoint |
Returns: QAction
actionGeometry
▸ actionGeometry(act
: QAction): QRect
Parameters:
Name | Type |
---|---|
act | QAction |
Returns: QRect
activateWindow
▸ activateWindow(): void
Inherited from QMenu.activateWindow
Returns: void
activeAction
▸ activeAction(): QAction
Returns: QAction
addAction
▸ addAction(action
: QAction | string): QAction
Inherited from QMenu.addAction
Parameters:
Name | Type |
---|---|
action | QAction | string |
Returns: QAction
addEventListener
▸ addEventListener‹SignalType›(signalType
: SignalType, callback
: QMenuSignals[SignalType], options?
: EventListenerOptions): void
Inherited from EventWidget.addEventListener
Type parameters:
▪ SignalType: keyof QMenuSignals
Parameters:
Name | Type | Description |
---|---|---|
signalType | SignalType | SignalType is a signal from the widgets signals interface. |
callback | QMenuSignals[SignalType] | Corresponding callback for the signal as mentioned in the widget's signal interface |
options? | EventListenerOptions | Extra optional options controlling how this event listener is added. |
Returns: void
void
For example in the case of QPushButton:
const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface
▸ addEventListener(eventType
: WidgetEventTypes, callback
: function, options?
: EventListenerOptions): void
Inherited from EventWidget.addEventListener
Parameters:
▪ eventType: WidgetEventTypes
▪ callback: function
▸ (event?
: NativeRawPointer‹"QEvent"›): void
Parameters:
Name | Type |
---|---|
event? | NativeRawPointer‹"QEvent"› |
▪Optional
options: EventListenerOptions
Extra optional options controlling how this event listener is added.
For example in the case of QPushButton:
const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));
Returns: void
addMenu
▸ addMenu(title
: string): QMenu
Parameters:
Name | Type |
---|---|
title | string |
Returns: QMenu
▸ addMenu(icon
: QIcon, title
: string): QMenu
Parameters:
Name | Type |
---|---|
icon | QIcon |
title | string |
Returns: QMenu
addSection
▸ addSection(text
: string): QAction
Parameters:
Name | Type |
---|---|
text | string |
Returns: QAction
▸ addSection(icon
: QIcon, text
: string): QAction
Parameters:
Name | Type |
---|---|
icon | QIcon |
text | string |
Returns: QAction
addSeparator
▸ addSeparator(): QAction
Returns: QAction
adjustSize
▸ adjustSize(): void
Inherited from QMenu.adjustSize
Returns: void
autoFillBackground
▸ autoFillBackground(): boolean
Inherited from QMenu.autoFillBackground
Returns: boolean
baseSize
▸ baseSize(): QSize
Returns: QSize
childAt
▸ childAt(x
: number, y
: number): QWidget
Parameters:
Name | Type |
---|---|
x | number |
y | number |
Returns: QWidget
children
▸ children(): QObject[]
Inherited from QObject.children
Returns: QObject[]
childrenRect
▸ childrenRect(): QRect
Inherited from QMenu.childrenRect
Returns: QRect
clear
▸ clear(): void
Returns: void
clearFocus
▸ clearFocus(): void
Inherited from QMenu.clearFocus
Returns: void
clearMask
▸ clearMask(): void
Inherited from QMenu.clearMask
Returns: void
close
▸ close(): boolean
Returns: boolean
colorCount
▸ colorCount(): number
Inherited from QMenu.colorCount
Returns: number
contentsRect
▸ contentsRect(): QRect
Inherited from QMenu.contentsRect
Returns: QRect
contextMenuPolicy
▸ contextMenuPolicy(): ContextMenuPolicy
Inherited from QMenu.contextMenuPolicy
Returns: ContextMenuPolicy
defaultAction
▸ defaultAction(): QAction
Returns: QAction
delete
▸ delete(): void
Returns: void
deleteLater
▸ deleteLater(): void
Inherited from QObject.deleteLater
Returns: void
depth
▸ depth(): number
Returns: number
devicePixelRatio
▸ devicePixelRatio(): number
Inherited from QMenu.devicePixelRatio
Returns: number
devicePixelRatioF
▸ devicePixelRatioF(): number
Inherited from QMenu.devicePixelRatioF
Returns: number
dumpObjectInfo
▸ dumpObjectInfo(): void
Inherited from QObject.dumpObjectInfo
Returns: void
dumpObjectTree
▸ dumpObjectTree(): void
Inherited from QObject.dumpObjectTree
Returns: void
ensurePolished
▸ ensurePolished(): void
Inherited from QMenu.ensurePolished
Returns: void
eventProcessed
▸ eventProcessed(): boolean
Inherited from EventWidget.eventProcessed
Get the state of the event processed flag
See setEventProcessed()
.
Returns: boolean
boolean True if the current event is flagged as processed.
exec
▸ exec(point?
: QPoint, action?
: QAction | null): void
Parameters:
Name | Type |
---|---|
point? | QPoint |
action? | QAction | null |
Returns: void
focusProxy
▸ focusProxy(): QWidget
Inherited from QMenu.focusProxy
Returns: QWidget
focusWidget
▸ focusWidget(): QWidget
Inherited from QMenu.focusWidget
Returns: QWidget
font
▸ font(): QFont
Returns: QFont
frameGeometry
▸ frameGeometry(): QRect
Inherited from QMenu.frameGeometry
Returns: QRect
frameSize
▸ frameSize(): QSize
Inherited from QMenu.frameSize
Returns: QSize
geometry
▸ geometry(): QRect
Returns: QRect
getFlexNode
▸ getFlexNode(): FlexNode
Inherited from YogaWidget.getFlexNode
Returns: FlexNode
grab
Parameters:
Name | Type |
---|---|
rect? | QRect |
Returns: QPixmap
grabKeyboard
▸ grabKeyboard(): void
Inherited from QMenu.grabKeyboard
Returns: void
grabMouse
▸ grabMouse(): void
Inherited from QMenu.grabMouse
Returns: void
hasFocus
▸ hasFocus(): boolean
Returns: boolean
hasHeightForWidth
▸ hasHeightForWidth(): boolean
Inherited from QMenu.hasHeightForWidth
Returns: boolean
hasMouseTracking
▸ hasMouseTracking(): boolean
Inherited from QMenu.hasMouseTracking
Returns: boolean
hasTabletTracking
▸ hasTabletTracking(): boolean
Inherited from QMenu.hasTabletTracking
Returns: boolean
height
▸ height(): number
Returns: number
heightForWidth
▸ heightForWidth(w
: number): number
Inherited from QMenu.heightForWidth
Parameters:
Name | Type |
---|---|
w | number |
Returns: number
heightMM
▸ heightMM(): number
Returns: number
hide
▸ hide(): void
Returns: void
hideTearOffMenu
▸ hideTearOffMenu(): void
Returns: void
icon
▸ icon(): QIcon
Returns: QIcon
inherits
▸ inherits(className
: string): boolean
Inherited from QObject.inherits
Parameters:
Name | Type |
---|---|
className | string |
Returns: boolean
inputMethodHints
▸ inputMethodHints(): number
Inherited from QMenu.inputMethodHints
Returns: number
insertMenu
▸ insertMenu(before
: QAction, menu
: QMenu): QAction
Parameters:
Name | Type |
---|---|
before | QAction |
menu | QMenu |
Returns: QAction
insertSection
▸ insertSection(before
: QAction, text
: string): QAction
Parameters:
Name | Type |
---|---|
before | QAction |
text | string |
Returns: QAction
▸ insertSection(before
: QAction, icon
: QIcon, text
: string): QAction
Parameters:
Name | Type |
---|---|
before | QAction |
icon | QIcon |
text | string |
Returns: QAction
insertSeparator
▸ insertSeparator(before
: QAction): QAction
Parameters:
Name | Type |
---|---|
before | QAction |
Returns: QAction
isActiveWindow
▸ isActiveWindow(): boolean
Inherited from QMenu.isActiveWindow
Returns: boolean
isAncestorOf
▸ isAncestorOf(child
: QWidget): boolean
Inherited from QMenu.isAncestorOf
Parameters:
Name | Type |
---|---|
child | QWidget |
Returns: boolean
isEmpty
▸ isEmpty(): boolean
Returns: boolean
isEnabled
▸ isEnabled(): boolean
Inherited from QMenu.isEnabled
Returns: boolean
isEnabledTo
▸ isEnabledTo(ancestor
: QWidget): boolean
Inherited from QMenu.isEnabledTo
Parameters:
Name | Type |
---|---|
ancestor | QWidget |
Returns: boolean
isFullScreen
▸ isFullScreen(): boolean
Inherited from QMenu.isFullScreen
Returns: boolean
isHidden
▸ isHidden(): boolean
Returns: boolean
isMaximized
▸ isMaximized(): boolean
Inherited from QMenu.isMaximized
Returns: boolean
isMinimized
▸ isMinimized(): boolean
Inherited from QMenu.isMinimized
Returns: boolean
isModal
▸ isModal(): boolean
Returns: boolean
isTearOffEnabled
▸ isTearOffEnabled(): boolean
Returns: boolean
isTearOffMenuVisible
▸ isTearOffMenuVisible(): boolean
Returns: boolean
isVisible
▸ isVisible(): boolean
Inherited from QMenu.isVisible
Returns: boolean
isVisibleTo
▸ isVisibleTo(ancestor
: QWidget): boolean
Inherited from QMenu.isVisibleTo
Parameters:
Name | Type |
---|---|
ancestor | QWidget |
Returns: boolean
isWindow
▸ isWindow(): boolean
Returns: boolean
isWindowModified
▸ isWindowModified(): boolean
Inherited from QMenu.isWindowModified
Returns: boolean
killTimer
▸ killTimer(timerId
: number): void
Inherited from QObject.killTimer
Parameters:
Name | Type |
---|---|
timerId | number |
Returns: void
layout
▸ layout(): QLayout | null
Returns: QLayout | null
logicalDpiX
▸ logicalDpiX(): number
Inherited from QMenu.logicalDpiX
Returns: number
logicalDpiY
▸ logicalDpiY(): number
Inherited from QMenu.logicalDpiY
Returns: number
lower
▸ lower(): void
Returns: void
mapFrom
▸ mapFrom(parent
: QWidget, pos
: QPoint): QPoint
Parameters:
Name | Type |
---|---|
parent | QWidget |
pos | QPoint |
Returns: QPoint
mapFromGlobal
▸ mapFromGlobal(pos
: QPoint): QPoint
Inherited from QMenu.mapFromGlobal
Parameters:
Name | Type |
---|---|
pos | QPoint |
Returns: QPoint
mapFromParent
▸ mapFromParent(pos
: QPoint): QPoint
Inherited from QMenu.mapFromParent
Parameters:
Name | Type |
---|---|
pos | QPoint |
Returns: QPoint
mapTo
▸ mapTo(parent
: QWidget, pos
: QPoint): QPoint
Parameters:
Name | Type |
---|---|
parent | QWidget |
pos | QPoint |
Returns: QPoint
mapToGlobal
▸ mapToGlobal(pos
: QPoint): QPoint
Inherited from QMenu.mapToGlobal
Parameters:
Name | Type |
---|---|
pos | QPoint |
Returns: QPoint
mapToParent
▸ mapToParent(pos
: QPoint): QPoint
Inherited from QMenu.mapToParent
Parameters:
Name | Type |
---|---|
pos | QPoint |
Returns: QPoint
maximumHeight
▸ maximumHeight(): number
Inherited from QMenu.maximumHeight
Returns: number
maximumSize
▸ maximumSize(): QSize
Inherited from QMenu.maximumSize
Returns: QSize
maximumWidth
▸ maximumWidth(): number
Inherited from QMenu.maximumWidth
Returns: number
menuAction
▸ menuAction(): QAction
Returns: QAction
minimumHeight
▸ minimumHeight(): number
Inherited from QMenu.minimumHeight
Returns: number
minimumSize
▸ minimumSize(): QSize
Inherited from QMenu.minimumSize
Returns: QSize
minimumSizeHint
▸ minimumSizeHint(): QSize
Inherited from QMenu.minimumSizeHint
Returns: QSize
minimumWidth
▸ minimumWidth(): number
Inherited from QMenu.minimumWidth
Returns: number
move
▸ move(x
: number, y
: number): void
Parameters:
Name | Type |
---|---|
x | number |
y | number |
Returns: void
nativeParentWidget
▸ nativeParentWidget(): QWidget
Inherited from QMenu.nativeParentWidget
Returns: QWidget
nextInFocusChain
▸ nextInFocusChain(): QWidget
Inherited from QMenu.nextInFocusChain
Returns: QWidget
normalGeometry
▸ normalGeometry(): QRect
Inherited from QMenu.normalGeometry
Returns: QRect
objectName
▸ objectName(): string
Inherited from QObject.objectName
Returns: string
paintingActive
▸ paintingActive(): boolean
Inherited from QMenu.paintingActive
Returns: boolean
parent
▸ parent(): QObject
Returns: QObject
parentWidget
▸ parentWidget(): QWidget
Inherited from QMenu.parentWidget
Returns: QWidget
physicalDpiX
▸ physicalDpiX(): number
Inherited from QMenu.physicalDpiX
Returns: number
physicalDpiY
▸ physicalDpiY(): number
Inherited from QMenu.physicalDpiY
Returns: number
popup
▸ popup(point
: QPoint, action?
: QAction): void
Parameters:
Name | Type |
---|---|
point | QPoint |
action? | QAction |
Returns: void
pos
▸ pos(): object
Returns: object
-
x: number
-
y: number
previousInFocusChain
▸ previousInFocusChain(): QWidget
Inherited from QMenu.previousInFocusChain
Returns: QWidget
property
▸ property(name
: string): QVariant
Inherited from QObject.property
Parameters:
Name | Type |
---|---|
name | string |
Returns: QVariant
raise
▸ raise(): void
Returns: void
rect
▸ rect(): QRect
Returns: QRect
releaseKeyboard
▸ releaseKeyboard(): void
Inherited from QMenu.releaseKeyboard
Returns: void