Qt Reference Documentation

QML Dialog Element

Provides a top-level window for short-term tasks and brief interaction with the user. More...

Inherited by CommonDialog.

This element was introduced in Qt Quick Components 1.0.

Properties

Signal Handlers

Methods

Detailed Description

A dialog floats on the top layer of the application view, usually overlapping the area reserved for the application content. Normally, a dialog provides information and gives warnings to the user, or asks the user to answer a question or select an option.

There's a derived convenience component called CommonDialog that can be used for most typical dialog use cases with platform-style title and button areas.

Property Documentation

buttons : list<Item>

A list of items in the dialog's button area. For example, you can use Row or Button components but you can also use any number of components that are based on Item component.


content : list<Item>

A list of items in the dialog's content area. You can use any component that is based on Item. For example, you can use ListView, so that the user can select from a list of names.


platformInverted : bool

Symbian:

If platformInverted is true, the component is visualized with the inverted style. For more information, see Using Inverted Style with Symbian Components. By default platformInverted is false.

This property group was introduced in Qt Quick Components 1.1.


status : int

Indicates the dialog's phase in its life cycle. The values are as follows:

  • DialogStatus.Opening - the dialog is opening
  • DialogStatus.Open - the dialog is open and visible to the user
  • DialogStatus.Closing - the dialog is closing
  • DialogStatus.Closed - the dialog is closed and not visible to the user

The dialog's initial status is DialogStatus.Closed.


title : list<Item>

A list of items in the dialog's title area. You can use a Text component but also any number of components that are based on Item. For example, you can use Text and Image components.


visualParent : Item

The item that is dimmed when the dialog opens. By default the root parent object is visualParent.


Signal Handler Documentation

Dialog::accepted ()

This signal is emitted when the user accepts the dialog's request or the accept() method is called.

See also rejected.


Dialog::clickedOutside ()

This signal is emitted when the user taps in the area that is inside the dialog's visual parent area but outside the dialog's area. Normally the visual parent is the root object. In that case this signal is emitted if the user taps anywhere outside the dialog's area.

See also visualParent.


Dialog::rejected ()

This signal is emitted when the user rejects the dialog's request or the reject() method is called.

See also accepted.


Method Documentation

Dialog::accept ()

Accepts the dialog's request without any user interaction. The method emits the accepted signal and closes the dialog.

See also reject().


Dialog::close ()

Closes the dialog without any user interaction.


Dialog::open ()

Shows the dialog to the user.


Dialog::reject ()

Rejects the dialog's request without any user interaction. The method emits the rejected signal and closes the dialog.

See also accept().