nodeguy/website/docs/api/generated/classes/qfiledialog.md

id	title	sidebar_label
qfiledialog	QFileDialog	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

↳ NodeDialog‹QFileDialogSignals›

↳ QFileDialog

Index

Constructors

• constructor

Properties

• _rawInlineStyle
• actions
• layout
• native
• nodeChildren
• nodeParent
• type

Methods

• acceptMode
• activateWindow
• addAction
• addEventListener
• adjustSize
• close
• defaultSuffix
• exec
• fileMode
• font
• geometry
• getFlexNode
• hasMouseTracking
• hide
• inherits
• isEnabled
• isSizeGripEnabled
• isVisible
• labelText
• lower
• mapFromGlobal
• mapFromParent
• mapToGlobal
• mapToParent
• maximumSize
• minimumSize
• move
• objectName
• open
• options
• pos
• property
• raise
• reject
• removeAction
• removeEventListener
• repaint
• repolish
• resize
• result
• selectedFiles
• setAcceptMode
• setAttribute
• setContextMenuPolicy
• setCursor
• setDefaultSuffix
• setEnabled
• setFileMode
• setFixedSize
• setFlexNodeSizeControlled
• setFont
• setGeometry
• setGraphicsEffect
• setInlineStyle
• setLabelText
• setLayout
• setMaximumSize
• setMinimumSize
• setModal
• setMouseTracking
• setNameFilter
• setNodeParent
• setObjectName
• setOption
• setOptions
• setProperty
• setResult
• setSizeGripEnabled
• setStyleSheet
• setSupportedSchemes
• setWindowFlag
• setWindowIcon
• setWindowOpacity
• setWindowState
• setWindowTitle
• show
• showFullScreen
• showMaximized
• showMinimized
• showNormal
• size
• styleSheet
• supportedSchemes
• testAttribute
• update
• updateGeometry
• viewMode
• windowOpacity
• windowState
• windowTitle

Constructors

constructor

+ new QFileDialog(): QFileDialog

Overrides NodeWidget.constructor

Returns: QFileDialog

+ new QFileDialog(parent: NodeWidget‹any›, caption?: undefined | string, directory?: undefined | string, filter?: undefined | string): QFileDialog

Overrides NodeWidget.constructor

Parameters:

Name	Type
parent	NodeWidget‹any›
caption?	undefined | string
directory?	undefined | string
filter?	undefined | string

Returns: QFileDialog

Properties

_rawInlineStyle

• _rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle

---

actions

• actions: Set‹QAction›

Inherited from QMenu.actions

---

Optional layout

• layout? : NodeLayout‹QFileDialogSignals›

Inherited from QMenu.layout

---

native

• native: NativeElement

Overrides Component.native

---

nodeChildren

• nodeChildren: Set‹Component›

Inherited from Component.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from Component.nodeParent

---

type

• type: string = "widget"

Inherited from QMenu.type

Methods

acceptMode

▸ acceptMode(): AcceptMode

Returns: AcceptMode

---

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]): 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

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): void

Inherited from EventWidget.addEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

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

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

adjustSize

▸ adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void

---

close

▸ close(): boolean

Inherited from QMenu.close

Returns: boolean

---

defaultSuffix

▸ defaultSuffix(): string

Returns: string

---

exec

▸ exec(): DialogCode

Inherited from NodeDialog.exec

Returns: DialogCode

---

fileMode

▸ fileMode(): FileMode

Returns: FileMode

---

font

▸ font(): QFont

Inherited from QMenu.font

Returns: QFont

---

geometry

▸ geometry(): QRect

Inherited from QMenu.geometry

Returns: QRect

---

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode

---

hasMouseTracking

▸ hasMouseTracking(): boolean

Inherited from QMenu.hasMouseTracking

Returns: boolean

---

hide

▸ hide(): void

Inherited from QMenu.hide

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

isEnabled

▸ isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean

---

isSizeGripEnabled

▸ isSizeGripEnabled(): boolean

Inherited from NodeDialog.isSizeGripEnabled

Returns: boolean

---

isVisible

▸ isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean

---

labelText

▸ labelText(label: DialogLabel): string

Parameters:

Name	Type
label	DialogLabel

Returns: string

---

lower

▸ lower(): void

Inherited from QMenu.lower

Returns: void

---

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

---

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

---

maximumSize

▸ maximumSize(): QSize

Inherited from QMenu.maximumSize

Returns: QSize

---

minimumSize

▸ minimumSize(): QSize

Inherited from QMenu.minimumSize

Returns: QSize

---

move

▸ move(x: number, y: number): void

Inherited from QMenu.move

Parameters:

Name	Type
x	number
y	number

Returns: void

---

objectName

▸ objectName(): string

Inherited from NodeObject.objectName

Returns: string

---

open

▸ open(): void

Inherited from NodeDialog.open

Returns: void

---

options

▸ options(): Option

Returns: Option

---

pos

▸ pos(): object

Inherited from QMenu.pos

Returns: object

• x: number

• y: number

---

property

▸ property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

Name	Type
name	string

Returns: QVariant

---

raise

▸ raise(): void

Inherited from QMenu.raise

Returns: void

---

reject

▸ reject(): void

Inherited from NodeDialog.reject

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]): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QFileDialogSignals

Parameters:

Name	Type
signalType	SignalType
callback	QFileDialogSignals[SignalType]

Returns: void

▸ removeEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

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

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

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 NodeDialog.result

Returns: number

---

selectedFiles

▸ selectedFiles(): string[]

Returns: string[]

---

setAcceptMode

▸ setAcceptMode(acceptMode: AcceptMode): void

Parameters:

Name	Type
acceptMode	AcceptMode

Returns: void

---

setAttribute

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

Inherited from QMenu.setAttribute

Parameters:

Name	Type
attribute	WidgetAttribute
switchOn	boolean

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

---

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setFileMode

▸ setFileMode(fileMode: FileMode): void

Parameters:

Name	Type
fileMode	FileMode

Returns: void

---

setFixedSize

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

Inherited from QMenu.setFixedSize

Parameters:

Name	Type
width	number
height	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

---

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

---

setInlineStyle

▸ setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

Name	Type
style	string

Returns: void

---

setLabelText

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

Parameters:

Name	Type
label	DialogLabel
text	string

Returns: void

---

setLayout

▸ setLayout(parentLayout: NodeLayout‹QFileDialogSignals›): void

Inherited from QMenu.setLayout

Parameters:

Name	Type
parentLayout	NodeLayout‹QFileDialogSignals›

Returns: void

---

setMaximumSize

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

Inherited from QMenu.setMaximumSize

Parameters:

Name	Type
maxw	number
maxh	number

Returns: void

---

setMinimumSize

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

Inherited from QMenu.setMinimumSize

Parameters:

Name	Type
minw	number
minh	number

Returns: void

---

setModal

▸ setModal(modal: boolean): void

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

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setObjectName

▸ setObjectName(objectName: string): void

Inherited from QMenu.setObjectName

Overrides NodeObject.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

---

setProperty

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

Inherited from NodeObject.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setResult

▸ setResult(i: number): void

Inherited from NodeDialog.setResult

Parameters:

Name	Type
i	number

Returns: void

---

setSizeGripEnabled

▸ setSizeGripEnabled(enabled: boolean): void

Inherited from NodeDialog.setSizeGripEnabled

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

Name	Type
styleSheet	string

Returns: void

---

setSupportedSchemes

▸ setSupportedSchemes(schemes: string[]): void

Parameters:

Name	Type
schemes	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

---

setWindowOpacity

▸ setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

Name	Type
opacity	number

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

---

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

---

update

▸ update(): void

Inherited from QMenu.update

Returns: void

---

updateGeometry

▸ updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void

---

viewMode

▸ viewMode(): ViewMode

Returns: ViewMode

---

windowOpacity

▸ windowOpacity(): number

Inherited from QMenu.windowOpacity

Returns: number

---

windowState

▸ windowState(): number

Inherited from QMenu.windowState

Returns: number

---

windowTitle

▸ windowTitle(): string

Inherited from QMenu.windowTitle

Returns: string