spin.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 **    Kenneth Gangstoe
00029 */
00030 
00033 
00034 #pragma once
00035 
00036 #include "../api_gui.h"
00037 #include "../gui_component.h"
00038 
00039 class CL_Spin_Impl;
00040 
00044 class CL_API_GUI CL_Spin : public CL_GUIComponent
00045 {
00048 public:
00049 
00053         CL_Spin(CL_GUIComponent *parent);
00054 
00055         virtual ~CL_Spin();
00056 
00060 public:
00061 
00062         
00063         using CL_GUIComponent::get_named_item;
00064 
00068         static CL_Spin *get_named_item(CL_GUIComponent *reference_component, const CL_StringRef &id);
00069 
00073         int get_value() const;
00074 
00078         float get_value_float() const;
00079 
00083         int get_min() const;
00084 
00088         int get_max() const;
00089 
00093         float get_min_float() const;
00094 
00098         float get_max_float() const;
00099 
00103         bool get_floating_point_mode() const;
00104 
00108 public:
00109 
00113         void set_value(int value);
00114 
00118         void set_value_float(float value);
00119 
00124         void set_ranges(int min, int max);
00125 
00130         void set_ranges_float(float min, float max);
00131 
00135         void set_step_size(int step_size);
00136 
00140         void set_step_size_float(float step_size);
00141 
00145         void set_number_of_decimal_places(int decimal_places);
00146 
00150         void set_floating_point_mode(bool use_floating_point);
00151 
00155 public:
00156 
00160         CL_Callback_v0 &func_value_changed();
00161 
00165 private:
00166         CL_SharedPtr<CL_Spin_Impl> impl;
00168 };
00169