RNFileDialog

Hierarchy

• QFileDialog

  ↳ RNFileDialog

Implements

• RNWidget

Index

Constructors

• constructor

Properties

• _layout
• _rawInlineStyle
• actions
• native
• nodeChildren
• nodeParent
• type
• tagName

Accessors

• layout

Methods

• acceptDrops
• acceptMode
• activateWindow
• addAction
• addEventListener
• adjustSize
• appendChild
• appendInitialChild
• clearFocus
• close
• defaultSuffix
• eventProcessed
• exec
• fileMode
• font
• geometry
• getFlexNode
• hasMouseTracking
• hide
• inherits
• insertBefore
• isActiveWindow
• isEnabled
• isSizeGripEnabled
• isVisible
• labelText
• lower
• mapFromGlobal
• mapFromParent
• mapToGlobal
• mapToParent
• maximumSize
• minimumSize
• move
• objectName
• open
• options
• pos
• property
• raise
• reject
• removeAction
• removeChild
• removeEventListener
• repaint
• repolish
• resize
• result
• selectedFiles
• setAcceptDrops
• setAcceptMode
• setAttribute
• setContextMenuPolicy
• setCursor
• setDefaultSuffix
• setEnabled
• setEventProcessed
• setFileMode
• setFixedSize
• setFlexNodeSizeControlled
• setFocus
• setFocusPolicy
• setFont
• setGeometry
• setGraphicsEffect
• setInlineStyle
• setLabelText
• setLayout
• setMaximumSize
• setMinimumSize
• setModal
• setMouseTracking
• setNameFilter
• setNodeParent
• setObjectName
• setOption
• setOptions
• setProperty
• setProps
• 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 RNFileDialog(): RNFileDialog

Inherited from RNFileDialog.constructor

Overrides void

Returns: RNFileDialog

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

Inherited from RNFileDialog.constructor

Overrides void

Parameters:

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

Returns: RNFileDialog

Properties

Optional _layout

• _layout? : NodeLayout‹QFileDialogSignals›

Inherited from void

---

_rawInlineStyle

• _rawInlineStyle: string

Inherited from void

---

actions

• actions: Set‹QAction›

Inherited from void

---

native

• native: NativeElement

Inherited from RNFileDialog.native

Overrides void

---

nodeChildren

• nodeChildren: Set‹Component›

Inherited from RNAction.nodeChildren

---

Optional nodeParent

• nodeParent? : Component

Inherited from RNAction.nodeParent

---

type

• type: string

Inherited from void

---

Static tagName

▪ tagName: string = "file-dialog"

Accessors

layout

• get layout(): NodeLayout‹QFileDialogSignals› | undefined

Inherited from void

Returns: NodeLayout‹QFileDialogSignals› | undefined

• set layout(l: NodeLayout‹QFileDialogSignals› | undefined): any

Inherited from void

Parameters:

Name	Type
l	NodeLayout‹QFileDialogSignals› | undefined

Returns: any

Methods

acceptDrops

▸ acceptDrops(): boolean

Inherited from void

Returns: boolean

---

acceptMode

▸ acceptMode(): AcceptMode

Inherited from RNFileDialog.acceptMode

Returns: AcceptMode

---

activateWindow

▸ activateWindow(): void

Inherited from void

Returns: void

---

addAction

▸ addAction(action: QAction | string): QAction

Inherited from void

Parameters:

Name	Type
action	QAction | string

Returns: QAction

---

addEventListener

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

Inherited from RNAction.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 RNAction.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 void

Returns: void

---

appendChild

▸ appendChild(child: NodeWidget‹any›): void

Parameters:

Name	Type
child	NodeWidget‹any›

Returns: void

---

appendInitialChild

▸ appendInitialChild(child: NodeWidget‹any›): void

Parameters:

Name	Type
child	NodeWidget‹any›

Returns: void

---

clearFocus

▸ clearFocus(): void

Inherited from void

Returns: void

---

close

▸ close(): boolean

Inherited from void

Returns: boolean

---

defaultSuffix

▸ defaultSuffix(): string

Inherited from RNFileDialog.defaultSuffix

Returns: string

---

eventProcessed

▸ eventProcessed(): boolean

Inherited from RNAction.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 RNDialog.exec

Returns: DialogCode

---

fileMode

▸ fileMode(): FileMode

Inherited from RNFileDialog.fileMode

Returns: FileMode

---

font

▸ font(): QFont

Inherited from void

Returns: QFont

---

geometry

▸ geometry(): QRect

Inherited from void

Returns: QRect

---

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from void

Returns: FlexNode

---

hasMouseTracking

▸ hasMouseTracking(): boolean

Inherited from void

Returns: boolean

---

hide

▸ hide(): void

Inherited from void

Returns: void

---

inherits

▸ inherits(className: string): boolean

Inherited from RNAction.inherits

Parameters:

Name	Type
className	string

Returns: boolean

---

insertBefore

▸ insertBefore(child: NodeWidget‹any›, beforeChild: NodeWidget‹any›): void

Parameters:

Name	Type
child	NodeWidget‹any›
beforeChild	NodeWidget‹any›

Returns: void

---

isActiveWindow

▸ isActiveWindow(): boolean

Inherited from void

Returns: boolean

---

isEnabled

▸ isEnabled(): boolean

Inherited from void

Returns: boolean

---

isSizeGripEnabled

▸ isSizeGripEnabled(): boolean

Inherited from RNDialog.isSizeGripEnabled

Returns: boolean

---

isVisible

▸ isVisible(): boolean

Inherited from void

Returns: boolean

---

labelText

▸ labelText(label: DialogLabel): string

Inherited from RNFileDialog.labelText

Parameters:

Name	Type
label	DialogLabel

Returns: string

---

lower

▸ lower(): void

Inherited from void

Returns: void

---

mapFromGlobal

▸ mapFromGlobal(pos: QPoint): QPoint

Inherited from void

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapFromParent

▸ mapFromParent(pos: QPoint): QPoint

Inherited from void

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapToGlobal

▸ mapToGlobal(pos: QPoint): QPoint

Inherited from void

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapToParent

▸ mapToParent(pos: QPoint): QPoint

Inherited from void

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

maximumSize

▸ maximumSize(): QSize

Inherited from void

Returns: QSize

---

minimumSize

▸ minimumSize(): QSize

Inherited from void

Returns: QSize

---

move

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

Inherited from void

Parameters:

Name	Type
x	number
y	number

Returns: void

---

objectName

▸ objectName(): string

Inherited from RNAction.objectName

Returns: string

---

open

▸ open(): void

Inherited from RNDialog.open

Returns: void

---

options

▸ options(): Option

Inherited from RNFileDialog.options

Returns: Option

---

pos

▸ pos(): object

Inherited from void

Returns: object

• x: number

• y: number

---

property

▸ property(name: string): QVariant

Inherited from RNAction.property

Parameters:

Name	Type
name	string

Returns: QVariant

---

raise

▸ raise(): void

Inherited from void

Returns: void

---

reject

▸ reject(): void

Inherited from RNDialog.reject

Returns: void

---

removeAction

▸ removeAction(action: QAction): void

Inherited from void

Parameters:

Name	Type
action	QAction

Returns: void

---

removeChild

▸ removeChild(child: NodeWidget‹any›): void

Parameters:

Name	Type
child	NodeWidget‹any›

Returns: void

---

removeEventListener

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

Inherited from RNAction.removeEventListener

Type parameters:

▪ SignalType: keyof QFileDialogSignals

Parameters:

Name	Type
signalType	SignalType
callback	QFileDialogSignals[SignalType]

Returns: void

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

Inherited from RNAction.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

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

Parameters:

Name	Type
event?	NativeRawPointer‹"QEvent"›

Returns: void

---

repaint

▸ repaint(): void

Inherited from void

Returns: void

---

repolish

▸ repolish(): void

Inherited from void

Returns: void

---

resize

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

Inherited from void

Parameters:

Name	Type
width	number
height	number

Returns: void

---

result

▸ result(): number

Inherited from RNDialog.result

Returns: number

---

selectedFiles

▸ selectedFiles(): string[]

Inherited from RNFileDialog.selectedFiles

Returns: string[]

---

setAcceptDrops

▸ setAcceptDrops(on: boolean): void

Inherited from void

Parameters:

Name	Type
on	boolean

Returns: void

---

setAcceptMode

▸ setAcceptMode(acceptMode: AcceptMode): void

Inherited from RNFileDialog.setAcceptMode

Parameters:

Name	Type
acceptMode	AcceptMode

Returns: void

---

setAttribute

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

Inherited from void

Parameters:

Name	Type
attribute	WidgetAttribute
switchOn	boolean

Returns: void

---

setContextMenuPolicy

▸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from void

Parameters:

Name	Type
contextMenuPolicy	ContextMenuPolicy

Returns: void

---

setCursor

▸ setCursor(cursor: CursorShape | QCursor): void

Inherited from void

Parameters:

Name	Type
cursor	CursorShape | QCursor

Returns: void

---

setDefaultSuffix

▸ setDefaultSuffix(defaultSuffix: string): void

Inherited from RNFileDialog.setDefaultSuffix

Parameters:

Name	Type
defaultSuffix	string

Returns: void

---

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from void

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setEventProcessed

▸ setEventProcessed(isProcessed: boolean): void

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

Inherited from RNFileDialog.setFileMode

Parameters:

Name	Type
fileMode	FileMode

Returns: void

---

setFixedSize

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

Inherited from void

Parameters:

Name	Type
width	number
height	number

Returns: void

---

setFlexNodeSizeControlled

▸ setFlexNodeSizeControlled(isSizeControlled: boolean): void

Inherited from void

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 void

Parameters:

Name	Type
reason?	FocusReason

Returns: void

---

setFocusPolicy

▸ setFocusPolicy(policy: FocusPolicy): void

Inherited from void

Parameters:

Name	Type
policy	FocusPolicy

Returns: void

---

setFont

▸ setFont(font: QFont): void

Inherited from void

Parameters:

Name	Type
font	QFont

Returns: void

---

setGeometry

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

Inherited from void

Parameters:

Name	Type
x	number
y	number
w	number
h	number

Returns: void

---

setGraphicsEffect

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

Inherited from void

Parameters:

Name	Type
effect	QGraphicsEffect‹any›

Returns: void

---

setInlineStyle

▸ setInlineStyle(style: string): void

Inherited from void

Parameters:

Name	Type
style	string

Returns: void

---

setLabelText

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

Inherited from RNFileDialog.setLabelText

Parameters:

Name	Type
label	DialogLabel
text	string

Returns: void

---

setLayout

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

Inherited from void

Parameters:

Name	Type
parentLayout	NodeLayout‹QFileDialogSignals›

Returns: void

---

setMaximumSize

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

Inherited from void

Parameters:

Name	Type
maxw	number
maxh	number

Returns: void

---

setMinimumSize

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

Inherited from void

Parameters:

Name	Type
minw	number
minh	number

Returns: void

---

setModal

▸ setModal(modal: boolean): void

Inherited from RNDialog.setModal

Parameters:

Name	Type
modal	boolean

Returns: void

---

setMouseTracking

▸ setMouseTracking(isMouseTracked: boolean): void

Inherited from void

Parameters:

Name	Type
isMouseTracked	boolean

Returns: void

---

setNameFilter

▸ setNameFilter(filter: string): void

Inherited from RNFileDialog.setNameFilter

Parameters:

Name	Type
filter	string

Returns: void

---

setNodeParent

▸ setNodeParent(parent?: Component): void

Inherited from RNAction.setNodeParent

Parameters:

Name	Type
parent?	Component

Returns: void

---

setObjectName

▸ setObjectName(objectName: string): void

Inherited from void

Overrides RNAction.setObjectName

Parameters:

Name	Type
objectName	string

Returns: void

---

setOption

▸ setOption(option: Option, on?: undefined | false | true): void

Inherited from RNFileDialog.setOption

Parameters:

Name	Type
option	Option
on?	undefined | false | true

Returns: void

---

setOptions

▸ setOptions(options: Option): void

Inherited from RNFileDialog.setOptions

Parameters:

Name	Type
options	Option

Returns: void

---

setProperty

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

Inherited from RNAction.setProperty

Parameters:

Name	Type
name	string
value	QVariantType

Returns: boolean

---

setProps

▸ setProps(newProps: FileDialogProps, oldProps: FileDialogProps): void

Parameters:

Name	Type
newProps	FileDialogProps
oldProps	FileDialogProps

Returns: void

---

setResult

▸ setResult(i: number): void

Inherited from RNDialog.setResult

Parameters:

Name	Type
i	number

Returns: void

---

setSizeGripEnabled

▸ setSizeGripEnabled(enabled: boolean): void

Inherited from RNDialog.setSizeGripEnabled

Parameters:

Name	Type
enabled	boolean

Returns: void

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from void

Parameters:

Name	Type
styleSheet	string

Returns: void

---

setSupportedSchemes

▸ setSupportedSchemes(schemes: string[]): void

Inherited from RNFileDialog.setSupportedSchemes

Parameters:

Name	Type
schemes	string[]

Returns: void

---

setWindowFlag

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

Inherited from void

Parameters:

Name	Type
windowType	WindowType
switchOn	boolean

Returns: void

---

setWindowIcon

▸ setWindowIcon(icon: QIcon): void

Inherited from void

Parameters:

Name	Type
icon	QIcon

Returns: void

---

setWindowOpacity

▸ setWindowOpacity(opacity: number): void

Inherited from void

Parameters:

Name	Type
opacity	number

Returns: void

---

setWindowState

▸ setWindowState(state: WindowState): void

Inherited from void

Parameters:

Name	Type
state	WindowState

Returns: void

---

setWindowTitle

▸ setWindowTitle(title: string): void

Inherited from void

Parameters:

Name	Type
title	string

Returns: void

---

show

▸ show(): void

Inherited from void

Returns: void

---

showFullScreen

▸ showFullScreen(): void

Inherited from void

Returns: void

---

showMaximized

▸ showMaximized(): void

Inherited from void

Returns: void

---

showMinimized

▸ showMinimized(): void

Inherited from void

Returns: void

---

showNormal

▸ showNormal(): void

Inherited from void

Returns: void

---

size

▸ size(): QSize

Inherited from void

Returns: QSize

---

styleSheet

▸ styleSheet(): string

Inherited from void

Returns: string

---

supportedSchemes

▸ supportedSchemes(): string[]

Inherited from RNFileDialog.supportedSchemes

Returns: string[]

---

testAttribute

▸ testAttribute(attribute: WidgetAttribute): boolean

Inherited from void

Parameters:

Name	Type
attribute	WidgetAttribute

Returns: boolean

---

update

▸ update(): void

Inherited from void

Returns: void

---

updateGeometry

▸ updateGeometry(): void

Inherited from void

Returns: void

---

viewMode

▸ viewMode(): ViewMode

Inherited from RNFileDialog.viewMode

Returns: ViewMode

---

windowOpacity

▸ windowOpacity(): number

Inherited from void

Returns: number

---

windowState

▸ windowState(): number

Inherited from void

Returns: number

---

windowTitle

▸ windowTitle(): string

Inherited from void

Returns: string