widgets/scrollarea.hpp

Go to the documentation of this file.

/* $Id: scrollarea.hpp 52533 2012-01-07 02:35:17Z shadowmaster $ */
/*
   Copyright (C) 2004 - 2012 by Guillaume Melquiond <guillaume.melquiond@gmail.com>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

/** @file */

#ifndef SCROLLAREA_HPP_INCLUDED
#define SCROLLAREA_HPP_INCLUDED

#include "scrollbar.hpp"

namespace gui {

class scrollarea : public widget
{
public:
    /**
     * Create a zone with automatic handling of scrollbar.
     * @todo FIXME: parameterlist ??
     */
    //- \param d the display object
    //- \param pane the widget where wheel events take place
    scrollarea(CVideo &video, bool auto_join=true);

    virtual void hide(bool value = true);

protected:
    virtual handler_vector handler_members();
    virtual void update_location(SDL_Rect const &rect);
    virtual void handle_event(const SDL_Event& event);
    virtual void process_event();
    virtual void scroll(unsigned int pos) = 0;
    virtual void set_inner_location(SDL_Rect const &rect) = 0;

    SDL_Rect inner_location() const;
    unsigned scrollbar_width() const;

    unsigned get_position() const;
    unsigned get_max_position() const;
    void set_position(unsigned pos);
    void adjust_position(unsigned pos);
    void move_position(int dep);
    void set_shown_size(unsigned h);
    void set_full_size(unsigned h);
    void set_scroll_rate(unsigned r);
    bool has_scrollbar() const;

private:
    scrollbar scrollbar_;
    int old_position_;
    bool recursive_, shown_scrollbar_;
    unsigned shown_size_;
    unsigned full_size_;

    void test_scrollbar();
};

} // end namespace gui

#endif