Home · All Classes · Modules

QSplashScreen Class Reference
[QtGui module]

The QSplashScreen widget provides a splash screen that can be shown during application startup. More...

Inherits QWidget.

Methods

Qt Signals


Detailed Description

The QSplashScreen widget provides a splash screen that can be shown during application startup.

A splash screen is a widget that is usually displayed when an application is being started. Splash screens are often used for applications that have long start up times (e.g. database or networking applications that take time to establish connections) to provide the user with feedback that the application is loading.

The splash screen appears in the center of the screen. It may be useful to add the Qt.WindowStaysOnTopHint to the splash widget's window flags if you want to keep it above all the other windows on the desktop.

Some X11 window managers do not support the "stays on top" flag. A solution is to set up a timer that periodically calls raise_() on the splash screen to simulate the "stays on top" effect.

The most common usage is to show a splash screen before the main widget is displayed on the screen. This is illustrated in the following code snippet in which a splash screen is displayed and some initialization tasks are performed before the application's main window is shown:

 int main(int argc, char *argv[])
 {
     QApplication app(argc, argv);
     QPixmap pixmap(":/splash.png");
     QSplashScreen splash(pixmap);
     splash.show();
     app.processEvents();
     ...
     QMainWindow window;
     window.show();
     splash.finish(&window);
     return app.exec();
 }

The user can hide the splash screen by clicking on it with the mouse. Since the splash screen is typically displayed before the event loop has started running, it is necessary to periodically call QApplication.processEvents() to receive the mouse clicks.

It is sometimes useful to update the splash screen with messages, for example, announcing connections established or modules loaded as the application starts up:

 QPixmap pixmap(":/splash.png");
 QSplashScreen *splash = new QSplashScreen(pixmap);
 splash->show();

 ... // Loading some items
 splash->showMessage("Loaded modules");

 qApp->processEvents();

 ... // Establishing connections
 splash->showMessage("Established connections");

 qApp->processEvents();

QSplashScreen supports this with the showMessage() function. If you wish to do your own drawing you can get a pointer to the pixmap used in the splash screen with pixmap(). Alternatively, you can subclass QSplashScreen and reimplement drawContents().


Method Documentation

QSplashScreen.__init__ (self, QPixmap pixmap = QPixmap(), Qt.WindowFlags flags = 0)

Construct a splash screen that will display the pixmap.

There should be no need to set the widget flags, f, except perhaps Qt.WindowStaysOnTopHint.

QSplashScreen.__init__ (self, QWidget parent, QPixmap pixmap = QPixmap(), Qt.WindowFlags flags = 0)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

This is an overloaded function.

This function allows you to specify a parent for your splashscreen. The typical use for this constructor is if you have a multiple screens and prefer to have the splash screen on a different screen than your primary one. In that case pass the proper desktop() as the parent.

QSplashScreen.clearMessage (self)

This method is also a Qt slot with the C++ signature void clearMessage().

Removes the message being displayed on the splash screen

See also showMessage().

QSplashScreen.drawContents (self, QPainter painter)

Draw the contents of the splash screen using painter painter. The default implementation draws the message passed by showMessage(). Reimplement this function if you want to do your own drawing on the splash screen.

bool QSplashScreen.event (self, QEvent e)

Reimplemented from QObject.event().

QSplashScreen.finish (self, QWidget w)

Makes the splash screen wait until the widget mainWin is displayed before calling close() on itself.

QSplashScreen.mousePressEvent (self, QMouseEvent)

Reimplemented from QWidget.mousePressEvent().

QPixmap QSplashScreen.pixmap (self)

Returns the pixmap that is used in the splash screen. The image does not have any of the text drawn by showMessage() calls.

See also setPixmap().

QSplashScreen.repaint (self)

This overrides QWidget.repaint(). It differs from the standard repaint function in that it also calls QApplication.flush() to ensure the updates are displayed, even when there is no event loop present.

QSplashScreen.setPixmap (self, QPixmap pixmap)

Sets the pixmap that will be used as the splash screen's image to pixmap.

See also pixmap().

QSplashScreen.showMessage (self, QString message, int alignment = Qt.AlignLeft, QColor color = Qt.black)

This method is also a Qt slot with the C++ signature void showMessage(const QString&,int = Qt.AlignLeft,const QColor& = Qt.black).

Draws the message text onto the splash screen with color color and aligns the text according to the flags in alignment.

To make sure the splash screen is repainted immediately, you can call QCoreApplication's processEvents() after the call to showMessage(). You usually want this to make sure that the message is kept up to date with what your application is doing (e.g., loading files).

See also Qt.Alignment and clearMessage().


Qt Signal Documentation

void messageChanged (const QString&)

This is the default overload of this signal.

This signal is emitted when the message on the splash screen changes. message is the new message and is a null-string when the message has been removed.

See also showMessage() and clearMessage().


PyQt 4.11.1 for X11Copyright © Riverbank Computing Ltd and Digia 2014Qt 4.8.6