1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
/*
* Copyright (C) 2007-2016 by the Widelands Development Team
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef WL_UI_BASIC_PROGRESSWINDOW_H
#define WL_UI_BASIC_PROGRESSWINDOW_H
#include <cstring>
#include <string>
#include <vector>
#include "base/point.h"
#include "base/rect.h"
class Image;
class RenderTarget;
namespace UI {
/// Manages a progress window on the screen.
struct IProgressVisualization {
/// perform any visualizations as needed
/// if repaint is true, ensure previously painted areas are visible
virtual void update(bool repaint) = 0;
/// Progress Window is closing, unregister and cleanup
virtual void stop() = 0;
virtual ~IProgressVisualization() {
}
};
/// Manages a progress window on the screen.
struct ProgressWindow {
ProgressWindow(const std::string& background = std::string());
~ProgressWindow();
/// Register additional visualization (tips/hints, animation, etc)
void add_visualization(IProgressVisualization* instance);
void remove_visualization(IProgressVisualization* instance);
/// Set a picture to render in the background
void set_background(const std::string& file_name);
/// Display a progress step description.
void step(const std::string& description);
private:
using VisualizationArray = std::vector<IProgressVisualization*>;
Point label_center_;
Rect label_rectangle_;
VisualizationArray visualizations_;
std::string background_;
void draw_background(RenderTarget& rt, uint32_t xres, uint32_t yres);
void update(bool repaint);
};
}
#endif // end of include guard: WL_UI_BASIC_PROGRESSWINDOW_H
|