You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
44 lines
1.8 KiB
C++
44 lines
1.8 KiB
C++
#ifndef COMPONENTS_LOADINGLISTENER_H
|
|
#define COMPONENTS_LOADINGLISTENER_H
|
|
|
|
#include <string>
|
|
|
|
namespace Loading
|
|
{
|
|
class Listener
|
|
{
|
|
public:
|
|
/// Set a text label to show on the loading screen.
|
|
/// @param label The label
|
|
/// @param 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.
|
|
virtual void setLabel (const std::string& label, bool important=false) {}
|
|
|
|
/// Start a loading sequence. Must call loadingOff() when done.
|
|
/// @note To get the loading screen to actually update, you must call setProgress / increaseProgress periodically.
|
|
/// @note It is best to use the ScopedLoad object instead of using loadingOn()/loadingOff() directly,
|
|
/// so that the loading is exception safe.
|
|
virtual void loadingOn(bool visible=true) {}
|
|
virtual void loadingOff() {}
|
|
|
|
/// Set the total range of progress (e.g. the number of objects to load).
|
|
virtual void setProgressRange (size_t range) {}
|
|
/// Set current progress. Valid range is [0, progressRange)
|
|
virtual void setProgress (size_t value) {}
|
|
/// Increase current progress, default by 1.
|
|
virtual void increaseProgress (size_t increase = 1) {}
|
|
};
|
|
|
|
/// @brief Used for stopping a loading sequence when the object goes out of scope
|
|
struct ScopedLoad
|
|
{
|
|
ScopedLoad(Listener* l) : mListener(l) { mListener->loadingOn(); }
|
|
~ScopedLoad() { mListener->loadingOff(); }
|
|
Listener* mListener;
|
|
};
|
|
}
|
|
|
|
#endif
|