org::kde::plasma::components::Dialog

org::kde::plasma::components::Dialog Class Reference
Inheritance diagram for org::kde::plasma::components::Dialog:

Properties

list< Item > buttons
 
list< Item > content
 
bool hideOnWindowDeactivate
 
int location
 
alias privateButtonsHeight
 
alias privateTitleHeight
 
int status
 
list< Item > title
 
Item visualParent
 

Signals

void accepted ()
 
void clickedOutside ()
 
void rejected ()
 

Public Member Functions

void accept ()
 
void close ()
 
void open ()
 
void reject ()
 
void showObj (o)
 
- Public Member Functions inherited from QtQuick.Item
 childAt (x, real y)
 
bool contains (point)
 
 forceActiveFocus ()
 
 forceActiveFocus (reason)
 
bool grabToImage (callback, targetSize)
 
object mapFromGlobal (x, real y)
 
object mapFromItem (item, point p)
 
object mapFromItem (item, rect r)
 
object mapFromItem (item, real x, real y)
 
object mapFromItem (item, real x, real y, real width, real height)
 
object mapToGlobal (x, real y)
 
object mapToItem (item, rect r)
 
object mapToItem (item, real x, real y)
 
object mapToItem (item, point p)
 
object mapToItem (item, real x, real y, real width, real height)
 
 nextItemInFocusChain (forward)
 

Detailed Description

Top-level window for short-term tasks and brief interaction with the user.

Since
2.0A 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.

Definition at line 24 of file qml/Dialog.qml.

Property Documentation

list<Item> org::kde::plasma::components::Dialog::buttons

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.

Definition at line 43 of file qml/Dialog.qml.

list<Item> org::kde::plasma::components::Dialog::content

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.

Definition at line 37 of file qml/Dialog.qml.

bool org::kde::plasma::components::Dialog::hideOnWindowDeactivate

Hide dialog when focus is lost.

Definition at line 71 of file qml/Dialog.qml.

int org::kde::plasma::components::Dialog::location

Hint on where to display the dialog in relation to visualParent.

Definition at line 67 of file qml/Dialog.qml.

int org::kde::plasma::components::Dialog::status

Indicates the dialog's phase in its life cycle.

The values are as follows:

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

The dialog's initial status is PlasmaComponents.DialogStatus.Closed.

Definition at line 59 of file qml/Dialog.qml.

list<Item> org::kde::plasma::components::Dialog::title

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.

Definition at line 31 of file qml/Dialog.qml.

Item org::kde::plasma::components::Dialog::visualParent

The item that the dialog refers to.

The dialog will usually be positioned relative to VisualParent

Definition at line 48 of file qml/Dialog.qml.

Member Function Documentation

void org::kde::plasma::components::Dialog::accept ( )

Accepts the dialog's request without any user interaction.

The method emits the accepted() signal and closes the internalLoader.dialog.

See also
reject()
void org::kde::plasma::components::Dialog::accepted ( )
signal

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

See also
rejected()
void org::kde::plasma::components::Dialog::clickedOutside ( )
signal

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
void org::kde::plasma::components::Dialog::close ( )

Closes the dialog without any user interaction.

void org::kde::plasma::components::Dialog::open ( )

Shows the dialog to the user.

void org::kde::plasma::components::Dialog::reject ( )

Rejects the dialog's request without any user interaction.

The method emits the rejected() signal and closes the internalLoader.dialog.

See also
accept()
void org::kde::plasma::components::Dialog::rejected ( )
signal

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

See also
accepted()

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Sep 20 2020 22:40:38 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.