te::qt::af::SplashScreenManager Class Reference

A singleton for holding the application splash screen. More...

#include <SplashScreenManager.h>

Inheritance diagram for te::qt::af::SplashScreenManager:

Public Member Functions
void	finish (QWidget *w)
	Finishes the splash screen.
void	hide ()
	Hide the splash screen.
void	set (QSplashScreen *impl, int alignment=Qt::AlignLeft, const QColor &color=Qt::black)
	It sets the splash screen to be used during the application startup.
void	setLogo (const QPixmap &pix)
	Updates the image to be presented on splash screen.
void	show ()
	Shows the splash screen.
void	showMessage (const QString &message)
	This will cause the text to be drawn on the splash screen and a call to Application::processEvents() will be made.

Static Public Member Functions
static SplashScreenManager &	getInstance ()
	It returns a reference to the singleton instance.

Protected Member Functions
	SplashScreenManager ()
	It initializes the singleton.
	~SplashScreenManager ()
	Destructor.

Private Attributes
int	m_msgAlignment
	The alignment used to draw the message text.
QColor	m_msgColor
	The color used to draw the message text.
QSplashScreen *	m_sc
	A reference to the splash screen.

Friends
class	te::common::Singleton< SplashScreenManager >

Detailed Description

A singleton for holding the application splash screen.

Definition at line 47 of file SplashScreenManager.h.

Constructor & Destructor Documentation

SplashScreenManager()

te::qt::af::SplashScreenManager::SplashScreenManager ( )

protected

It initializes the singleton.

~SplashScreenManager()

te::qt::af::SplashScreenManager::~SplashScreenManager ( )

protected

Destructor.

Member Function Documentation

finish()

void te::qt::af::SplashScreenManager::finish

(

QWidget *

w

)

Finishes the splash screen.

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

getInstance()

SplashScreenManager & te::common::Singleton< SplashScreenManager >::getInstance

inlinestaticinherited

It returns a reference to the singleton instance.

Returns

A reference to the singleton instance.

Definition at line 109 of file Singleton.h.

hide()

void te::qt::af::SplashScreenManager::hide

(

)

Hide the splash screen.

This function can be used when something fails and the splash screen is visible.

set()

void te::qt::af::SplashScreenManager::set	(	QSplashScreen *	impl,
		int	alignment = Qt::AlignLeft,
		const QColor &	color = Qt::black
	)

It sets the splash screen to be used during the application startup.

Parameters

impl	Any splash screen widget.
alignment	The alignment of the text.
color	The text color.

Note

The caller is responsible for keeping the splash screen alive until the application is fully initialized.

The application will use the splash screen implementation only during the application startup.

The manager will not take the ownership of the splash screen.

setLogo()

void te::qt::af::SplashScreenManager::setLogo

(

const QPixmap &

pix

)

Updates the image to be presented on splash screen.

Parameters

pix	New image to be presented.

show()

void te::qt::af::SplashScreenManager::show

(

)

Shows the splash screen.

This function can be used when the splash screen is hidden.

showMessage()

void te::qt::af::SplashScreenManager::showMessage

(

const QString &

message

)

This will cause the text to be drawn on the splash screen and a call to Application::processEvents() will be made.

Parameters

message

The message to be drawn.

Friends And Related Symbol Documentation

te::common::Singleton< SplashScreenManager >

friend class te::common::Singleton< SplashScreenManager >

friend

Definition at line 47 of file SplashScreenManager.h.

Member Data Documentation

m_msgAlignment

int te::qt::af::SplashScreenManager::m_msgAlignment

private

The alignment used to draw the message text.

Definition at line 114 of file SplashScreenManager.h.

m_msgColor

QColor te::qt::af::SplashScreenManager::m_msgColor

private

The color used to draw the message text.

Definition at line 115 of file SplashScreenManager.h.

m_sc

QSplashScreen* te::qt::af::SplashScreenManager::m_sc

private

A reference to the splash screen.

Definition at line 113 of file SplashScreenManager.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/qt/af/SplashScreenManager.h