Open-Typer
Open source typewriting tutor program
Loading...
Searching...
No Matches
DialogView Class Reference

The DialogView class is a native dialog for QML. More...

#include "framework/uicomponents/view/DialogView.h"

Inheritance diagram for DialogView:
Collaboration diagram for DialogView:

Signals

void contentItemChanged ()
 
void visibleChanged ()
 
void titleChanged ()
 
void modalChanged ()
 
void minimumWidthChanged ()
 
void minimumHeightChanged ()
 
void maximumWidthChanged ()
 
void maximumHeightChanged ()
 
void autoCloseChanged ()
 
void closableChanged ()
 
void activeFocusItemChanged ()
 

Public Member Functions

 DialogView (QObject *parent=nullptr)
 
QQuickItem * contentItem () const
 
void setContentItem (QQuickItem *newContentItem)
 
bool visible () const
 
void setVisible (bool newVisible)
 
QString title () const
 
void setTitle (const QString &newTitle)
 
bool modal () const
 
void setModal (bool newModal)
 
int minimumWidth () const
 
void setMinimumWidth (int newMinimumWidth)
 
int minimumHeight () const
 
void setMinimumHeight (int newMinimumHeight)
 
int maximumWidth () const
 
void setMaximumWidth (int newMaximumWidth)
 
int maximumHeight () const
 
void setMaximumHeight (int newMaximumHeight)
 
Q_INVOKABLE void setMaximizedState ()
 
Q_INVOKABLE void setNormalState ()
 
Q_INVOKABLE void showMaximized ()
 
Q_INVOKABLE void showNormal ()
 
bool autoClose () const
 
void setAutoClose (bool newAutoClose)
 
bool closable () const
 
void setClosable (bool newClosable)
 
QQuickItem * activeFocusItem () const
 

Properties

QQuickItem * contentItem
 
bool visible
 
QString title
 
bool modal
 
int minimumWidth
 
int minimumHeight
 
int maximumWidth
 
int maximumHeight
 
bool autoClose
 
bool closable
 
QQuickItem * activeFocusItem
 

Private Attributes

QuickWindow m_window
 
QQuickItem * m_contentItem
 
bool m_modal = true
 

Detailed Description

The DialogView class is a native dialog for QML.

Constructor & Destructor Documentation

◆ DialogView()

DialogView::DialogView ( QObject *  parent = nullptr)
explicit

Constructs DialogView.

Member Function Documentation

◆ activeFocusItem()

QQuickItem * DialogView::activeFocusItem ( ) const

The currently active focus item.

Since
Open-Typer 5.1.1

◆ autoClose()

bool DialogView::autoClose ( ) const

Whether to close the dialog when escape is pressed.

◆ closable()

bool DialogView::closable ( ) const

Whether to allow closing the dialog using the close button or escape key when autoClose is true.

◆ contentItem()

QQuickItem * DialogView::contentItem ( ) const

The root item of the dialog.

◆ maximumHeight()

int DialogView::maximumHeight ( ) const

The maximum height of the dialog.

◆ maximumWidth()

int DialogView::maximumWidth ( ) const

The maximum width of the dialog.

◆ minimumHeight()

int DialogView::minimumHeight ( ) const

The minimum height of the dialog.

◆ minimumWidth()

int DialogView::minimumWidth ( ) const

The minimum width of the dialog.

◆ modal()

bool DialogView::modal ( ) const

Whether the dialog is modal. True by default.

◆ setMaximizedState()

void DialogView::setMaximizedState ( )

Sets the state to maximized.

◆ setNormalState()

void DialogView::setNormalState ( )

Sets the state to normal, i.e. neither maximized, minimized, nor fullscreen.

◆ showMaximized()

void DialogView::showMaximized ( )

Shows the dialog as maximized.

◆ showNormal()

void DialogView::showNormal ( )

Shows the dialog as normal, i.e. neither maximized, minimized, nor fullscreen.

◆ title()

QString DialogView::title ( ) const

The title of the dialog.

◆ visible()

bool DialogView::visible ( ) const

Whether the dialog is visible.


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