MIRA
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
SplashScreen Class Reference

Widget provides a splash screen that can be shown during application startup. More...

#include <widgets/SplashScreen.h>

Inheritance diagram for SplashScreen:
Inheritance graph
[legend]

Public Types

enum  SpecialMode { DUMMY }
 

Public Member Functions

 SplashScreen (SpecialMode mode)
 Creates a disabled dummy SplashScreen, which does nothing. More...
 
 SplashScreen (QWidget *parent, const QPixmap &pixmap)
 
void show ()
 Shows the splash screen. More...
 
void closeTimer (int timeout)
 After calling this method the splash screen will hide automatically after the specified timeout has elapsed. More...
 
void closeOnClick ()
 After this method is called, the user can close the splash screen by clicking on it. More...
 
void clearMessage ()
 
void showMessage (const QString &message, int alignment=Qt::AlignLeft|Qt::AlignTop, const QColor &color=Qt::black)
 
void setTextRect (const QRect &rect)
 

Static Public Member Functions

static void closeSplashScreen ()
 

Protected Member Functions

virtual void mousePressEvent (QMouseEvent *event)
 

Detailed Description

Widget provides a splash screen that can be shown during application startup.

Similar to QSplashScreen, but supports transparent pixmaps. For a documentation of the methods, see QSplashScreen.

Member Enumeration Documentation

◆ SpecialMode

Enumerator
DUMMY 

Constructor & Destructor Documentation

◆ SplashScreen() [1/2]

Creates a disabled dummy SplashScreen, which does nothing.

◆ SplashScreen() [2/2]

SplashScreen ( QWidget *  parent,
const QPixmap &  pixmap 
)

Member Function Documentation

◆ show()

void show ( )

Shows the splash screen.

◆ closeTimer()

void closeTimer ( int  timeout)

After calling this method the splash screen will hide automatically after the specified timeout has elapsed.

◆ closeOnClick()

void closeOnClick ( )

After this method is called, the user can close the splash screen by clicking on it.

(e.g. after startup is finished)

◆ clearMessage()

void clearMessage ( )

◆ showMessage()

void showMessage ( const QString &  message,
int  alignment = Qt::AlignLeft|Qt::AlignTop,
const QColor &  color = Qt::black 
)

◆ setTextRect()

void setTextRect ( const QRect &  rect)

◆ closeSplashScreen()

static void closeSplashScreen ( )
static

◆ mousePressEvent()

virtual void mousePressEvent ( QMouseEvent *  event)
protectedvirtual

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