widget_base.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 SHERLOCK_TATTOO_WIDGET_BASE_H
#define SHERLOCK_TATTOO_WIDGET_BASE_H

#include "common/scummsys.h"
#include "common/rect.h"
#include "common/str-array.h"
#include "sherlock/surface.h"

namespace Sherlock {

class SherlockEngine;
class ImageFile;

namespace Tattoo {

class WidgetBase {
private:
    uint32 _dialogTimer;
protected:
    SherlockEngine *_vm;
    Common::Rect _bounds;
    Common::Rect _oldBounds;
    Surface _surface;
    bool _outsideMenu;
    bool _scroll;

    Common::String splitLines(const Common::String &str, Common::StringArray &lines, int maxWidth, uint maxLines);

    void restrictToScreen();

    void makeInfoArea(Surface &s);

    void makeInfoArea();

    void drawDialogRect(const Common::Rect &r, bool raised = true);

    virtual Common::Rect getScrollBarBounds() const;

    void drawScrollBar(int index, int pageSize, int count);

    void handleScrollbarEvents(int index, int pageSize, int count);

    void handleScrolling(int &scrollIndex, int pageSize, int max);

    void close();

    virtual void drawBackground();
public:
    WidgetBase(SherlockEngine *vm);
    virtual ~WidgetBase() {}

    bool active() const;

    virtual void erase();

    virtual void draw();

    void checkTabbingKeys(int numOptions);

    virtual void summonWindow();

    virtual void banishWindow();

    virtual void handleEvents() {}
};

} // End of namespace Tattoo

} // End of namespace Sherlock

#endif