org::kde::plasma::components::Sheet

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

Properties

Button acceptButton
 
alias acceptButtonText
 
list< Item > content
 
alias privateButtonsHeight
 
alias privateTitleHeight
 
Button rejectButton
 
alias rejectButtonText
 
int status
 
string title
 

Signals

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

Public Member Functions

void accept ()
 
void close ()
 
void open ()
 
void reject ()
 
- 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

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

Since
2.0

It is intended to be used for interaction more complex and bigger in size than Dialog. On the desktop its looks is almost identical to Dialog, on touch interfaces it is an almost fullscreen sliding Sheet. It is provided mostly for compatibility with mobile implementations.

Definition at line 57 of file Sheet.qml.

Property Documentation

Button org::kde::plasma::components::Sheet::acceptButton

button that when pressed will close the dialog, representing the user accepting it, accepted() will be called

Definition at line 92 of file Sheet.qml.

list<Item> org::kde::plasma::components::Sheet::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 70 of file Sheet.qml.

Button org::kde::plasma::components::Sheet::rejectButton

button that when pressed will close the dialog, representing the user rejecting it, rejected() will be called

Definition at line 97 of file Sheet.qml.

int org::kde::plasma::components::Sheet::status

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.

Definition at line 82 of file Sheet.qml.

string org::kde::plasma::components::Sheet::title

The title text of this Sheet.

Definition at line 63 of file Sheet.qml.

Member Function Documentation

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

Accepts the dialog's request without any user interaction.

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

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

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

void org::kde::plasma::components::Sheet::clickedOutside ( )
signal

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.

void org::kde::plasma::components::Sheet::close ( )

Closes the dialog without any user interaction.

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

Shows the dialog to the user.

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

Rejects the dialog's request without any user interaction.

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

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

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 Tue Aug 4 2020 22:40:27 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.