scrollbar.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef GUI_WIDGETS_SCROLLBAR_H
#define GUI_WIDGETS_SCROLLBAR_H

#include "gui/widget.h"

namespace GUI {

enum {
    kSetPositionCmd     = 'SETP'
};


class ScrollBarWidget : public Widget, public CommandSender {
protected:
    typedef enum {
        kNoPart,
        kUpArrowPart,
        kDownArrowPart,
        kSliderPart,
        kPageUpPart,
        kPageDownPart
    } Part;

    Part    _part;
    int     _sliderHeight;
    int     _sliderPos;

    Part    _draggingPart;
    int     _sliderDeltaMouseDownPos;

    enum {
        kRepeatInitialDelay = 500,
        kRepeatDelay = 100
    };
    uint32  _repeatTimer;

public:
    int     _numEntries;
    int     _entriesPerPage;
    int     _currentPos;
    int     _singleStep;

public:
    ScrollBarWidget(GuiObject *boss, int x, int y, int w, int h);

    void handleMouseDown(int x, int y, int button, int clickCount) override;
    void handleMouseUp(int x, int y, int button, int clickCount) override;
    void handleMouseWheel(int x, int y, int direction) override;
    void handleMouseMoved(int x, int y, int button) override;
    void handleMouseEntered(int button) override    { setFlags(WIDGET_HILITED); }
    void handleMouseLeft(int button) override   { clearFlags(WIDGET_HILITED); _part = kNoPart; markAsDirty(); }
    void handleTickle() override;
    bool wantsFocus() override { return true; }

    // FIXME - this should be private, but then we also have to add accessors
    // for _numEntries, _entriesPerPage and _currentPos. This again leads to the question:
    // should these accessors force a redraw?
    void recalc();

    void checkBounds(int old_pos);

protected:
    void drawWidget() override;
};

} // End of namespace GUI

#endif