QFileDialog

Create and control file dialogs.

This class is a JS wrapper around Qt's QFileDialog class

A QFileDialog class provides a dialog that allow users to select files or directories.

Example

const { QFileDialog } = require("@nodegui/nodegui");

const fileDialog = new QFileDialog();
fileDialog.setFileMode(FileMode.AnyFile);
fileDialog.setNameFilter('Images (*.png *.xpm *.jpg)');
fileDialog.exec();

const selectedFiles = fileDialog.selectedFiles();
console.log(selectedFiles);

Hierarchy

↳ QDialog‹QFileDialogSignals›

↳ QFileDialog

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

+ new QFileDialog(): QFileDialog

Overrides QDialog.constructor

Returns: QFileDialog

+ new QFileDialog(parent: QWidget, caption?: string, directory?: string, filter?: string): QFileDialog

Overrides QDialog.constructor

Parameters:

Name	Type
`parent`	QWidget
`caption?`	string
`directory?`	string
`filter?`	string

Returns: QFileDialog

Properties

_rawInlineStyle

• _rawInlineStyle: string

Inherited from QMenu._rawInlineStyle

native

• native: NativeElement | null

Inherited from Component.native

type

• type: string

Inherited from QMenu.type

Methods

_id

▸ _id(): number

Inherited from QObject._id

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.

accept

▸ accept(): void

Inherited from QDialog.accept

Returns: void

acceptDrops

▸ acceptDrops(): boolean

Inherited from QMenu.acceptDrops

Returns: boolean

acceptMode

▸ acceptMode(): AcceptMode

Returns: AcceptMode

accessibleDescription

▸ accessibleDescription(): string

Inherited from QMenu.accessibleDescription

Returns: string

accessibleName

▸ accessibleName(): string

Inherited from QMenu.accessibleName

Returns: string

activateWindow

▸ activateWindow(): void

Inherited from QMenu.activateWindow

Returns: void

addAction

▸ addAction(action: QAction | string): QAction

Inherited from QMenu.addAction

Parameters:

Name	Type
`action`	QAction \| string

Returns: QAction

addEventListener

▸ addEventListener‹SignalType›(signalType: SignalType, callback: QFileDialogSignals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof QFileDialogSignals

Parameters:

Name	Type	Description
`signalType`	SignalType	SignalType is a signal from the widgets signals interface.
`callback`	QFileDialogSignals[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

adjustSize

▸ adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void

autoFillBackground

▸ autoFillBackground(): boolean

Inherited from QMenu.autoFillBackground

Returns: boolean

baseSize

▸ baseSize(): QSize

Inherited from QMenu.baseSize

Returns: QSize

childAt

▸ childAt(x: number, y: number): QWidget

Inherited from QMenu.childAt

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

clearFocus

▸ clearFocus(): void

Inherited from QMenu.clearFocus

Returns: void

clearMask

▸ clearMask(): void

Inherited from QMenu.clearMask

Returns: void

close

▸ close(): boolean

Inherited from QMenu.close

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

defaultSuffix

▸ defaultSuffix(): string

Returns: string

delete

▸ delete(): void

Inherited from QObject.delete

Returns: void

deleteLater

▸ deleteLater(): void

Inherited from QObject.deleteLater

Returns: void

depth

▸ depth(): number

Inherited from QMenu.depth

Returns: number

devicePixelRatio

▸ devicePixelRatio(): number

Inherited from QMenu.devicePixelRatio

Returns: number

devicePixelRatioF

▸ devicePixelRatioF(): number

Inherited from QMenu.devicePixelRatioF

Returns: number

done

▸ done(r: number): void

Inherited from QDialog.done

Parameters:

Name	Type
`r`	number

Returns: void

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(): DialogCode

Inherited from QDialog.exec

Returns: DialogCode

fileMode

▸ fileMode(): FileMode

Returns: FileMode

focusProxy

▸ focusProxy(): QWidget

Inherited from QMenu.focusProxy

Returns: QWidget

focusWidget

▸ focusWidget(): QWidget

Inherited from QMenu.focusWidget

Returns: QWidget

font

▸ font(): QFont

Inherited from QMenu.font

Returns: QFont

frameGeometry

▸ frameGeometry(): QRect

Inherited from QMenu.frameGeometry

Returns: QRect

frameSize

▸ frameSize(): QSize

Inherited from QMenu.frameSize

Returns: QSize

geometry

▸ geometry(): QRect

Inherited from QMenu.geometry

Returns: QRect

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode

grab

▸ grab(rect?: QRect): QPixmap

Inherited from QMenu.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

Inherited from QMenu.hasFocus

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

Inherited from QMenu.height

Returns: number

heightForWidth

▸ heightForWidth(w: number): number

Inherited from QMenu.heightForWidth

Parameters:

Name	Type
`w`	number

Returns: number

heightMM

▸ heightMM(): number

Inherited from QMenu.heightMM

Returns: number

hide

▸ hide(): void

Inherited from QMenu.hide

Returns: void

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

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

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

Inherited from QMenu.isHidden

Returns: boolean

isMaximized

▸ isMaximized(): boolean

Inherited from QMenu.isMaximized

Returns: boolean

isMinimized

▸ isMinimized(): boolean

Inherited from QMenu.isMinimized

Returns: boolean

isModal

▸ isModal(): boolean

Inherited from QMenu.isModal

Returns: boolean

isSizeGripEnabled

▸ isSizeGripEnabled(): boolean

Inherited from QDialog.isSizeGripEnabled

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

Inherited from QMenu.isWindow

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

labelText

▸ labelText(label: DialogLabel): string

Parameters:

Name	Type
`label`	DialogLabel

Returns: string

layout

▸ layout(): QLayout | null

Inherited from QMenu.layout

Returns: QLayout | null

logicalDpiX

▸ logicalDpiX(): number

Inherited from QMenu.logicalDpiX

Returns: number

logicalDpiY

▸ logicalDpiY(): number

Inherited from QMenu.logicalDpiY

Returns: number

lower

▸ lower(): void

Inherited from QMenu.lower

Returns: void

mapFrom

▸ mapFrom(parent: QWidget, pos: QPoint): QPoint

Inherited from QMenu.mapFrom

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

Inherited from QMenu.mapTo

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

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

Inherited from QMenu.move

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

open

▸ open(): void

Inherited from QDialog.open

Returns: void

options

▸ options(): Option

Returns: Option

paintingActive

▸ paintingActive(): boolean

Inherited from QMenu.paintingActive

Returns: boolean

parent

▸ parent(): QObject

Inherited from QObject.parent

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

pos

▸ pos(): object

Inherited from QMenu.pos

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

Inherited from QMenu.raise

Returns: void

rect

▸ rect(): QRect

Inherited from QMenu.rect

Returns: QRect

reject

▸ reject(): void

Inherited from QDialog.reject

Returns: void

releaseKeyboard

▸ releaseKeyboard(): void

Inherited from QMenu.releaseKeyboard

Returns: void

releaseMouse

▸ releaseMouse(): void

Inherited from QMenu.releaseMouse

Returns: void

releaseShortcut

▸ releaseShortcut(id: number): void

Inherited from QMenu.releaseShortcut

Parameters:

Name	Type
`id`	number

Returns: void

removeAction

▸ removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

Name	Type
`action`	QAction

Returns: void

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: QFileDialogSignals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QFileDialogSignals

Parameters:

Name	Type
`signalType`	SignalType
`callback`	QFileDialogSignals[SignalType]
`options?`	EventListenerOptions

Returns: void

▸ removeEventListener(eventType: WidgetEventTypes, callback: function, options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
`event?`	NativeRawPointer‹"QEvent"›

▪Optional options: EventListenerOptions

Returns: void

repaint

▸ repaint(): void

Inherited from QMenu.repaint

Returns: void

repolish

▸ repolish(): void

Inherited from QMenu.repolish

Returns: void

resize

▸ resize(width: number, height: number): void

Inherited from QMenu.resize

Parameters:

Name	Type
`width`	number
`height`	number

Returns: void

result

▸ result(): number

Inherited from QDialog.result

Returns: number

selectedFiles

▸ selectedFiles(): string[]

Returns: string[]

setAcceptDrops

▸ setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

Name	Type
`on`	boolean

Returns: void

setAcceptMode

▸ setAcceptMode(acceptMode: AcceptMode): void

Parameters:

Name	Type
`acceptMode`	AcceptMode

Returns: void

setAccessibleDescription

▸ setAccessibleDescription(description: string): void

Inherited from QMenu.setAccessibleDescription

Parameters:

Name	Type
`description`	string

Returns: void

setAccessibleName

▸ setAccessibleName(name: string): void

Inherited from QMenu.setAccessibleName

Parameters:

Name	Type
`name`	string

Returns: void

setAttribute

▸ setAttribute(attribute: WidgetAttribute, switchOn: boolean): void

Inherited from QMenu.setAttribute

Parameters:

Name	Type
`attribute`	WidgetAttribute
`switchOn`	boolean

Returns: void

setAutoFillBackground

▸ setAutoFillBackground(enabled: boolean): void

Inherited from QMenu.setAutoFillBackground

Parameters:

Name	Type
`enabled`	boolean

Returns: void

setBaseSize

▸ setBaseSize(size: QSize): void

Inherited from QMenu.setBaseSize

Parameters:

Name	Type
`size`	QSize

Returns: void

setContentsMargins

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

Inherited from QMenu.setContentsMargins

Parameters:

Name	Type
`left`	number
`top`	number
`right`	number
`bottom`	number

Returns: void

setContextMenuPolicy

▸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

Name	Type
`contextMenuPolicy`	ContextMenuPolicy

Returns: void

setCursor

▸ setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

Name	Type
`cursor`	CursorShape \| QCursor

Returns: void

setDefaultSuffix

▸ setDefaultSuffix(defaultSuffix: string): void

Parameters:

Name	Type
`defaultSuffix`	string

Returns: void

setDisabled

▸ setDisabled(disable: boolean): void

Inherited from QMenu.setDisabled

Parameters:

Name	Type
`disable`	boolean

Returns: void

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

Name	Type
`enabled`	boolean

Returns: void

setEventProcessed

▸ setEventProcessed(isProcessed: boolean): void

Inherited from EventWidget.setEventProcessed

Mark the current event as having been processed

This method is used to indicate that the currently dispatched event has been processed and no further processing by superclasses is required. It only makes sense to call this method from an event handler.

When set, this flag will cause NodeGui's QObject::event() method to return true and not call the superclass event(), effectively preventing any further processing on this event.

Parameters:

Name	Type	Description
`isProcessed`	boolean	true if the event has been processed.

Returns: void

setFileMode

▸ setFileMode(fileMode: FileMode): void

Parameters:

Name	Type
`fileMode`	FileMode

Returns: void

setFixedHeight

▸ setFixedHeight(h: number): void

Inherited from QMenu.setFixedHeight

Parameters:

Name	Type
`h`	number

Returns: void

setFixedSize

▸ setFixedSize(width: number, height: number): void

Inherited from QMenu.setFixedSize

Parameters:

Name	Type
`width`	number
`height`	number

Returns: void

setFixedWidth

▸ setFixedWidth(w: number): void

Inherited from QMenu.setFixedWidth

Parameters:

Name	Type
`w`	number

Returns: void

setFlexNodeSizeControlled

▸ setFlexNodeSizeControlled(isSizeControlled: boolean): void

Inherited from YogaWidget.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

setFocus

▸ setFocus(reason: FocusReason): void

Inherited from QMenu.setFocus

Parameters:

Name	Type	Default
`reason`	FocusReason	FocusReason.OtherFocusReason

Returns: void

setFocusPolicy

▸ setFocusPolicy(policy: FocusPolicy): void

Inherited from QMenu.setFocusPolicy

Parameters:

Name	Type
`policy`	FocusPolicy

Returns: void

setFocusProxy

▸ setFocusProxy(widget: QWidget): void

Inherited from QMenu.setFocusProxy

Parameters:

Name	Type
`widget`	QWidget

Returns: void

setFont

▸ setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

Name	Type
`font`	QFont

Returns: void

setGeometry

▸ setGeometry(x: number, y: number, w: number, h: number): void

Inherited from QMenu.setGeometry

Parameters:

Name	Type
`x`	number
`y`	number
`w`	number
`h`	number

Returns: void

setGraphicsEffect

▸ setGraphicsEffect(effect: QGraphicsEffect‹any›): void

Inherited from QMenu.setGraphicsEffect

Parameters:

Name	Type
`effect`	QGraphicsEffect‹any›

Returns: void

setHidden

▸ setHidden(hidden: boolean): void

Inherited from QMenu.setHidden

Parameters:

Name	Type
`hidden`	boolean

Returns: void

setInlineStyle

▸ setInlineStyle(style: string, postprocess: boolean): void

Inherited from QMenu.setInlineStyle

Parameters:

Name	Type	Default
`style`	string	-
`postprocess`	boolean	true

Returns: void

setInputMethodHints

▸ setInputMethodHints(hints: number): void

Inherited from QMenu.setInputMethodHints

Parameters:

Name	Type
`hints`	number

Returns: void

setLabelText

▸ setLabelText(label: DialogLabel, text: string): void

Parameters:

Name	Type
`label`	DialogLabel
`text`	string

Returns: void

setLayout

▸ setLayout(layout: QLayout): void

Inherited from QMenu.setLayout

Parameters:

Name	Type
`layout`	QLayout

Returns: void

setMaximumHeight

▸ setMaximumHeight(maxh: number): void

Inherited from QMenu.setMaximumHeight

Parameters:

Name	Type
`maxh`	number

Returns: void

setMaximumSize

▸ setMaximumSize(maxw: number, maxh: number): void

Inherited from QMenu.setMaximumSize

Parameters:

Name	Type
`maxw`	number
`maxh`	number

Returns: void

setMaximumWidth

▸ setMaximumWidth(maxw: number): void

Inherited from QMenu.setMaximumWidth

Parameters:

Name	Type
`maxw`	number

Returns: void

setMinimumHeight

▸ setMinimumHeight(minh: number): void

Inherited from QMenu.setMinimumHeight

Parameters:

Name	Type
`minh`	number

Returns: void

setMinimumSize

▸ setMinimumSize(minw: number, minh: number): void

Inherited from QMenu.setMinimumSize

Parameters:

Name	Type
`minw`	number
`minh`	number

Returns: void

setMinimumWidth

▸ setMinimumWidth(minw: number): void

Inherited from QMenu.setMinimumWidth

Parameters:

Name	Type
`minw`	number

Returns: void

setModal

▸ setModal(modal: boolean): void

Inherited from QDialog.setModal

Parameters:

Name	Type
`modal`	boolean

Returns: void

setMouseTracking

▸ setMouseTracking(isMouseTracked: boolean): void

Inherited from QMenu.setMouseTracking

Parameters:

Name	Type
`isMouseTracked`	boolean

Returns: void

setNameFilter

▸ setNameFilter(filter: string): void

Parameters:

Name	Type
`filter`	string

Returns: void

setObjectName

▸ setObjectName(objectName: string): void

Inherited from QMenu.setObjectName

Overrides QObject.setObjectName

Parameters:

Name	Type
`objectName`	string

Returns: void

setOption

▸ setOption(option: Option, on: boolean): void

Parameters:

Name	Type	Default
`option`	Option	-
`on`	boolean	true

Returns: void

setOptions

▸ setOptions(options: Option): void

Parameters:

Name	Type
`options`	Option

Returns: void

setParent

▸ setParent(parent: QObject): void

Inherited from QObject.setParent

Parameters:

Name	Type
`parent`	QObject

Returns: void

setProperty

▸ setProperty(name: string, value: QVariantType): boolean

Inherited from QObject.setProperty

Parameters:

Name	Type
`name`	string
`value`	QVariantType

Returns: boolean

setResult

▸ setResult(i: number): void

Inherited from QDialog.setResult

Parameters:

Name	Type
`i`	number

Returns: void

setShortcutAutoRepeat

▸ setShortcutAutoRepeat(id: number, enable: boolean): void

Inherited from QMenu.setShortcutAutoRepeat

Parameters:

Name	Type	Default
`id`	number	-
`enable`	boolean	true

Returns: void

setShortcutEnabled

▸ setShortcutEnabled(id: number, enable: boolean): void

Inherited from QMenu.setShortcutEnabled

Parameters:

Name	Type	Default
`id`	number	-
`enable`	boolean	true

Returns: void

setSizeGripEnabled

▸ setSizeGripEnabled(enabled: boolean): void

Inherited from QDialog.setSizeGripEnabled

Parameters:

Name	Type
`enabled`	boolean

Returns: void

setSizeIncrement

▸ setSizeIncrement(w_or_size: QSize | number, h: number): void

Inherited from QMenu.setSizeIncrement

Parameters:

Name	Type	Default
`w_or_size`	QSize \| number	-
`h`	number	0

Returns: void

setSizePolicy

▸ setSizePolicy(horizontal: QSizePolicyPolicy, vertical: QSizePolicyPolicy): void

Inherited from QMenu.setSizePolicy

Parameters:

Name	Type
`horizontal`	QSizePolicyPolicy
`vertical`	QSizePolicyPolicy

Returns: void

setStatusTip

▸ setStatusTip(statusTip: string): void

Inherited from QMenu.setStatusTip

Parameters:

Name	Type
`statusTip`	string

Returns: void

setStyleSheet

▸ setStyleSheet(styleSheet: string, postprocess: boolean): void

Inherited from QMenu.setStyleSheet

Parameters:

Name	Type	Default
`styleSheet`	string	-
`postprocess`	boolean	true

Returns: void

setSupportedSchemes

▸ setSupportedSchemes(schemes: string[]): void

Parameters:

Name	Type
`schemes`	string[]

Returns: void

setTabletTracking

▸ setTabletTracking(enable: boolean): void

Inherited from QMenu.setTabletTracking

Parameters:

Name	Type
`enable`	boolean

Returns: void

setToolTip

▸ setToolTip(text: string): void

Inherited from QMenu.setToolTip

Parameters:

Name	Type
`text`	string

Returns: void

setToolTipDuration

▸ setToolTipDuration(msec: number): void

Inherited from QMenu.setToolTipDuration

Parameters:

Name	Type
`msec`	number

Returns: void

setUpdatesEnabled

▸ setUpdatesEnabled(enable: boolean): void

Inherited from QMenu.setUpdatesEnabled

Parameters:

Name	Type
`enable`	boolean

Returns: void

setVisible

▸ setVisible(visible: boolean): void

Inherited from QMenu.setVisible

Parameters:

Name	Type
`visible`	boolean

Returns: void

setWhatsThis

▸ setWhatsThis(whatsThis: string): void

Inherited from QMenu.setWhatsThis

Parameters:

Name	Type
`whatsThis`	string

Returns: void

setWindowFilePath

▸ setWindowFilePath(filePath: string): void

Inherited from QMenu.setWindowFilePath

Parameters:

Name	Type
`filePath`	string

Returns: void

setWindowFlag

▸ setWindowFlag(windowType: WindowType, switchOn: boolean): void

Inherited from QMenu.setWindowFlag

Parameters:

Name	Type
`windowType`	WindowType
`switchOn`	boolean

Returns: void

setWindowIcon

▸ setWindowIcon(icon: QIcon): void

Inherited from QMenu.setWindowIcon

Parameters:

Name	Type
`icon`	QIcon

Returns: void

setWindowModified

▸ setWindowModified(modified: boolean): void

Inherited from QMenu.setWindowModified

Parameters:

Name	Type
`modified`	boolean

Returns: void

setWindowOpacity

▸ setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

Name	Type
`opacity`	number

Returns: void

setWindowRole

▸ setWindowRole(role: string): void

Inherited from QMenu.setWindowRole

Parameters:

Name	Type
`role`	string

Returns: void

setWindowState

▸ setWindowState(state: WindowState): void

Inherited from QMenu.setWindowState

Parameters:

Name	Type
`state`	WindowState

Returns: void

setWindowTitle

▸ setWindowTitle(title: string): void

Inherited from QMenu.setWindowTitle

Parameters:

Name	Type
`title`	string

Returns: void

show

▸ show(): void

Inherited from QMenu.show

Returns: void

showFullScreen

▸ showFullScreen(): void

Inherited from QMenu.showFullScreen

Returns: void

showMaximized

▸ showMaximized(): void

Inherited from QMenu.showMaximized

Returns: void

showMinimized

▸ showMinimized(): void

Inherited from QMenu.showMinimized

Returns: void

showNormal

▸ showNormal(): void

Inherited from QMenu.showNormal

Returns: void

size

▸ size(): QSize

Inherited from QMenu.size

Returns: QSize

sizeHint

▸ sizeHint(): QSize

Inherited from QMenu.sizeHint

Returns: QSize

sizeIncrement

▸ sizeIncrement(): QSize

Inherited from QMenu.sizeIncrement

Returns: QSize

stackUnder

▸ stackUnder(w: QWidget): void

Inherited from QMenu.stackUnder

Parameters:

Name	Type
`w`	QWidget

Returns: void

startTimer

▸ startTimer(intervalMS: number, timerType: TimerType): number

Inherited from QObject.startTimer

Parameters:

Name	Type	Default
`intervalMS`	number	-
`timerType`	TimerType	TimerType.CoarseTimer

Returns: number

statusTip

▸ statusTip(): string

Inherited from QMenu.statusTip

Returns: string

style

▸ style(): QStyle

Inherited from QMenu.style

Returns: QStyle

styleSheet

▸ styleSheet(): string

Inherited from QMenu.styleSheet

Returns: string

supportedSchemes

▸ supportedSchemes(): string[]

Returns: string[]

testAttribute

▸ testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

Name	Type
`attribute`	WidgetAttribute

Returns: boolean

▸ toolTip(): string

Inherited from QMenu.toolTip

Returns: string

toolTipDuration

▸ toolTipDuration(): number

Inherited from QMenu.toolTipDuration

Returns: number

underMouse

▸ underMouse(): boolean

Inherited from QMenu.underMouse

Returns: boolean

unsetCursor

▸ unsetCursor(): void

Inherited from QMenu.unsetCursor

Returns: void

unsetLayoutDirection

▸ unsetLayoutDirection(): void

Inherited from QMenu.unsetLayoutDirection

Returns: void

unsetLocale

▸ unsetLocale(): void

Inherited from QMenu.unsetLocale

Returns: void

update

▸ update(): void

Inherited from QMenu.update

Returns: void

updateGeometry

▸ updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void

updateMicroFocus

▸ updateMicroFocus(query: number): void

Inherited from QMenu.updateMicroFocus

Parameters:

Name	Type	Default
`query`	number	InputMethodQuery.ImQueryAll

Returns: void

updatesEnabled

▸ updatesEnabled(): boolean

Inherited from QMenu.updatesEnabled

Returns: boolean

viewMode

▸ viewMode(): ViewMode

Returns: ViewMode

whatsThis

▸ whatsThis(): string

Inherited from QMenu.whatsThis

Returns: string

width

▸ width(): number

Inherited from QMenu.width

Returns: number

widthMM

▸ widthMM(): number

Inherited from QMenu.widthMM

Returns: number

winId

▸ winId(): number

Inherited from QMenu.winId

Returns: number

window

▸ window(): QWidget

Inherited from QMenu.window

Returns: QWidget

windowFilePath

▸ windowFilePath(): string

Inherited from QMenu.windowFilePath

Returns: string

windowHandle

▸ windowHandle(): QWindow | null

Inherited from QMenu.windowHandle

Returns: QWindow | null

windowIcon

▸ windowIcon(): QIcon

Inherited from QMenu.windowIcon

Returns: QIcon

windowOpacity

▸ windowOpacity(): number

Inherited from QMenu.windowOpacity

Returns: number

windowRole

▸ windowRole(): string

Inherited from QMenu.windowRole

Returns: string

windowState

▸ windowState(): WindowState

Inherited from QMenu.windowState

Returns: WindowState

windowTitle

▸ windowTitle(): string

Inherited from QMenu.windowTitle

Returns: string

x

▸ x(): number

Inherited from QMenu.x

Returns: number

y

▸ y(): number

Inherited from QMenu.y

Returns: number

Example​

Hierarchy​

Index​

Constructors​

Properties​

Methods​

Constructors​

constructor​

Properties​

_rawInlineStyle​

native​

type​

Methods​

_id​

accept​

acceptDrops​

acceptMode​

accessibleDescription​

accessibleName​

activateWindow​

addAction​

addEventListener​

adjustSize​

autoFillBackground​

baseSize​

childAt​

children​

childrenRect​

clearFocus​

clearMask​

close​

colorCount​

contentsRect​

contextMenuPolicy​

defaultSuffix​

delete​

deleteLater​

depth​

devicePixelRatio​

devicePixelRatioF​

done​

dumpObjectInfo​

dumpObjectTree​

ensurePolished​

eventProcessed​

exec​

fileMode​

focusProxy​

focusWidget​

font​

frameGeometry​

frameSize​

geometry​

getFlexNode​

grab​

grabKeyboard​

grabMouse​

hasFocus​

hasHeightForWidth​

hasMouseTracking​

hasTabletTracking​

height​

heightForWidth​

heightMM​

hide​

inherits​

inputMethodHints​

isActiveWindow​

isAncestorOf​

isEnabled​

isEnabledTo​

isFullScreen​

isHidden​

isMaximized​

isMinimized​

isModal​

isSizeGripEnabled​

isVisible​

isVisibleTo​

isWindow​

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_rawInlineStyle

native

type

Methods

_id

accept

acceptDrops

acceptMode

accessibleDescription

accessibleName

activateWindow

addAction

addEventListener

adjustSize

autoFillBackground

baseSize

childAt

children

childrenRect

clearFocus

clearMask

close

colorCount

contentsRect

contextMenuPolicy

defaultSuffix

delete

deleteLater

depth

devicePixelRatio

devicePixelRatioF

done

dumpObjectInfo

dumpObjectTree

ensurePolished

eventProcessed

exec

fileMode

focusProxy

focusWidget

font

frameGeometry

frameSize

geometry

getFlexNode

grab

grabKeyboard

grabMouse

hasFocus

hasHeightForWidth

hasMouseTracking

hasTabletTracking

height

heightForWidth

heightMM

hide

inherits

inputMethodHints

isActiveWindow

isAncestorOf

isEnabled

isEnabledTo

isFullScreen

isHidden

isMaximized

isMinimized

isModal

isSizeGripEnabled

isVisible

isVisibleTo

isWindow