progressbar.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Kenneth Gangstoe
28 ** Harry Storbacka
29 */
30 
31 
32 #pragma once
33 
34 #include "../api_gui.h"
35 #include "../gui_component.h"
36 
37 namespace clan
38 {
41 
42 class ProgressBar_Impl;
43 
45 class CL_API_GUI ProgressBar : public GUIComponent
46 {
49 
50 public:
51 
55  ProgressBar(GUIComponent *parent);
56 
57  virtual ~ProgressBar();
58 
62 
63 public:
65 
69  static ProgressBar *get_named_item(GUIComponent *reference_component, const std::string &id);
70 
74  int get_min() const;
75 
79  int get_max() const;
80 
84  int get_step_size() const;
85 
89  int get_position() const;
90 
94  bool is_marquee_mode() const;
95 
99  int get_marquee_animation_speed() const;
100 
104  int get_marquee_box_width() const;
105 
109  int get_marquee_step_size() const;
110 
114 
115 public:
116 
120  void set_min(int progress_min);
121 
125  void set_max(int progress_max);
126 
131  void set_range(int progress_min, int progress_max);
132 
136  void set_step_size(int size);
137 
141  void set_position(int pos);
142 
146  void advance_position(int pos);
147 
149  void step_position();
150 
154  void set_marquee_mode(bool enable);
155 
159  void set_marquee_animation_speed(int milliseconds);
160 
164  void set_marquee_box_width(int width);
165 
169  void set_marquee_step_size(int size);
170 
174 
175 private:
176  std::shared_ptr<ProgressBar_Impl> impl;
178 };
179 
180 }
181 
GUI base component class.
Definition: gui_component.h:80
GUIComponent * get_named_item(const std::string &id)
Find child component with the specified component ID name.
Progress bar component.
Definition: progressbar.h:45