Sheet Class Reference

Inherits Item.

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

Public Member Functions
void	accept ()
void	close ()
void	open ()
void	reject ()

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

Detailed Description

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

Since

0.1

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 54 of file Sheet.qml.

Member Function Documentation

void 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 Sheet::accepted ( )

signal

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

void 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 Sheet::close

(

)

Closes the dialog without any user interaction.

void Sheet::open

(

)

Shows the dialog to the user.

void 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 Sheet::rejected ( )

signal

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

See also

accepted()

Property Documentation

Button Sheet::acceptButton

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

Definition at line 89 of file Sheet.qml.

alias Sheet::acceptButtonText

Definition at line 81 of file Sheet.qml.

list<Item> 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 67 of file Sheet.qml.

alias Sheet::privateButtonsHeight

Definition at line 98 of file Sheet.qml.

alias Sheet::privateTitleHeight

Definition at line 96 of file Sheet.qml.

Button Sheet::rejectButton

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

Definition at line 94 of file Sheet.qml.

alias Sheet::rejectButtonText

Definition at line 83 of file Sheet.qml.

int 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 79 of file Sheet.qml.

string Sheet::title

The title text of this Sheet.

Definition at line 60 of file Sheet.qml.

---

The documentation for this class was generated from the following file:

• Sheet.qml