C4DownloadDlg.h

Go to the documentation of this file.

/*
 * OpenClonk, http://www.openclonk.org
 *
 * Copyright (c) 2007-2009, RedWolf Design GmbH, http://www.clonk.de/
 * Copyright (c) 2013-2016, The OpenClonk Team and contributors
 *
 * Distributed under the terms of the ISC license; see accompanying file
 * "COPYING" for details.
 *
 * "Clonk" is a registered trademark of Matthes Bender, used with permission.
 * See accompanying file "TRADEMARK" for details.
 *
 * To redistribute this file separately, substitute the full license texts
 * for the above references.
 */
// HTTP download dialog; downloads a file
// (like, e.g., a .ocu update group)
 
#ifndef INC_C4DownloadDlg
#define INC_C4DownloadDlg
 
#include "gui/C4Gui.h"
#include "network/C4HTTP.h"
 
// dialog to download a file
class C4DownloadDlg : public C4GUI::Dialog
{
private:
    C4HTTPClient HTTPClient;
 
    C4GUI::Icon *pIcon;
    C4GUI::Label *pStatusLabel;
    C4GUI::ProgressBar *pProgressBar;
    C4GUI::CancelButton *pCancelBtn;
    const char *szError;
#ifdef HAVE_WINSOCK
    bool fWinSock;
#endif
 
protected:
    C4DownloadDlg(const char *szDLType);
    ~C4DownloadDlg() override;
 
private:
    // updates the displayed status text and progress bar - repositions elements if necessary
    void SetStatus(const char *szNewText, int32_t iProgressPercent);
 
protected:
    // idle proc: Continue download; close when finished
    void OnIdle() override;
 
    // user presses cancel button: Abort download
    void UserClose(bool fOK) override;
 
    // downloads the specified file to the specified location. Returns whether successful
    bool ShowModal(C4GUI::Screen *pScreen, const char *szURL, const char *szSaveAsFilename);
 
    const char *GetError();
 
public:
    // download file showing download dialog; display error if download failed
    static bool DownloadFile(const char *szDLType, C4GUI::Screen *pScreen, const char *szURL, const char *szSaveAsFilename, const char *szNotFoundMessage = nullptr);
};
 
 
#endif // INC_C4DownloadDlg