QInputDialog

Create and control input modal dialogs.

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

Example

import { QInputDialog } from '@nodegui/nodegui';
const dialog = new QInputDialog();
dialog.setLabelText('Click that Ok button');
dialog.exec();

Hierarchy

NodeDialogQInputDialogSignals

QInputDialog

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

+ new QInputDialog(): QInputDialog

Overrides NodeFrame.constructor

Returns: QInputDialog

+ new QInputDialog(parent: NodeWidget‹any›): QInputDialog

Overrides NodeFrame.constructor

Parameters:

NameType
parentNodeWidget‹any›

Returns: QInputDialog

Properties

Optional _layout

_layout? : NodeLayoutQInputDialogSignals

Inherited from QMenu._layout


_rawInlineStyle

_rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle


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

Accessors

layout

get layout(): NodeLayoutQInputDialogSignals› | undefined

Inherited from QMenu.layout

Returns: NodeLayoutQInputDialogSignals› | undefined

set layout(l: NodeLayoutQInputDialogSignals› | undefined): void

Inherited from QMenu.layout

Parameters:

NameType
lNodeLayoutQInputDialogSignals› | undefined

Returns: void

Methods

acceptDrops

acceptDrops(): boolean

Inherited from QMenu.acceptDrops

Returns: boolean


activateWindow

activateWindow(): void

Inherited from QMenu.activateWindow

Returns: void


addAction

addAction(action: QAction | string): QAction

Inherited from QMenu.addAction

Parameters:

NameType
actionQAction | string

Returns: QAction


addEventListener

addEventListenerSignalType›(signalType: SignalType, callback: QInputDialogSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QInputDialogSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackQInputDialogSignals[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:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


adjustSize

adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void


cancelButtonText

cancelButtonText(): string

Returns: string


clearFocus

clearFocus(): void

Inherited from QMenu.clearFocus

Returns: void


close

close(): boolean

Inherited from QMenu.close

Returns: boolean


doubleDecimals

doubleDecimals(): number

Returns: number


doubleMaximum

doubleMaximum(): number

Returns: number


doubleMinimum

doubleMinimum(): number

Returns: number


doubleStep

doubleStep(): number

Returns: number


doubleValue

doubleValue(): number

Returns: number


dumpObjectInfo

dumpObjectInfo(): void

Inherited from NodeObject.dumpObjectInfo

Returns: void


dumpObjectTree

dumpObjectTree(): void

Inherited from NodeObject.dumpObjectTree

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

Returns: DialogCode


font

font(): QFont

Inherited from QMenu.font

Returns: QFont


frameGeometry

frameGeometry(): QRect

Inherited from QMenu.frameGeometry

Returns: QRect


geometry

geometry(): QRect

Inherited from QMenu.geometry

Returns: QRect


getFlexNode

getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode


hasFocus

hasFocus(): boolean

Inherited from QMenu.hasFocus

Returns: boolean


hasMouseTracking

hasMouseTracking(): boolean

Inherited from QMenu.hasMouseTracking

Returns: boolean


height

height(): number

Inherited from QMenu.height

Returns: number


hide

hide(): void

Inherited from QMenu.hide

Returns: void


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


inputMode

inputMode(): InputMode

Returns: InputMode


intMaximum

intMaximum(): number

Returns: number


intMinimum

intMinimum(): number

Returns: number


intStep

intStep(): number

Returns: number


intValue

intValue(): number

Returns: number


isActiveWindow

isActiveWindow(): boolean

Inherited from QMenu.isActiveWindow

Returns: boolean


isComboBoxEditable

isComboBoxEditable(): boolean

Returns: boolean


isEnabled

isEnabled(): boolean

Inherited from QMenu.isEnabled

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

Returns: boolean


isVisible

isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean


isWindow

isWindow(): boolean

Inherited from QMenu.isWindow

Returns: boolean


isWindowModified

isWindowModified(): boolean

Inherited from QMenu.isWindowModified

Returns: boolean


labelText

labelText(): string

Returns: string


lower

lower(): void

Inherited from QMenu.lower

Returns: void


mapFromGlobal

mapFromGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapFromGlobal

Parameters:

NameType
posQPoint

Returns: QPoint


mapFromParent

mapFromParent(pos: QPoint): QPoint

Inherited from QMenu.mapFromParent

Parameters:

NameType
posQPoint

Returns: QPoint


mapToGlobal

mapToGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapToGlobal

Parameters:

NameType
posQPoint

Returns: QPoint


mapToParent

mapToParent(pos: QPoint): QPoint

Inherited from QMenu.mapToParent

Parameters:

NameType
posQPoint

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:

NameType
xnumber
ynumber

Returns: void


objectName

objectName(): string

Inherited from NodeObject.objectName

Returns: string


okButtonText

okButtonText(): string

Returns: string


open

open(): void

Inherited from NodeDialog.open

Returns: void


options

options(): InputDialogOptions

Returns: InputDialogOptions


pos

pos(): object

Inherited from QMenu.pos

Returns: object

  • x: number

  • y: number


property

property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

NameType
namestring

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:

NameType
actionQAction

Returns: void


removeEventListener

removeEventListenerSignalType›(signalType: SignalType, callback: QInputDialogSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QInputDialogSignals

Parameters:

NameType
signalTypeSignalType
callbackQInputDialogSignals[SignalType]

Returns: void

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

Inherited from EventWidget.removeEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

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

Parameters:

NameType
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:

NameType
widthnumber
heightnumber

Returns: void


result

result(): number

Inherited from NodeDialog.result

Returns: number


setAcceptDrops

setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

NameType
onboolean

Returns: void


setAttribute

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

Inherited from QMenu.setAttribute

Parameters:

NameType
attributeWidgetAttribute
switchOnboolean

Returns: void


setCancelButtonText

setCancelButtonText(text: string): void

Parameters:

NameType
textstring

Returns: void


setComboBoxEditable

setComboBoxEditable(editable: boolean): void

Parameters:

NameType
editableboolean

Returns: void


setContextMenuPolicy

setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

NameType
contextMenuPolicyContextMenuPolicy

Returns: void


setCursor

setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

NameType
cursorCursorShape | QCursor

Returns: void


setDisabled

setDisabled(disable: boolean): void

Inherited from QMenu.setDisabled

Parameters:

NameType
disableboolean

Returns: void


setDoubleDecimals

setDoubleDecimals(decimals: number): void

Parameters:

NameType
decimalsnumber

Returns: void


setDoubleMaximum

setDoubleMaximum(value: number): void

Parameters:

NameType
valuenumber

Returns: void


setDoubleMinimum

setDoubleMinimum(value: number): void

Parameters:

NameType
valuenumber

Returns: void


setDoubleStep

setDoubleStep(value: number): void

Parameters:

NameType
valuenumber

Returns: void


setDoubleValue

setDoubleValue(value: number): void

Parameters:

NameType
valuenumber

Returns: void


setEnabled

setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

NameType
enabledboolean

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:

NameTypeDescription
isProcessedbooleantrue if the event has been processed.

Returns: void


setFixedSize

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

Inherited from QMenu.setFixedSize

Parameters:

NameType
widthnumber
heightnumber

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:

NameTypeDescription
isSizeControlledboolean

Returns: void


setFocus

setFocus(reason: FocusReason): void

Inherited from QMenu.setFocus

Parameters:

NameTypeDefault
reasonFocusReasonFocusReason.OtherFocusReason

Returns: void


setFocusPolicy

setFocusPolicy(policy: FocusPolicy): void

Inherited from QMenu.setFocusPolicy

Parameters:

NameType
policyFocusPolicy

Returns: void


setFont

setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

NameType
fontQFont

Returns: void


setGeometry

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

Inherited from QMenu.setGeometry

Parameters:

NameType
xnumber
ynumber
wnumber
hnumber

Returns: void


setGraphicsEffect

setGraphicsEffect(effect: QGraphicsEffect‹any›): void

Inherited from QMenu.setGraphicsEffect

Parameters:

NameType
effectQGraphicsEffect‹any›

Returns: void


setHidden

setHidden(hidden: boolean): void

Inherited from QMenu.setHidden

Parameters:

NameType
hiddenboolean

Returns: void


setInlineStyle

setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

NameType
stylestring

Returns: void


setInputMode

setInputMode(value: InputMode): void

Parameters:

NameType
valueInputMode

Returns: void


setIntMaximum

setIntMaximum(value: number): void

Parameters:

NameType
valuenumber

Returns: void


setIntMinimum

setIntMinimum(value: number): void

Parameters:

NameType
valuenumber

Returns: void


setIntStep

setIntStep(value: number): void

Parameters:

NameType
valuenumber

Returns: void


setIntValue

setIntValue(value: number): void

Parameters:

NameType
valuenumber

Returns: void


setLabelText

setLabelText(value: string): void

Parameters:

NameType
valuestring

Returns: void


setLayout

setLayout(parentLayout: NodeLayoutQInputDialogSignals›): void

Inherited from QMenu.setLayout

Parameters:

NameType
parentLayoutNodeLayoutQInputDialogSignals

Returns: void


setMaximumHeight

setMaximumHeight(maxh: number): void

Inherited from QMenu.setMaximumHeight

Parameters:

NameType
maxhnumber

Returns: void


setMaximumSize

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

Inherited from QMenu.setMaximumSize

Parameters:

NameType
maxwnumber
maxhnumber

Returns: void


setMaximumWidth

setMaximumWidth(maxw: number): void

Inherited from QMenu.setMaximumWidth

Parameters:

NameType
maxwnumber

Returns: void


setMinimumHeight

setMinimumHeight(minh: number): void

Inherited from QMenu.setMinimumHeight

Parameters:

NameType
minhnumber

Returns: void


setMinimumSize

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

Inherited from QMenu.setMinimumSize

Parameters:

NameType
minwnumber
minhnumber

Returns: void


setMinimumWidth

setMinimumWidth(minw: number): void

Inherited from QMenu.setMinimumWidth

Parameters:

NameType
minwnumber

Returns: void


setModal

setModal(modal: boolean): void

Inherited from NodeDialog.setModal

Parameters:

NameType
modalboolean

Returns: void


setMouseTracking

setMouseTracking(isMouseTracked: boolean): void

Inherited from QMenu.setMouseTracking

Parameters:

NameType
isMouseTrackedboolean

Returns: void


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

NameType
parent?Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from QMenu.setObjectName

Overrides NodeObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setOkButtonText

setOkButtonText(value: string): void

Parameters:

NameType
valuestring

Returns: void


setOptions

setOptions(value: InputDialogOptions): void

Parameters:

NameType
valueInputDialogOptions

Returns: void


setProperty

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

Inherited from NodeObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


setResult

setResult(i: number): void

Inherited from NodeDialog.setResult

Parameters:

NameType
inumber

Returns: void


setSizeGripEnabled

setSizeGripEnabled(enabled: boolean): void

Inherited from NodeDialog.setSizeGripEnabled

Parameters:

NameType
enabledboolean

Returns: void


setSizePolicy

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

Inherited from QMenu.setSizePolicy

Parameters:

NameType
horizontalQSizePolicyPolicy
verticalQSizePolicyPolicy

Returns: void


setStyleSheet

setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

NameType
styleSheetstring

Returns: void


setTextEchoMode

setTextEchoMode(value: EchoMode): void

Parameters:

NameType
valueEchoMode

Returns: void


setTextValue

setTextValue(value: string): void

Parameters:

NameType
valuestring

Returns: void


setVisible

setVisible(visible: boolean): void

Inherited from QMenu.setVisible

Parameters:

NameType
visibleboolean

Returns: void


setWindowFlag

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

Inherited from QMenu.setWindowFlag

Parameters:

NameType
windowTypeWindowType
switchOnboolean

Returns: void


setWindowIcon

setWindowIcon(icon: QIcon): void

Inherited from QMenu.setWindowIcon

Parameters:

NameType
iconQIcon

Returns: void


setWindowModified

setWindowModified(modified: boolean): void

Inherited from QMenu.setWindowModified

Parameters:

NameType
modifiedboolean

Returns: void


setWindowOpacity

setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

NameType
opacitynumber

Returns: void


setWindowState

setWindowState(state: WindowState): void

Inherited from QMenu.setWindowState

Parameters:

NameType
stateWindowState

Returns: void


setWindowTitle

setWindowTitle(title: string): void

Inherited from QMenu.setWindowTitle

Parameters:

NameType
titlestring

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


style

style(): QStyle

Inherited from QMenu.style

Returns: QStyle


styleSheet

styleSheet(): string

Inherited from QMenu.styleSheet

Returns: string


testAttribute

testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

NameType
attributeWidgetAttribute

Returns: boolean


textEchoMode

textEchoMode(): EchoMode

Returns: EchoMode


textValue

textValue(): string

Returns: string


update

update(): void

Inherited from QMenu.update

Returns: void


updateGeometry

updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void


width

width(): number

Inherited from QMenu.width

Returns: number


windowHandle

windowHandle(): QWindow | null

Inherited from QMenu.windowHandle

Returns: QWindow | null


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


x

x(): number

Inherited from QMenu.x

Returns: number


y

y(): number

Inherited from QMenu.y

Returns: number