scrollbar.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 #include "../../Core/Signals/callback_v0.h"
00039 
00040 class CL_ScrollBar_Impl;
00041 
00045 class CL_API_GUI CL_ScrollBar : public CL_GUIComponent
00046 {
00049 public:
00050 
00054         CL_ScrollBar(CL_GUIComponent *parent);
00055 
00056         virtual ~CL_ScrollBar();
00057 
00061 public:
00062         using CL_GUIComponent::get_named_item;
00063 
00067         static CL_ScrollBar *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_line_step() const;
00093 
00097         int get_page_step() const;
00098 
00102         int get_position() const;
00103 
00107         virtual CL_Size get_preferred_size() const;
00108 
00110         int get_preferred_width() const;
00111 
00113         int get_preferred_height() const;
00114 
00118 public:
00119 
00121         void set_vertical();
00122 
00124         void set_horizontal();
00125 
00129         void set_min(int scroll_min);
00130 
00134         void set_max(int scroll_max);
00135 
00139         void set_line_step(int step);
00140 
00144         void set_page_step(int step);
00145 
00152         void set_ranges(int scroll_min, int scroll_max, int line_step, int page_step);
00153 
00155 
00159         void calculate_ranges(int view_size, int total_size);
00160 
00164         void set_position(int pos);
00165 
00169 public:
00171         CL_Callback_v0 &func_scroll();
00172 
00174         CL_Callback_v0 &func_scroll_min();
00175 
00177         CL_Callback_v0 &func_scroll_max();
00178 
00180         CL_Callback_v0 &func_scroll_line_decrement();
00181 
00183         CL_Callback_v0 &func_scroll_line_increment();
00184 
00186         CL_Callback_v0 &func_scroll_page_decrement();
00187 
00189         CL_Callback_v0 &func_scroll_page_increment();
00190 
00192         CL_Callback_v0 &func_scroll_thumb_release();
00193 
00195         CL_Callback_v0 &func_scroll_thumb_track();
00196 
00198         CL_Callback_v0 &func_scroll_end();
00199 
00203 
00204 private:
00205         CL_SharedPtr<CL_ScrollBar_Impl> impl;
00207 };
00208