plastichub/nodeguy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
392aa3cd4c
nodeguy/website/docs/api/generated/classes/qmenu.md
Atul R 392aa3cd4c
Adds automatic docs for now (#308) 
* adds basic typedoc

* backup

* Adds all docs to source code

* Adds autogenerated docs

* Fixes doc links

* Updates docs
2019-12-29 00:42:06 +05:30

991 lines
19 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
id: "qmenu"
title: "QMenu"
sidebar_label: "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](https://doc.qt.io/qt-5/qmenu.html)**
### Example
```javascript
const { QMenu } = require("@nodegui/nodegui");
const menu = new QMenu();
```
## Hierarchy
↳ [NodeWidget](nodewidget.md)‹[QMenuSignals](../globals.md#qmenusignals)›
↳ **QMenu**
## Index
### Constructors
* [constructor](qmenu.md#constructor)
### Properties
* [_rawInlineStyle](qmenu.md#_rawinlinestyle)
* [actions](qmenu.md#actions)
* [layout](qmenu.md#optional-layout)
* [native](qmenu.md#native)
* [nodeChildren](qmenu.md#nodechildren)
* [nodeParent](qmenu.md#optional-nodeparent)
* [type](qmenu.md#type)
### Methods
* [activateWindow](qmenu.md#activatewindow)
* [addAction](qmenu.md#addaction)
* [addEventListener](qmenu.md#addeventlistener)
* [adjustSize](qmenu.md#adjustsize)
* [close](qmenu.md#close)
* [geometry](qmenu.md#geometry)
* [getFlexNode](qmenu.md#getflexnode)
* [hasMouseTracking](qmenu.md#hasmousetracking)
* [hide](qmenu.md#hide)
* [inherits](qmenu.md#inherits)
* [isEnabled](qmenu.md#isenabled)
* [isVisible](qmenu.md#isvisible)
* [lower](qmenu.md#lower)
* [move](qmenu.md#move)
* [objectName](qmenu.md#objectname)
* [pos](qmenu.md#pos)
* [property](qmenu.md#property)
* [raise](qmenu.md#raise)
* [removeEventListener](qmenu.md#removeeventlistener)
* [repaint](qmenu.md#repaint)
* [resize](qmenu.md#resize)
* [setAttribute](qmenu.md#setattribute)
* [setContextMenuPolicy](qmenu.md#setcontextmenupolicy)
* [setCursor](qmenu.md#setcursor)
* [setEnabled](qmenu.md#setenabled)
* [setFixedSize](qmenu.md#setfixedsize)
* [setFlexNodeSizeControlled](qmenu.md#setflexnodesizecontrolled)
* [setGeometry](qmenu.md#setgeometry)
* [setInlineStyle](qmenu.md#setinlinestyle)
* [setLayout](qmenu.md#setlayout)
* [setMaximumSize](qmenu.md#setmaximumsize)
* [setMinimumSize](qmenu.md#setminimumsize)
* [setMouseTracking](qmenu.md#setmousetracking)
* [setNodeParent](qmenu.md#setnodeparent)
* [setObjectName](qmenu.md#setobjectname)
* [setProperty](qmenu.md#setproperty)
* [setStyleSheet](qmenu.md#setstylesheet)
* [setTitle](qmenu.md#settitle)
* [setWindowFlag](qmenu.md#setwindowflag)
* [setWindowIcon](qmenu.md#setwindowicon)
* [setWindowOpacity](qmenu.md#setwindowopacity)
* [setWindowState](qmenu.md#setwindowstate)
* [setWindowTitle](qmenu.md#setwindowtitle)
* [show](qmenu.md#show)
* [showFullScreen](qmenu.md#showfullscreen)
* [showMaximized](qmenu.md#showmaximized)
* [showMinimized](qmenu.md#showminimized)
* [showNormal](qmenu.md#shownormal)
* [size](qmenu.md#size)
* [styleSheet](qmenu.md#stylesheet)
* [testAttribute](qmenu.md#testattribute)
* [update](qmenu.md#update)
* [updateGeometry](qmenu.md#updategeometry)
* [windowOpacity](qmenu.md#windowopacity)
* [windowState](qmenu.md#windowstate)
* [windowTitle](qmenu.md#windowtitle)
## Constructors
### constructor
\+ **new QMenu**(): *[QMenu](qmenu.md)*
*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)*
**Returns:** *[QMenu](qmenu.md)*
\+ **new QMenu**(`parent`: [NodeWidget](nodewidget.md)‹any›): *[QMenu](qmenu.md)*
*Overrides [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)*
**Parameters:**
Name | Type |
------ | ------ |
`parent` | [NodeWidget](nodewidget.md)‹any› |
**Returns:** *[QMenu](qmenu.md)*
## Properties
### _rawInlineStyle
• **_rawInlineStyle**: *string* = ""
*Inherited from [NodeWidget](nodewidget.md).[_rawInlineStyle](nodewidget.md#_rawinlinestyle)*
___
### actions
• **actions**: *Set‹[QAction](qaction.md)›*
___
### `Optional` layout
• **layout**? : *[NodeLayout](nodelayout.md)‹[QMenuSignals](../globals.md#qmenusignals)›*
*Inherited from [NodeWidget](nodewidget.md).[layout](nodewidget.md#optional-layout)*
___
### native
• **native**: *[NativeElement](../globals.md#nativeelement)*
*Overrides [Component](component.md).[native](component.md#abstract-native)*
___
### nodeChildren
• **nodeChildren**: *Set‹unknown›* = new Set()
*Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)*
___
### `Optional` nodeParent
• **nodeParent**? : *[Component](component.md)*
*Inherited from [Component](component.md).[nodeParent](component.md#optional-nodeparent)*
___
### type
• **type**: *string* = "widget"
*Inherited from [NodeWidget](nodewidget.md).[type](nodewidget.md#type)*
## Methods
### activateWindow
▸ **activateWindow**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[activateWindow](nodewidget.md#activatewindow)*
**Returns:** *void*
___
### addAction
▸ **addAction**(`action`: [QAction](qaction.md)): *[QAction](qaction.md)*
**Parameters:**
Name | Type |
------ | ------ |
`action` | [QAction](qaction.md) |
**Returns:** *[QAction](qaction.md)*
___
### addEventListener
▸ **addEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void*
*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)*
**Type parameters:**
▪ **SignalType**: *keyof QMenuSignals*
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`signalType` | SignalType | SignalType is a signal from the widgets signals interface. |
`callback` | Signals[SignalType] | Corresponding callback for the signal as mentioned in the widget's signal interface |
**Returns:** *void*
void
For example in the case of QPushButton:
```js
const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface
```
▸ **addEventListener**(`eventType`: [WidgetEventTypes](../enums/widgeteventtypes.md), `callback`: function): *void*
*Inherited from [EventWidget](eventwidget.md).[addEventListener](eventwidget.md#addeventlistener)*
**Parameters:**
▪ **eventType**: *[WidgetEventTypes](../enums/widgeteventtypes.md)*
▪ **callback**: *function*
For example in the case of QPushButton:
```js
const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));
```
▸ (`event?`: [NativeElement](../globals.md#nativeelement)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`event?` | [NativeElement](../globals.md#nativeelement) |
**Returns:** *void*
___
### adjustSize
▸ **adjustSize**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[adjustSize](nodewidget.md#adjustsize)*
**Returns:** *void*
___
### close
▸ **close**(): *boolean*
*Inherited from [NodeWidget](nodewidget.md).[close](nodewidget.md#close)*
**Returns:** *boolean*
___
### geometry
▸ **geometry**(): *[QRect](qrect.md)*
*Inherited from [NodeWidget](nodewidget.md).[geometry](nodewidget.md#geometry)*
**Returns:** *[QRect](qrect.md)*
___
### getFlexNode
▸ **getFlexNode**(): *[FlexNode](../globals.md#flexnode)*
*Inherited from [YogaWidget](yogawidget.md).[getFlexNode](yogawidget.md#getflexnode)*
**Returns:** *[FlexNode](../globals.md#flexnode)*
___
### hasMouseTracking
▸ **hasMouseTracking**(): *boolean*
*Inherited from [NodeWidget](nodewidget.md).[hasMouseTracking](nodewidget.md#hasmousetracking)*
**Returns:** *boolean*
___
### hide
▸ **hide**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[hide](nodewidget.md#hide)*
**Returns:** *void*
___
### inherits
▸ **inherits**(`className`: string): *boolean*
*Inherited from [NodeObject](nodeobject.md).[inherits](nodeobject.md#inherits)*
**Parameters:**
Name | Type |
------ | ------ |
`className` | string |
**Returns:** *boolean*
___
### isEnabled
▸ **isEnabled**(): *boolean*
*Inherited from [NodeWidget](nodewidget.md).[isEnabled](nodewidget.md#isenabled)*
**Returns:** *boolean*
___
### isVisible
▸ **isVisible**(): *boolean*
*Inherited from [NodeWidget](nodewidget.md).[isVisible](nodewidget.md#isvisible)*
**Returns:** *boolean*
___
### lower
▸ **lower**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[lower](nodewidget.md#lower)*
**Returns:** *void*
___
### move
▸ **move**(`x`: number, `y`: number): *void*
*Inherited from [NodeWidget](nodewidget.md).[move](nodewidget.md#move)*
**Parameters:**
Name | Type |
------ | ------ |
`x` | number |
`y` | number |
**Returns:** *void*
___
### objectName
▸ **objectName**(): *string*
*Inherited from [NodeObject](nodeobject.md).[objectName](nodeobject.md#objectname)*
**Returns:** *string*
___
### pos
▸ **pos**(): *object*
*Inherited from [NodeWidget](nodewidget.md).[pos](nodewidget.md#pos)*
**Returns:** *object*
___
### property
▸ **property**(`name`: string): *[QVariant](qvariant.md)*
*Inherited from [NodeObject](nodeobject.md).[property](nodeobject.md#property)*
**Parameters:**
Name | Type |
------ | ------ |
`name` | string |
**Returns:** *[QVariant](qvariant.md)*
___
### raise
▸ **raise**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[raise](nodewidget.md#raise)*
**Returns:** *void*
___
### removeEventListener
▸ **removeEventListener**<**SignalType**>(`signalType`: SignalType, `callback`: Signals[SignalType]): *void*
*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)*
**Type parameters:**
▪ **SignalType**: *keyof QMenuSignals*
**Parameters:**
Name | Type |
------ | ------ |
`signalType` | SignalType |
`callback` | Signals[SignalType] |
**Returns:** *void*
▸ **removeEventListener**(`eventType`: [WidgetEventTypes](../enums/widgeteventtypes.md), `callback`: function): *void*
*Inherited from [EventWidget](eventwidget.md).[removeEventListener](eventwidget.md#removeeventlistener)*
**Parameters:**
▪ **eventType**: *[WidgetEventTypes](../enums/widgeteventtypes.md)*
▪ **callback**: *function*
▸ (`event?`: [NativeElement](../globals.md#nativeelement)): *void*
**Parameters:**
Name | Type |
------ | ------ |
`event?` | [NativeElement](../globals.md#nativeelement) |
**Returns:** *void*
___
### repaint
▸ **repaint**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[repaint](nodewidget.md#repaint)*
**Returns:** *void*
___
### resize
▸ **resize**(`width`: number, `height`: number): *void*
*Inherited from [NodeWidget](nodewidget.md).[resize](nodewidget.md#resize)*
**Parameters:**
Name | Type |
------ | ------ |
`width` | number |
`height` | number |
**Returns:** *void*
___
### setAttribute
▸ **setAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md), `switchOn`: boolean): *void*
*Inherited from [NodeWidget](nodewidget.md).[setAttribute](nodewidget.md#setattribute)*
**Parameters:**
Name | Type |
------ | ------ |
`attribute` | [WidgetAttribute](../enums/widgetattribute.md) |
`switchOn` | boolean |
**Returns:** *void*
___
### setContextMenuPolicy
▸ **setContextMenuPolicy**(`contextMenuPolicy`: [ContextMenuPolicy](../enums/contextmenupolicy.md)): *void*
*Inherited from [NodeWidget](nodewidget.md).[setContextMenuPolicy](nodewidget.md#setcontextmenupolicy)*
**Parameters:**
Name | Type |
------ | ------ |
`contextMenuPolicy` | [ContextMenuPolicy](../enums/contextmenupolicy.md) |
**Returns:** *void*
___
### setCursor
▸ **setCursor**(`cursor`: [CursorShape](../enums/cursorshape.md) | [QCursor](qcursor.md)): *void*
*Inherited from [NodeWidget](nodewidget.md).[setCursor](nodewidget.md#setcursor)*
**Parameters:**
Name | Type |
------ | ------ |
`cursor` | [CursorShape](../enums/cursorshape.md) &#124; [QCursor](qcursor.md) |
**Returns:** *void*
___
### setEnabled
▸ **setEnabled**(`enabled`: boolean): *void*
*Inherited from [NodeWidget](nodewidget.md).[setEnabled](nodewidget.md#setenabled)*
**Parameters:**
Name | Type |
------ | ------ |
`enabled` | boolean |
**Returns:** *void*
___
### setFixedSize
▸ **setFixedSize**(`width`: number, `height`: number): *void*
*Inherited from [NodeWidget](nodewidget.md).[setFixedSize](nodewidget.md#setfixedsize)*
**Parameters:**
Name | Type |
------ | ------ |
`width` | number |
`height` | number |
**Returns:** *void*
___
### setFlexNodeSizeControlled
▸ **setFlexNodeSizeControlled**(`isSizeControlled`: boolean): *void*
*Inherited from [YogaWidget](yogawidget.md).[setFlexNodeSizeControlled](yogawidget.md#setflexnodesizecontrolled)*
sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged).
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`isSizeControlled` | boolean | |
**Returns:** *void*
___
### setGeometry
▸ **setGeometry**(`x`: number, `y`: number, `w`: number, `h`: number): *void*
*Inherited from [NodeWidget](nodewidget.md).[setGeometry](nodewidget.md#setgeometry)*
**Parameters:**
Name | Type |
------ | ------ |
`x` | number |
`y` | number |
`w` | number |
`h` | number |
**Returns:** *void*
___
### setInlineStyle
▸ **setInlineStyle**(`style`: string): *void*
*Inherited from [NodeWidget](nodewidget.md).[setInlineStyle](nodewidget.md#setinlinestyle)*
**Parameters:**
Name | Type |
------ | ------ |
`style` | string |
**Returns:** *void*
___
### setLayout
▸ **setLayout**(`parentLayout`: [NodeLayout](nodelayout.md)‹[QMenuSignals](../globals.md#qmenusignals)›): *void*
*Inherited from [NodeWidget](nodewidget.md).[setLayout](nodewidget.md#setlayout)*
**Parameters:**
Name | Type |
------ | ------ |
`parentLayout` | [NodeLayout](nodelayout.md)‹[QMenuSignals](../globals.md#qmenusignals)› |
**Returns:** *void*
___
### setMaximumSize
▸ **setMaximumSize**(`maxw`: number, `maxh`: number): *void*
*Inherited from [NodeWidget](nodewidget.md).[setMaximumSize](nodewidget.md#setmaximumsize)*
**Parameters:**
Name | Type |
------ | ------ |
`maxw` | number |
`maxh` | number |
**Returns:** *void*
___
### setMinimumSize
▸ **setMinimumSize**(`minw`: number, `minh`: number): *void*
*Inherited from [NodeWidget](nodewidget.md).[setMinimumSize](nodewidget.md#setminimumsize)*
**Parameters:**
Name | Type |
------ | ------ |
`minw` | number |
`minh` | number |
**Returns:** *void*
___
### setMouseTracking
▸ **setMouseTracking**(`isMouseTracked`: boolean): *void*
*Inherited from [NodeWidget](nodewidget.md).[setMouseTracking](nodewidget.md#setmousetracking)*
**Parameters:**
Name | Type |
------ | ------ |
`isMouseTracked` | boolean |
**Returns:** *void*
___
### setNodeParent
▸ **setNodeParent**(`parent?`: [Component](component.md)): *void*
*Inherited from [Component](component.md).[setNodeParent](component.md#setnodeparent)*
**Parameters:**
Name | Type |
------ | ------ |
`parent?` | [Component](component.md) |
**Returns:** *void*
___
### setObjectName
▸ **setObjectName**(`objectName`: string): *void*
*Inherited from [NodeWidget](nodewidget.md).[setObjectName](nodewidget.md#setobjectname)*
*Overrides [NodeObject](nodeobject.md).[setObjectName](nodeobject.md#setobjectname)*
**Parameters:**
Name | Type |
------ | ------ |
`objectName` | string |
**Returns:** *void*
___
### setProperty
▸ **setProperty**(`name`: string, `value`: [QVariantType](../globals.md#qvarianttype)): *boolean*
*Inherited from [NodeObject](nodeobject.md).[setProperty](nodeobject.md#setproperty)*
**Parameters:**
Name | Type |
------ | ------ |
`name` | string |
`value` | [QVariantType](../globals.md#qvarianttype) |
**Returns:** *boolean*
___
### setStyleSheet
▸ **setStyleSheet**(`styleSheet`: string): *void*
*Inherited from [NodeWidget](nodewidget.md).[setStyleSheet](nodewidget.md#setstylesheet)*
**Parameters:**
Name | Type |
------ | ------ |
`styleSheet` | string |
**Returns:** *void*
___
### setTitle
▸ **setTitle**(`title`: string): *void*
**Parameters:**
Name | Type |
------ | ------ |
`title` | string |
**Returns:** *void*
___
### setWindowFlag
▸ **setWindowFlag**(`windowType`: [WindowType](../enums/windowtype.md), `switchOn`: boolean): *void*
*Inherited from [NodeWidget](nodewidget.md).[setWindowFlag](nodewidget.md#setwindowflag)*
**Parameters:**
Name | Type |
------ | ------ |
`windowType` | [WindowType](../enums/windowtype.md) |
`switchOn` | boolean |
**Returns:** *void*
___
### setWindowIcon
▸ **setWindowIcon**(`icon`: [QIcon](qicon.md)): *void*
*Inherited from [NodeWidget](nodewidget.md).[setWindowIcon](nodewidget.md#setwindowicon)*
**Parameters:**
Name | Type |
------ | ------ |
`icon` | [QIcon](qicon.md) |
**Returns:** *void*
___
### setWindowOpacity
▸ **setWindowOpacity**(`opacity`: number): *void*
*Inherited from [NodeWidget](nodewidget.md).[setWindowOpacity](nodewidget.md#setwindowopacity)*
**Parameters:**
Name | Type |
------ | ------ |
`opacity` | number |
**Returns:** *void*
___
### setWindowState
▸ **setWindowState**(`state`: [WindowState](../enums/windowstate.md)): *void*
*Inherited from [NodeWidget](nodewidget.md).[setWindowState](nodewidget.md#setwindowstate)*
**Parameters:**
Name | Type |
------ | ------ |
`state` | [WindowState](../enums/windowstate.md) |
**Returns:** *void*
___
### setWindowTitle
▸ **setWindowTitle**(`title`: string): *void*
*Inherited from [NodeWidget](nodewidget.md).[setWindowTitle](nodewidget.md#setwindowtitle)*
**Parameters:**
Name | Type |
------ | ------ |
`title` | string |
**Returns:** *void*
___
### show
▸ **show**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[show](nodewidget.md#show)*
**Returns:** *void*
___
### showFullScreen
▸ **showFullScreen**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[showFullScreen](nodewidget.md#showfullscreen)*
**Returns:** *void*
___
### showMaximized
▸ **showMaximized**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[showMaximized](nodewidget.md#showmaximized)*
**Returns:** *void*
___
### showMinimized
▸ **showMinimized**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[showMinimized](nodewidget.md#showminimized)*
**Returns:** *void*
___
### showNormal
▸ **showNormal**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[showNormal](nodewidget.md#shownormal)*
**Returns:** *void*
___
### size
▸ **size**(): *[QSize](qsize.md)*
*Inherited from [NodeWidget](nodewidget.md).[size](nodewidget.md#size)*
**Returns:** *[QSize](qsize.md)*
___
### styleSheet
▸ **styleSheet**(): *string*
*Inherited from [NodeWidget](nodewidget.md).[styleSheet](nodewidget.md#stylesheet)*
**Returns:** *string*
___
### testAttribute
▸ **testAttribute**(`attribute`: [WidgetAttribute](../enums/widgetattribute.md)): *boolean*
*Inherited from [NodeWidget](nodewidget.md).[testAttribute](nodewidget.md#testattribute)*
**Parameters:**
Name | Type |
------ | ------ |
`attribute` | [WidgetAttribute](../enums/widgetattribute.md) |
**Returns:** *boolean*
___
### update
▸ **update**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[update](nodewidget.md#update)*
**Returns:** *void*
___
### updateGeometry
▸ **updateGeometry**(): *void*
*Inherited from [NodeWidget](nodewidget.md).[updateGeometry](nodewidget.md#updategeometry)*
**Returns:** *void*
___
### windowOpacity
▸ **windowOpacity**(): *number*
*Inherited from [NodeWidget](nodewidget.md).[windowOpacity](nodewidget.md#windowopacity)*
**Returns:** *number*
___
### windowState
▸ **windowState**(): *number*
*Inherited from [NodeWidget](nodewidget.md).[windowState](nodewidget.md#windowstate)*
**Returns:** *number*
___
### windowTitle
▸ **windowTitle**(): *string*
*Inherited from [NodeWidget](nodewidget.md).[windowTitle](nodewidget.md#windowtitle)*
**Returns:** *string*
Reference in New Issue View Git Blame Copy Permalink