progressbar.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 **    Kenneth Gangstoe
00028 **    Harry Storbacka
00029 */
00030 
00033 
00034 #pragma once
00035 
00036 #include "../api_gui.h"
00037 #include "../gui_component.h"
00038 
00039 class CL_ProgressBar_Impl;
00040 
00044 class CL_API_GUI CL_ProgressBar : public CL_GUIComponent
00045 {
00048 
00049 public:
00050 
00054         CL_ProgressBar(CL_GUIComponent *parent);
00055 
00056         virtual ~CL_ProgressBar();
00057 
00061 
00062 public:
00063         using CL_GUIComponent::get_named_item;
00064 
00068         static CL_ProgressBar *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
00069 
00073         int get_min() const;
00074 
00078         int get_max() const;
00079 
00083         int get_step_size() const;
00084 
00088         int get_position() const;
00089 
00093         bool is_marquee_mode() const;
00094 
00098         int get_marquee_animation_speed() const;
00099 
00103         int get_marquee_box_width() const;
00104 
00108         int get_marquee_step_size() const;
00109 
00113 
00114 public:
00115 
00119         void set_min(int progress_min);
00120 
00124         void set_max(int progress_max);
00125 
00130         void set_range(int progress_min, int progress_max);
00131 
00135         void set_step_size(int size);
00136 
00140         void set_position(int pos);
00141 
00145         void advance_position(int pos);
00146 
00148         void step_position();
00149 
00153         void set_marquee_mode(bool enable);
00154 
00158         void set_marquee_animation_speed(int milliseconds);
00159 
00163         void set_marquee_box_width(int width);
00164         
00168         void set_marquee_step_size(int size);
00169 
00173 
00174 private:
00175         CL_SharedPtr<CL_ProgressBar_Impl> impl;
00177 };
00178