scrollbar.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
**    Kenneth Gangstoe
*/


#pragma once

#include "../api_gui.h"
#include "../gui_component.h"
#include "../../Core/Signals/callback_v0.h"

class CL_ScrollBar_Impl;

class CL_API_GUI CL_ScrollBar : public CL_GUIComponent
{
public:

        CL_ScrollBar(CL_GUIComponent *parent);

        virtual ~CL_ScrollBar();

public:

        bool is_vertical() const;

        bool is_horizontal() const;

        int get_min() const;

        int get_max() const;

        int get_line_step() const;

        int get_page_step() const;

        int get_position() const;

        virtual CL_Size get_preferred_size() const;

        int get_preferred_width() const;

        int get_preferred_height() const;

public:

        void set_vertical();

        void set_horizontal();

        void set_min(int scroll_min);

        void set_max(int scroll_max);

        void set_line_step(int step);

        void set_page_step(int step);

        void set_ranges(int scroll_min, int scroll_max, int line_step, int page_step);


        void calculate_ranges(int view_size, int total_size);

        void set_position(int pos);

public:
        CL_Callback_v0 &func_scroll();

        CL_Callback_v0 &func_scroll_min();

        CL_Callback_v0 &func_scroll_max();

        CL_Callback_v0 &func_scroll_line_decrement();

        CL_Callback_v0 &func_scroll_line_increment();

        CL_Callback_v0 &func_scroll_page_decrement();

        CL_Callback_v0 &func_scroll_page_increment();

        CL_Callback_v0 &func_scroll_thumb_release();

        CL_Callback_v0 &func_scroll_thumb_track();

        CL_Callback_v0 &func_scroll_end();


private:
        CL_SharedPtr<CL_ScrollBar_Impl> impl;
};

---