~widelands-dev/widelands/trunk

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
/*
 * Copyright (C) 2004, 2006, 2009 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_PROGRESSBAR_H
#define WL_UI_BASIC_PROGRESSBAR_H

#include "ui_basic/panel.h"

namespace UI {

/**
 * A very simple panel that displays progress or productivity in percent,
 * graphically enhanced with a coloured bar.
 *
 * The actual state of progress
*/
struct ProgressBar : public Panel {
	enum {
		Horizontal = 0, ///< from left to right
		Vertical   = 1, ///< from bottom to top

		DefaultWidth = 100,
		DefaultHeight = 24,
	};

public:
	ProgressBar
		(Panel * parent,
		 int32_t x, int32_t y, int32_t w, int32_t h,
		 uint32_t orientation);

	uint32_t get_state() const {return m_state;}
	void set_state(uint32_t);
	uint32_t get_total() const {return m_total;}
	void set_total(uint32_t);

protected:
	void draw(RenderTarget &) override;

private:
	uint32_t m_orientation;
	uint32_t m_state; ///< m_state is [0..m_total]
	uint32_t m_total; ///< maximum progress
};

}

#endif  // end of include guard: WL_UI_BASIC_PROGRESSBAR_H