Inheritance diagram for Loading::Listener:

Collaboration diagram for Loading::Listener:

Public Member Functions
virtual void	setLabel (const std::string &label, bool important=false)

virtual void	loadingOn (bool visible=true)

virtual void	loadingOff ()

virtual void	setProgressRange (size_t range)
	Set the total range of progress (e.g. the number of objects to load). More...

virtual void	setProgress (size_t value)
	Set current progress. Valid range is [0, progressRange) More...

virtual void	increaseProgress (size_t increase=1)
	Increase current progress, default by 1. More...

Member Function Documentation

virtual void Loading::Listener::increaseProgress ( size_t increase = 1 )

inlinevirtual

Increase current progress, default by 1.

Here is the caller graph for this function:

virtual void Loading::Listener::loadingOff ( )

inlinevirtual

Here is the caller graph for this function:

virtual void Loading::Listener::loadingOn ( bool visible = true )

inlinevirtual

Start a loading sequence. Must call loadingOff() when done.

Note: To get the loading screen to actually update, you must call setProgress / increaseProgress periodically.; It is best to use the ScopedLoad object instead of using loadingOn()/loadingOff() directly, so that the loading is exception safe.

Here is the caller graph for this function:

virtual void Loading::Listener::setLabel	(	const std::string &	label,
		bool	important = `false`
	)

inlinevirtual

Set a text label to show on the loading screen.

Parameters

label	The label
important	Is the label considered important to show?

Note: "non-important" labels may not show on screen if the loading process went so fast that the implementation decided not to show a loading screen at all. "important" labels will show in a separate message-box if the loading screen was not shown.

Here is the caller graph for this function:

virtual void Loading::Listener::setProgress ( size_t value )

inlinevirtual

Set current progress. Valid range is [0, progressRange)

Here is the caller graph for this function:

virtual void Loading::Listener::setProgressRange ( size_t range )

inlinevirtual

Set the total range of progress (e.g. the number of objects to load).

Here is the caller graph for this function:

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

Public Member Functions