InputDialog

Search for usage in LXR

InputDialog Class Reference
Inheritance diagram for InputDialog:

Properties

alias textEntry
 
- Properties inherited from InfoDialog
alias content
 
alias message
 
alias template
 
- Properties inherited from Dialog
real absoluteMaximumHeight
 
real absoluteMaximumWidth
 
listTAction customFooterActions
 
alias dialogChildren
 
alias dialogData
 
bool flatFooterButtons
 
Component footerLeadingComponent
 
Component footerTrailingComponent
 
real maximumHeight
 
real maximumWidth
 
real preferredHeight
 
real preferredWidth
 
bool showCloseButton
 

Signals

void finished (string text)
 

Additional Inherited Members

- Public Member Functions inherited from InfoDialog
void alert (message, level)
 
- Public Member Functions inherited from QtQuick.Controls.Dialog
void accept ()
 
 accepted ()
 
 applied ()
 
 discarded ()
 
void done (int result)
 
 helpRequested ()
 
void reject ()
 
 rejected ()
 
 reset ()
 
AbstractButton standardButton (StandardButton button)
 

Detailed Description

An InfoDialog with a text entry field.

This control inherits from MauiKit InfoDialog, to checkout its inherited properties refer to docs.

This dialog can have information labels and icon/image, any number of children, and more. Refer to the structure of the Info Dialog.

See also
InfoDialog::structure Structure
Maui.InputDialog
{
id: _dialog
title: "Hello"
message: "An input dialog that request some information ot be entered."
template.iconSource: "dialog-question"
textEntry.placeholderText: "Give me a name."
onRejected: close()
onFinished: (text) => console.log(text)
}
alias message
The message body.
alias textEntry
An alias to acces the entry field handled by a QQC2 TextField control.

You can find a more complete example at this link.

Definition at line 33 of file InputDialog.qml.

Property Documentation

◆ textEntry

alias InputDialog::textEntry
read

An alias to acces the entry field handled by a QQC2 TextField control.

Note
See Qt documentation on TextField for further information on its properties.

Definition at line 40 of file InputDialog.qml.

Member Function Documentation

◆ finished

void InputDialog::finished ( string text)
signal

Emitted when the dialog has been accepted.

This will depend on keeping the standardButtons as they are, or setting one that triggers the accepted role.

Note
For more information on the standard buttons ad their roles, checkout Qt Dialog docs.
Parameters
Thetext entered in the text entry field.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 12:00:22 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.