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

#include <QtxSplash.h>

Inheritance diagram for QtxSplash:

Public Types
enum	ProgressBarFlags { LeftSide = 0x0001 , RightSide = 0x0002 , TopSide = 0x0004 , BottomSide = 0x0008 , LeftToRight = 0x0010 , RightToLeft = 0x0020 }
	Progress bar position and direction. More...

Public Slots
void	setMessage (const QString &, const int, const QColor &=QColor())
	Set status message for the splash screen and define its color and aligment flags. More...

void	setMessage (const QString &)
	Set status message for the splash screen. More...

void	clear ()
	Remove the message being displayed on the splash screen. More...

Public Member Functions
virtual	~QtxSplash ()
	Destructor. More...

void	setSize (const QSize &)
	Set fixed size of splash screen. More...

void	setSize (int, int)
	This is an overloaded function. More...

QSize	fixedSize () const
	Get fixed splash screen's size if it was set. More...

void	setPixmap (const QPixmap &)
	Set the pixmap that will be used as the splash screen's image. More...

QPixmap	pixmap () const
	Get the pixmap that is used as the splash screen's image. More...

void	setHideOnClick (const bool)
	Set/clear the 'hide on mouse click' flag. More...

bool	hideOnClick () const
	Get the 'hide on mouse click' flag. More...

void	setProgressVisible (const bool)
	Enable/disable displaying of the progress bar. More...

bool	progressVisible () const
	Check if the progress bar is displayed. More...

void	setMessageVisible (const bool)
	Enable/disable displaying of the status message. More...

bool	messageVisible () const
	Check if the status message is displayed. More...

void	setPercentageVisible (const bool)
	Enable/disable displaying progress percentage. More...

bool	percentageVisible () const
	Check if the progress percentage is displayed. More...

void	setTotalSteps (const int)
	Set total progress steps to total. More...

int	totalSteps () const
	Get total progress steps number. More...

void	setProgress (const int)
	Set current progress. More...

void	setProgress (const int, const int)
	Set current progress to progress and total number of progress steps to total. More...

int	progress () const
	Get current progress. More...

void	setMargin (const int)
	Set splash window margin (a border width). More...

int	margin () const
	Get splash window margin (a border width). More...

void	setProgressWidth (const int)
	Set progress bar width. More...

int	progressWidth () const
	Get progress bar width. More...

void	setProgressFlags (const int)
	Set progress bar position and direction. More...

int	progressFlags () const
	Get progress bar flags: position and direction. More...

void	setProgressColors (const QColor &, const QColor &=QColor(), const Qt::Orientation=Qt::Vertical)
	Set progress bar colors. More...

void	setProgressColors (const QGradient &)
	Set progress bar colors. More...

const QGradient *	progressColors () const
	Get custom progress bar colors. More...

void	setOpacity (const double)
	Set progress bar and status text message opacity. More...

double	opacity () const
	Get progress bar and status text message opacity. More...

void	setTextAlignment (const int)
	Set message text alignment flags. More...

int	textAlignment () const
	Get message text alignment flags. More...

void	setTextColors (const QColor &, const QColor &=QColor())
	Set message text colors. More...

void	textColors (QColor &, QColor &) const
	Get message text colors. More...

void	setConstantInfo (const QString &info)
	Set constant info text to be displayed on the splash screen. More...

QString	constantInfo () const
	Get constant info text. More...

void	setOption (const QString &, const QString &)
	Set constant information option value. More...

QString	option (const QString &) const
	Get constant information option value. More...

QString	message () const
	Get current status message. More...

int	error () const
	Get error code. More...

void	finish (QWidget *)
	Wait until widget mainWin is displayed. More...

void	repaint ()
	Repaint the splash screen. More...

void	readSettings (QtxResourceMgr *, const QString &=QString())
	Read splash settings from the resources manager. More...

Static Public Member Functions
static QtxSplash *	splash (const QPixmap &=QPixmap())
	Get the only instance of the splash screen widget. More...

static void	setStatus (const QString &, const int=-1)
	Send the status message and (optionally) current progress to the splash screen. More...

static void	setError (const QString &, const QString &=QString(), const int=-1)
	Set error status and show error message box to the user. More...

Protected Member Functions
virtual void	mousePressEvent (QMouseEvent *)
	Process mouse button pressing event. More...

virtual void	customEvent (QEvent *)
	Process custom event sent by setStatus() method. More...

virtual void	paintEvent (QPaintEvent *)
	Customize paint event. More...

virtual void	drawContents (QPainter *)
	Draw the contents of the splash screen. More...

virtual void	drawProgressBar (QPainter *)
	Draw progress bar. More...

virtual void	drawMessage (QPainter *)
	Draw status message. More...

Private Types
typedef QMap< QString, QString >	OptMap

Private Member Functions
	QtxSplash (const QPixmap &)
	Constructor. More...

void	drawContents ()
	Draw the splash screen window contents. More...

void	setError (const int)
	Sets error code. More...

QString	fullMessage () const
	Get full message which includes constant info and status message. More...

Private Attributes
QSize	mySize
	splash size More...

QPixmap	myPixmap
	splash pixmap More...

QString	myInfo
	constant info More...

QString	myMessage
	current status message More...

int	myAlignment
	text alignment flags (Qt::Alignment) More...

QColor	myColor
	text color More...

QColor	myShadowColor
	text shadow color More...

bool	myHideOnClick
	'hide on click' flag More...

int	myProgress
	current progress More...

int	myTotal
	total progress steps More...

QGradient	myGradient
	progress bar custom gradient More...

int	myProgressWidth
	progress bar width More...

int	myProgressFlags
	progress bar flags (QtxSplash::ProgressBarFlags) More...

int	myMargin
	margin (for progress bar and status message) More...

double	myOpacity
	progress bar / status message opacity More...

int	myError
	error code More...

OptMap	myOptions
	constant info options More...

bool	myShowProgress
	'show progress bar' flag More...

bool	myShowMessage
	'show status message' flag More...

bool	myShowPercent
	'show percentage' flag More...

Static Private Attributes
static QtxSplash *	mySplash = 0
	The only one instance of splash screen. More...

Detailed Description

The QtxSplash 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 to provide the user with feedback that the application is loading.

Only one instance of the QtxSplash widget can be created. To access the splash screen widget, use static method QtxSplash::splash(), which creates an instance of the QtxSplash widget (if it is not yet creaed) and returns a pointer to it. You should not destroy this instance - it is done automatically after application main window is shown. Just use methods finish() to make splash screen wait untill main window is shown.

The splash screen appears in the center of the screen. The most common usage is to show a splash screen before the main widget is displayed on the screen. For example,

int main(int argc, char *argv[])
{
  QApplication app(argc, argv);
  QPixmap pixmap(":/splash.png");
  QtxSplash* splash = QtxsSplash::splash(pixmap);
  splash->show();
  app.processEvents();
  ... // do application loading and initialization
  MainWindow 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. To activate the possibility of hiding the splash screen on the mouse click, use setHideOnClick() method passing true as parameter. By default, this feature is switched off.

It is sometimes useful to update the splash screen with any status messages and/or progress information, for example, announcing connections established or modules loaded as the application starts up. QtxSplash class provides the functionality to show status messages and(or) progress bar.

QPixmap pixmap(":/splash.png");
QtxSplash* splash = QtxSplash::splash(pixmap);
splash->setProgress(0, 5); // progress from 0 to 5
splash->show();
app.processEvents();
// doing first step
splash->setMessage("Step 1");
splash->setProgress(1); // progress is 20%
qApp->processEvents();
// ... perform some actions
// doing second step
splash->setMessage("Step 2");
splash->setProgress(2); // progress is 40%
qApp->processEvents();
// ... perform some actions
... et cetera

There is a static function QtxSplash::setStatus() which allows to put the next status message and current progress with one call. It can substitue two calls: setMessage() and setProgress().

QtxSplash class provides also a lot of functions to customize its behavior. Set progress bar width with setProgressWidth() method, its position and direction with setProgressFlags(). It can be single-colored or gradient-colored. Use setProgressColors() methods for this. You can even set your own gradient scale with QLinearGradient, QRadialGradient or QConicalGradient and use it for the progress bar coloring. In addition, it is possible to enable/disable displaying of the progress percentage with setPercentageVisible() method.

Displaying of the progress bar and status messages can be switched on/off with setProgressVisible() and setMessageVisible() methods.

To change the progress bar and status message transparency, use setOpacity() function. The methods setTextAlignment() and setTextColors() can be used to change the attributes of the status messages.

The displayed message text can include constant info and status message. The constant info is set by setConstantInfo() method and status message is set by setMessage().

Sometimes it is useful to display an error message above the splash screen window. For example, it can be necessary if an error occurs when loading the application. Method setError() can be used to show the error message and set the error code which can be then retrieved with the error() function.

There is one more helpful feature. The QtxSplash class can read all the settings from the resource file with help of resource manager (QtxResourceMgr class). Refer to the method readSettings() for more details.

Member Typedef Documentation

◆ OptMap

typedef QMap<QString, QString> QtxSplash::OptMap

private

Member Enumeration Documentation

◆ ProgressBarFlags

enum QtxSplash::ProgressBarFlags

Progress bar position and direction.

Enumerator
LeftSide	progress bar is displayed at the left side
RightSide	progress bar is displayed at the right side
TopSide	progress bar is displayed at the top side
BottomSide	progress bar is displayed at the bottom side
LeftToRight	show progress from left to right (from top to bottom)
RightToLeft	show progress from right to left (from bottom to top)

Constructor & Destructor Documentation

◆ QtxSplash()

QtxSplash::QtxSplash ( const QPixmap & pixmap )

private

Constructor.

Construct a splash screen that will display the pixmap.

Parameters

pixmap splash screen pixmap

See also: setPixmap(), pixmap()

References pixmap(), and setPixmap().

◆ ~QtxSplash()

QtxSplash::~QtxSplash ( )

virtual

Destructor.

References mySplash.

Member Function Documentation

◆ clear

void QtxSplash::clear ( )

slot

Remove the message being displayed on the splash screen.

This is equivalent to setMessage("");

See also: message(), setMessage()

References myMessage, and repaint().

◆ constantInfo()

QString QtxSplash::constantInfo ( ) const

Get constant info text.

Returns: constant info text

See also: setConstantInfo(), message(), setMessage()

References myInfo.

◆ customEvent()

void QtxSplash::customEvent ( QEvent * ce )

protectedvirtual

Process custom event sent by setStatus() method.

Parameters

ce	custom event

See also: setStatus().

References clear(), ProgressEvent::id(), ProgressEvent::message(), ProgressEvent::progress(), setMessage(), and setProgress().

◆ drawContents() [1/2]

void QtxSplash::drawContents ( )

private

Draw the splash screen window contents.

References myPixmap.

◆ drawContents() [2/2]

void QtxSplash::drawContents ( QPainter * p )

protectedvirtual

Draw the contents of the splash screen.

Parameters

p painter

References drawMessage(), drawProgressBar(), fullMessage(), messageVisible(), myTotal, and progressVisible().

◆ drawMessage()

void QtxSplash::drawMessage ( QPainter * p )

protectedvirtual

Draw status message.

Parameters

p painter

See also: drawProgressBar()

References BottomSide, fullMessage(), LeftSide, margin(), myAlignment, myColor, myOpacity, myProgressFlags, myShadowColor, progressVisible(), progressWidth(), RightSide, and TopSide.

◆ drawProgressBar()

void QtxSplash::drawProgressBar ( QPainter * p )

protectedvirtual

Draw progress bar.

Parameters

p painter

See also: drawMessage()

References BottomSide, checkGradient(), OCCViewer::color(), LeftSide, margin(), myColor, myOpacity, myProgress, myProgressFlags, myShadowColor, myShowPercent, myTotal, progressColors(), progressWidth(), RightSide, RightToLeft, and TopSide.

◆ error()

int QtxSplash::error ( ) const

Get error code.

This function returns error code, set previously with setError() method. If no error code has been set, 0 is returned.

Returns: last error code

See also: setError()

References myError.

◆ finish()

void QtxSplash::finish ( QWidget * mainWin )

Wait until widget mainWin is displayed.

Makes the splash screen wait until the widget mainWin is displayed and then hide and close splash window.

Parameters

mainWin application main window

◆ fixedSize()

QSize QtxSplash::fixedSize ( ) const

Get fixed splash screen's size if it was set.

See also: setSize()

References mySize.

◆ fullMessage()

QString QtxSplash::fullMessage ( ) const

private

Get full message which includes constant info and status message.

Returns: get fill message text

See also: constantInfo(), setConstantInfo(), message(), setMessage()

References myInfo, myMessage, and option().

◆ hideOnClick()

bool QtxSplash::hideOnClick ( ) const

Get the 'hide on mouse click' flag.

Returns: 'hide on mouse click' flag

See also: setHideOnClick()

References myHideOnClick.

◆ margin()

int QtxSplash::margin ( ) const

Get splash window margin (a border width).

Returns: current margin width

See also: setMargin()

References myMargin.

◆ message()

QString QtxSplash::message ( ) const

Get current status message.

Returns: status message

See also: setMessage(), constantInfo(), setConstantInfo()

References myMessage.

◆ messageVisible()

bool QtxSplash::messageVisible ( ) const

Check if the status message is displayed.

Returns: true if status message is enabled

See also: setMessageVisible()

References myShowMessage.

◆ mousePressEvent()

void QtxSplash::mousePressEvent ( QMouseEvent * )

protectedvirtual

Process mouse button pressing event.

Hides splash screen if the 'hide on mouse click' flag is set.

Parameters

me	mouse event (not used)

See also: hideOnClick(), setHideOnClick()

References myHideOnClick.

◆ opacity()

double QtxSplash::opacity ( ) const

Get progress bar and status text message opacity.

Returns: current opacity value

See also: setOpacity()

References myOpacity.

◆ option()

QString QtxSplash::option ( const QString & name ) const

Get constant information option value.

Parameters

name	option name

Returns: option value or empty string if option is not set

See also: setOption(), setConstantInfo(), constantInfo()

References myOptions.

◆ paintEvent()

void QtxSplash::paintEvent ( QPaintEvent * )

protectedvirtual

Customize paint event.

This function is implemented to work-around the Qt bug on some Linux distribututions when the drawing on the splash screen widget is not allowed.

Parameters

pe	paint event (not used)

◆ percentageVisible()

bool QtxSplash::percentageVisible ( ) const

Check if the progress percentage is displayed.

Returns: true if percentage displaying is enabled

See also: setPercentageVisible()

References myShowPercent.

◆ pixmap()

QPixmap QtxSplash::pixmap ( ) const

Get the pixmap that is used as the splash screen's image.

Returns: spash screen image pixmap

See also: setPixmap()

References myPixmap.

◆ progress()

int QtxSplash::progress ( ) const

Get current progress.

Returns: current progress

See also: setProgress(), setTotalSteps(), setTotalSteps(),

References myProgress.

◆ progressColors()

const QGradient * QtxSplash::progressColors ( ) const

Get custom progress bar colors.

Returns: color gradient used for progress bar coloring

See also: setProgressColors()

References myGradient.

◆ progressFlags()

int QtxSplash::progressFlags ( ) const

Get progress bar flags: position and direction.

Returns: ORed progress bar flags (QtxSplash::ProgressBarFlags)

See also: setProgressFlags()

References myProgressFlags.

◆ progressVisible()

bool QtxSplash::progressVisible ( ) const

Check if the progress bar is displayed.

Returns: true if progress bar is enabled

See also: setProgressVisible()

References myShowProgress.

◆ progressWidth()

int QtxSplash::progressWidth ( ) const

Get progress bar width.

Returns: current progress bar width

See also: setProgressWidth()

References myProgressWidth.

◆ readSettings()

void QtxSplash::readSettings	(	QtxResourceMgr *	resMgr,
		const QString &	section = `QString()`
	)

Read splash settings from the resources manager.

This method can be used to setup the splash screen look-n-feel. By default, "splash" section of the resources file is used, but you can use any other section. All the splash screen parameters can be defined via resources file:

"image" : splash screen image, see setPixmap()
"margin" : splash window margin, see setMargin()
"show_progress" : show progress bar flag, see setProgressVisible()
"show_message" : show status messages flag, see setMessageVisible()
"show_percents" : show progress percentage flag, see setPercentageVisible()
"progress_width" : progress bar width(), see setProgressWidth()
"progress_flags" : progress bar position and direction, see setProgressFlags()
"constant_info" : status messages constant info, see setConstantInfo()
"text_colors" : status messages color(s), see setTextColors()
"progress_colors" : progress bar color(s), see setProgressColors()
"opacity" : progress bar and status messages opacity, see setOpacity()
"font" : status messages font
"alignment" : status messages alignment flags, see setTextAlignment()
"hide_on_click" : hide-on-click flag, see setHideOnClick()

Parameters

resMgr	resources manager
section	resources file section name (if empty, the default "splash" section is used).

References BottomSide, Horizontal, QtxResourceMgr::integerValue(), LeftSide, LeftToRight, px(), RightSide, RightToLeft, setConstantInfo(), setHideOnClick(), setMargin(), setMessageVisible(), setOpacity(), setPercentageVisible(), setPixmap(), setProgressColors(), setProgressFlags(), setProgressVisible(), setProgressWidth(), setSize(), setTextAlignment(), setTextColors(), TopSide, QtxResourceMgr::value(), and Vertical.

◆ repaint()

void QtxSplash::repaint ( )

Repaint the splash screen.

References drawContents().

◆ setConstantInfo()

void QtxSplash::setConstantInfo ( const QString & info )

Set constant info text to be displayed on the splash screen.

The displayed text includes constant info and status message. The constant message is set by setConstantInfo() method and status message is set by setMessage().

Parameters

info	constant info text

See also: constantInfo(), message(), setMessage(), option(), setOption()

References myInfo, and repaint().

◆ setError() [1/2]

void QtxSplash::setError ( const int code )

private

Sets error code.

Parameters

code	error code

References myError.

◆ setError() [2/2]

void QtxSplash::setError	(	const QString &	error,
		const QString &	title = `QString()`,
		const int	code = `-1`
	)

static

Set error status and show error message box to the user.

Parameters

error	error message
title	message box title
code	error code

See also: error()

References error(), mySplash, and setError().

◆ setHideOnClick()

void QtxSplash::setHideOnClick ( const bool on )

Set/clear the 'hide on mouse click' flag.

When this flag is set, user can hide the splash screen window by clicking on it with mouse. But for this to work it is necessary to call periodically QApplication::processEvents() in order to allow event loop to process events because usually main application loop is not yet started at that moment.

By default this flag is set to false.

Parameters

on	new flag state

See also: hideOnClick()

References myHideOnClick.

◆ setMargin()

void QtxSplash::setMargin ( const int margin )

Set splash window margin (a border width).

Note, that margin is used only for drawing the progress bar and status messages.

Parameters

margin new margin width

See also: margin()

References margin(), myMargin, and repaint().

◆ setMessage [1/2]

void QtxSplash::setMessage ( const QString & msg )

slot

Set status message for the splash screen.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

msg	status message

See also: message(), constantInfo(), setConstantInfo()

References myMessage, and repaint().

◆ setMessage [2/2]

void QtxSplash::setMessage	(	const QString &	msg,
		const int	alignment,
		const QColor &	color = `QColor()`
	)

slot

Set status message for the splash screen and define its color and aligment flags.

Parameters

msg	status message
alignment	message text alignment flags (Qt::Alignment)
color	message text color

See also: message(), constantInfo(), setConstantInfo()

References OCCViewer::color(), myAlignment, myColor, myMessage, and repaint().

◆ setMessageVisible()

void QtxSplash::setMessageVisible ( const bool on )

Enable/disable displaying of the status message.

Parameters

on	if `true`, status message will be enabled

See also: messageVisible(), setProgressVisible()

References myShowMessage, and repaint().

◆ setOpacity()

void QtxSplash::setOpacity ( const double opacity )

Set progress bar and status text message opacity.

The value should be in the range 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.

Parameters

opacity new opacity value

See also: opacity()

References myOpacity, opacity(), and repaint().

◆ setOption()

void QtxSplash::setOption	(	const QString &	name,
		const QString &	value
	)

Set constant information option value.

The option is a part of the constant information text, which is replaced at the time of the displaying.

The following options are supported:

%A - could be used as application name
%V - could be used as application version
%L - could be used as application license information
%C - could be used as application copyright information

For example,

splash->setContantInfo("%A [%V]\n%C");
splash->setOption("%A", "MyApplication" );
splash->setOption("%V", "Version 1.0" );
splash->setOption("%C", "Copyright (C) MyCompany 2008" );

Parameters

name	option name
option	value

See also: option(), setConstantInfo(), constantInfo()

References myOptions, and repaint().

◆ setPercentageVisible()

void QtxSplash::setPercentageVisible ( const bool enable )

Enable/disable displaying progress percentage.

Parameters

enable if true, percentage will be displayed

See also: percentageVisible()

References myShowPercent, and repaint().

◆ setPixmap()

void QtxSplash::setPixmap ( const QPixmap & pixmap )

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

Parameters

pixmap spash screen image pixmap

See also: pixmap()

References drawContents(), fixedSize(), myPixmap, pixmap(), and repaint().

◆ setProgress() [1/2]

void QtxSplash::setProgress ( const int progress )

Set current progress.

Parameters

progress current progress

See also: progress(), setTotalSteps(), setTotalSteps(),

References myProgress, progress(), and repaint().

◆ setProgress() [2/2]

void QtxSplash::setProgress	(	const int	progress,
		const int	total
	)

Set current progress to progress and total number of progress steps to total.

Parameters

progress	current progress
total	total number of progress steps

References myProgress, myTotal, progress(), and repaint().

◆ setProgressColors() [1/2]

void QtxSplash::setProgressColors	(	const QColor &	startColor,
		const QColor &	endColor = `QColor()`,
		const Qt::Orientation	orientation = `Qt::Vertical`
	)

Set progress bar colors.

If the colors differ the two-colored gradient bar is drawn.

If the endColor is not valid, startColor is used instead (i.e. simple, one-colored progress bar is drawn).

The parameter orientation defines the type of gradient to be drawn - horizontal or vertical. Default is vertical.

Parameters

startColor	start gradient color (or mono-color)
endColor	end gradient color
orientation	gradient type (Qt::Orientation)

See also: progressColors()

References Vertical.

◆ setProgressColors() [2/2]

void QtxSplash::setProgressColors ( const QGradient & gradient )

Set progress bar colors.

Use this method to display multi-colored gradient progress bar. You have to use QLinearGradient, QRadialGradient or QConicalGradient classes to define the gradient.

Note, that progress bar coordinates can be defined in absolute or relative mode. In absolute mode the actual coordinates of the gradient key points (like start and final point for linear gradient, center and focal point for radial gradient, etc) are calculated from the top-left progress bar's corner. In relative mode you have to use values from 0 to 1 (including) to define the key points positions.

For example:

QLinearGradient lg(0.5, 0, 1, 1);
lg.setColorAt(0.2, Qt::blue);
lg.setColorAt(0.6, Qt::red);
lg.setSpread(QGradient::RepeatSpread);
splash->setProgressGradient(lg);

The above code creates linear gradient, which sets start stop to the center of the progress bar; the final stop is assigned to its right-bottom corner. The color scale (blue to red) is changed by the progress bar diagonal.

Parameters

gradient color gradient to be used for progress bar coloring

See also: progressColors()

References myGradient, and repaint().

◆ setProgressFlags()

void QtxSplash::setProgressFlags ( const int flags )

Set progress bar position and direction.

By default, progress bar is displayed at the bottom side and shows progress from left to right but this behaviour can be changed.

Parameters

flags ORed progress bar flags (QtxSplash::ProgressBarFlags)

See also: progressFlags()

References BottomSide, LeftSide, LeftToRight, myProgressFlags, repaint(), RightSide, RightToLeft, and TopSide.

◆ setProgressVisible()

void QtxSplash::setProgressVisible ( const bool on )

Enable/disable displaying of the progress bar.

Parameters

on	if `true`, progress bar will be enabled

See also: progressVisible(), setMessageVisible()

References myShowProgress, and repaint().

◆ setProgressWidth()

void QtxSplash::setProgressWidth ( const int width )

Set progress bar width.

Parameters

width new progress bar width

See also: progressWidth()

References myProgressWidth, and repaint().

◆ setSize() [1/2]

void QtxSplash::setSize ( const QSize & size )

Set fixed size of splash screen.

If size is not set explicitly, it is inherited from image being used. Otherwise, image is rescaled to given size.

Width and height can be given indepdently; not given dimension (zero of negative value) is ignored.

Parameters

size	fixed splash size

See also: fixedSize()

References mySize, pixmap(), and setPixmap().

◆ setSize() [2/2]

void QtxSplash::setSize	(	int	w,
		int	h
	)

This is an overloaded function.

Parameters

w	width
h	height

See also: fixedSize()

References setSize().

◆ setStatus()

void QtxSplash::setStatus	(	const QString &	msg,
		const int	progress = `-1`
	)

static

Send the status message and (optionally) current progress to the splash screen.

If the second parameter is less than 0 (default) than it is ignored and only the status message is changed. If you want to modify progress also, pass positive value to the progress parameter explicitly.

Parameters

msg	progress status message
progress	current progress

See also: setMessage(), setProgress()

References mySplash, and progress().

◆ setTextAlignment()

void QtxSplash::setTextAlignment ( const int alignment )

Set message text alignment flags.

Default flags are Qt::AlignBottom | Qt::AlignRight.

Parameters

alignment alignment flags (Qt::Alignment)

See also: textAlignment()

References myAlignment, and repaint().

◆ setTextColors()

void QtxSplash::setTextColors	(	const QColor &	color,
		const QColor &	shadow = `QColor()`
	)

Set message text colors.

If shadow parameter is invalid color, the simple one-colored text is drawn. Otherwise, second parameter is used to draw the text shadow.

Parameters

color	message text color
shadow	message text shadow color

See also: textColors()

References OCCViewer::color(), myColor, myShadowColor, and repaint().

◆ setTotalSteps()

void QtxSplash::setTotalSteps ( const int total )

Set total progress steps to total.

Parameters

total total number of progress steps

See also: totalSteps(), setProgress(), progress()

References myTotal, and repaint().

◆ splash()

QtxSplash * QtxSplash::splash ( const QPixmap & px = QPixmap() )

static

Get the only instance of the splash screen widget.

If the splash screen widget does not exist yet, it is created with specified pixmap. Otherwise, pixmap px is set to existing widget.

Parameters

px	splash screen pixmap

Returns: splash screen widget

See also: setPixmap(), pixmap()

References mySplash, px(), QtxSplash(), and setPixmap().

◆ textAlignment()

int QtxSplash::textAlignment ( ) const

Get message text alignment flags.

Returns: alignment flags (Qt::Alignment)

See also: setTextAlignment()

References myAlignment.

◆ textColors()

void QtxSplash::textColors	(	QColor &	color,
		QColor &	shadow
	)		const

Get message text colors.

Parameters

color	message text color
shadow	message text shadow color

See also: setTextColors()

References OCCViewer::color(), myColor, and myShadowColor.

◆ totalSteps()

int QtxSplash::totalSteps ( ) const

Get total progress steps number.

Returns: total number of progress steps

See also: setTotalSteps(), setProgress(), progress()

References myTotal.

Member Data Documentation

◆ myAlignment

int QtxSplash::myAlignment

private

text alignment flags (Qt::Alignment)

◆ myColor

QColor QtxSplash::myColor

private

text color

◆ myError

int QtxSplash::myError

private

error code

◆ myGradient

QGradient QtxSplash::myGradient

private

progress bar custom gradient

◆ myHideOnClick

bool QtxSplash::myHideOnClick

private

'hide on click' flag

◆ myInfo

QString QtxSplash::myInfo

private

constant info

◆ myMargin

int QtxSplash::myMargin

private

margin (for progress bar and status message)

◆ myMessage

QString QtxSplash::myMessage

private

current status message

◆ myOpacity

double QtxSplash::myOpacity

private

progress bar / status message opacity

◆ myOptions

OptMap QtxSplash::myOptions

private

constant info options

◆ myPixmap

QPixmap QtxSplash::myPixmap

private

splash pixmap

◆ myProgress

int QtxSplash::myProgress

private

current progress

◆ myProgressFlags

int QtxSplash::myProgressFlags

private

progress bar flags (QtxSplash::ProgressBarFlags)

◆ myProgressWidth

int QtxSplash::myProgressWidth

private

progress bar width

◆ myShadowColor

QColor QtxSplash::myShadowColor

private

text shadow color

◆ myShowMessage

bool QtxSplash::myShowMessage

private

'show status message' flag

◆ myShowPercent

bool QtxSplash::myShowPercent

private

'show percentage' flag

◆ myShowProgress

bool QtxSplash::myShowProgress

private

'show progress bar' flag

◆ mySize

QSize QtxSplash::mySize

private

splash size

◆ mySplash

QtxSplash * QtxSplash::mySplash = 0

staticprivate

The only one instance of splash screen.

◆ myTotal

int QtxSplash::myTotal

private

total progress steps

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

src/Qtx/QtxSplash.h
src/Qtx/QtxSplash.cxx

Public Types

Public Slots

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ OptMap

Member Enumeration Documentation

◆ ProgressBarFlags

Constructor & Destructor Documentation

◆ QtxSplash()

◆ ~QtxSplash()

Member Function Documentation

◆ clear

◆ constantInfo()

◆ customEvent()

◆ drawContents() [1/2]

◆ drawContents() [2/2]

◆ drawMessage()

◆ drawProgressBar()

◆ error()

◆ finish()

◆ fixedSize()

◆ fullMessage()

◆ hideOnClick()

◆ margin()

◆ message()

◆ messageVisible()

◆ mousePressEvent()

◆ opacity()

◆ option()

◆ paintEvent()

◆ percentageVisible()

◆ pixmap()

◆ progress()

◆ progressColors()

◆ progressFlags()

◆ progressVisible()

◆ progressWidth()

◆ readSettings()

◆ repaint()

◆ setConstantInfo()

◆ setError() [1/2]

◆ setError() [2/2]

◆ setHideOnClick()

◆ setMargin()

◆ setMessage [1/2]

◆ setMessage [2/2]

◆ setMessageVisible()

◆ setOpacity()

◆ setOption()

◆ setPercentageVisible()

◆ setPixmap()

◆ setProgress() [1/2]

◆ setProgress() [2/2]

◆ setProgressColors() [1/2]

◆ setProgressColors() [2/2]

◆ setProgressFlags()

◆ setProgressVisible()

◆ setProgressWidth()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setStatus()

◆ setTextAlignment()

◆ setTextColors()

◆ setTotalSteps()

◆ splash()

◆ textAlignment()

◆ textColors()

◆ totalSteps()

Member Data Documentation

◆ myAlignment

◆ myColor

◆ myError

◆ myGradient