/* 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 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; 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#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;

	/**
	 * Used by descendent classes to split up long text for display across multiple lines
	 */
	Common::String splitLines(const Common::String &str, Common::StringArray &lines, int maxWidth, uint maxLines);

	/**
	 * Ensure that menu is drawn entirely on-screen
	 */
	void restrictToScreen();

	/**
	 * Draw a window frame around the dges of the passed surface
	 */
	void makeInfoArea(Surface &s);

	/**
	 * Draw a window frame around the widget's surface
	 */
	void makeInfoArea();

	/**
	 * Draw a dialog rectangle
	 */
	void drawDialogRect(const Common::Rect &r, bool raised = true);

	/**
	 * Return the area of a widget that the scrollbar will be drawn in
	 */
	virtual Common::Rect getScrollBarBounds() const;

	/**
	 * Draw the scrollbar for the dialog
	 */
	void drawScrollBar(int index, int pageSize, int count);

	/**
	 * Handles any events when the mouse is on the scrollbar
	 */
	void handleScrollbarEvents(int index, int pageSize, int count);

	/**
	 * Handle adjusting a passed scrolling index as necessary
	 */
	void handleScrolling(int &scrollIndex, int pageSize, int max);

	/**
	 * Close the dialog
	 */
	void close();

	/**
	 * Handle drawing the background on the area the widget is going to cover
	 */
	virtual void drawBackground();
public:
	WidgetBase(SherlockEngine *vm);
	virtual ~WidgetBase() {}

	/**
	 * Returns true if the given widget is active in the user interface's widget list
	 */
	bool active() const;

	/**
	 * Erase any previous display of the widget on the screen
	 */
	virtual void erase();

	/**
	 * Update the display of the widget on the screen
	 */
	virtual void draw();

	/**
	 * Used by some descendents to check for keys to mouse the mouse within the dialog
	 */
	void checkTabbingKeys(int numOptions);

	/**
	 * Summon the window
	 */
	virtual void summonWindow();

	/**
	 * Close a currently active menu
	 */
	virtual void banishWindow();

	/**
	 * Handle event processing
	 */
	virtual void handleEvents() {}
};

} // End of namespace Tattoo

} // End of namespace Sherlock

#endif