slider.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 **    Harry Storbacka
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_gui.h"
00036 #include "../gui_component.h"
00037 
00038 class CL_Slider_Impl;
00039 
00043 class CL_API_GUI CL_Slider : public CL_GUIComponent
00044 {
00047 
00048 public:
00049 
00053         CL_Slider(CL_GUIComponent *parent);
00054 
00055         virtual ~CL_Slider();
00056 
00060 
00061 public:
00062         using CL_GUIComponent::get_named_item;
00063 
00067         static CL_Slider *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
00068 
00072         bool is_vertical() const;
00073 
00077         bool is_horizontal() const;
00078 
00082         int get_min() const;
00083 
00087         int get_max() const;
00088 
00092         int get_tick_count() const;
00093 
00097         int get_page_step() const;
00098 
00102         int get_position() const;
00103 
00107         bool get_lock_to_ticks() const;
00108 
00112         CL_Size get_preferred_size() const;
00113 
00117 
00118 public:
00119 
00123         void set_vertical(bool enable);
00124 
00128         void set_horizontal(bool enable);
00129 
00133         void set_min(int slider_min);
00134 
00138         void set_max(int slider_max);
00139 
00143         void set_tick_count(int tick_count);
00144 
00148         void set_page_step(int steps);
00149 
00153         void set_lock_to_ticks(bool lock);
00154 
00161         void set_ranges(int slider_min, int slider_max, unsigned int tick_count, int page_step);
00162 
00166         void set_position(int pos);
00167 
00171 
00172 public:
00174         CL_Callback_v0 &func_value_changed();
00175 
00177 
00178         CL_Callback_v0 &func_value_decremented();
00179 
00181 
00182         CL_Callback_v0 &func_value_incremented();
00183 
00185         CL_Callback_v0 &func_slider_moved();
00186 
00190 
00191 private:
00192         CL_SharedPtr<CL_Slider_Impl> impl;
00194 };
00195