Table Of Contents

Previous topic

QSplitter

Next topic

QDoubleSpinBox

QSplashScreen

Inheritance diagram of QSplashScreen

Synopsis

Functions

Virtual functions

Slots

Signals

Detailed Description

The PySide.QtGui.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:

def main():
    app = QApplication(sys.argv)
    pixmap = QPixmap(":/splash.png")
    splash = QSplashScreen(pixmap)
    splash.show()
    app.processEvents()
    ...
    window = QMainWindow()
    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:

pixmap = QPixmap(":/splash.png")
splash = QSplashScreen(pixmap)
splash.show()

... # Loading some items
splash.showMessage("Loaded modules")

qApp.processEvents()

... # Establishing connections
splash.showMessage("Established connections")

qApp.processEvents()

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

class PySide.QtGui.QSplashScreen(parent[, pixmap=QPixmap()[, f=0]])
class PySide.QtGui.QSplashScreen([pixmap=QPixmap()[, f=0]])
Parameters:
PySide.QtGui.QSplashScreen.clearMessage()

Removes the message being displayed on the splash screen

See also

PySide.QtGui.QSplashScreen.showMessage()

PySide.QtGui.QSplashScreen.drawContents(painter)
Parameters:painter – PySide.QtGui.QPainter

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

PySide.QtGui.QSplashScreen.finish(w)
Parameters:w – PySide.QtGui.QWidget

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

PySide.QtGui.QSplashScreen.messageChanged(message)
Parameters:message – unicode
PySide.QtGui.QSplashScreen.pixmap()
Return type:PySide.QtGui.QPixmap

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

See also

PySide.QtGui.QSplashScreen.setPixmap()

PySide.QtGui.QSplashScreen.setPixmap(pixmap)
Parameters:pixmap – PySide.QtGui.QPixmap

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

See also

PySide.QtGui.QSplashScreen.pixmap()

PySide.QtGui.QSplashScreen.showMessage(message[, alignment=Qt.AlignLeft[, color=Qt.black]])
Parameters:

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 PySide.QtCore.QCoreApplication ‘s PySide.QtCore.QCoreApplication.processEvents() after the call to PySide.QtGui.QSplashScreen.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 PySide.QtGui.QSplashScreen.clearMessage()

Indt Openbossa Qt Python