gsplash.h

Go to the documentation of this file.

#pragma once
 
// gemc
#include <gemc/gbase/gbase.h>
 
// Qt
#include <QtWidgets>
#include <QTimer>
 
namespace gsplash {
 
inline constexpr char GSPLASHENVIRONMENT[] = "GSPLASH";
inline constexpr char NOSPLASHIMAGESELECTED[] = "NOSPLASHIMAGESELECTED";
 
// exit codes: 190s
inline constexpr int ERR_NOSPLASHENVFOUND = 191;

inline constexpr char GSPLASH_LOGGER[] = "gsplash";
inline constexpr char GSPLASH_TIME_OPTION[] = "splash_time";
inline constexpr char GSPLASH_SCALE_OPTION[] = "splash_scale";

inline GOptions defineOptions() {
    GOptions goptions(gsplash::GSPLASH_LOGGER);
    goptions.defineOption(GVariable(gsplash::GSPLASH_TIME_OPTION, -1.0, "splash display time in seconds"),
                          "Minimum time in seconds to keep the splash image visible before closing it. "
                          "A negative value uses the application default.");
    goptions.defineOption(GVariable(gsplash::GSPLASH_SCALE_OPTION, 0.5, "splash image scale factor"),
                          "Scale factor applied to the splash image before display. "
                          "Use 1.0 for the image's original size.");
    return goptions;
}
 
} // namespace gsplash

class GSplash : public GBase<GSplash> {
public:
    static std::unique_ptr<GSplash>
    create(const std::shared_ptr<GOptions>& gopts,
           const std::string&               imageName = "gemcArchitecture",
           double                           splashTime = -1.0);

    void message(const std::string& msg);

    void messageAfter(int delay, const std::string& msg);

    void finish(QWidget* callingWindow) const;
 
private:
    GSplash(const std::shared_ptr<GOptions>& gopts,
            const std::string&               imageName,
            double                           splashTime);

    std::unique_ptr<QSplashScreen> splash;
    double                         splash_time = 0.0;
 
};