scummvm-cursorfix/engines/hpl1/engine/gui/Widget.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/>.
 *
 */

/*
 * Copyright (C) 2006-2010 - Frictional Games
 *
 * This file is part of HPL1 Engine.
 */

#ifndef HPL_WIDGET_H
#define HPL_WIDGET_H

#include "common/array.h"
#include "common/list.h"
#include "hpl1/engine/gui/GuiTypes.h"
#include "hpl1/engine/system/low_level_system.h"

namespace hpl {

class cGui;
class cGuiSet;
class cGuiSkin;
class cGuiSkinFont;

class cGuiGfxElement;
class cGuiClipRegion;

class FontData;

//--------------------------------

struct cWidgetCallback {
	cWidgetCallback(void *apObject, tGuiCallbackFunc apFunc) {
		mpObject = apObject;
		mpFunc = apFunc;
	}

	void *mpObject;
	tGuiCallbackFunc mpFunc;
};

typedef Common::List<cWidgetCallback> tWidgetCallbackList;
typedef tWidgetCallbackList::iterator tWidgetCallbackListIt;

//--------------------------------

class iWidget {
	friend class cGuiSet;

public:
	iWidget(eWidgetType aType, cGuiSet *apSet, cGuiSkin *apSkin);
	virtual ~iWidget();

	/////////////////////////
	// General
	void Update(float afTimeStep);

	void Draw(float afTimeStep, cGuiClipRegion *apClipRegion);

	bool ProcessMessage(eGuiMessage aMessage, cGuiMessageData &aData);

	void AddCallback(eGuiMessage aMessage, void *apObject, tGuiCallbackFunc apFunc);

	eWidgetType GetType() { return mType; }

	void Init();

	/////////////////////////
	// Public Helper functions
	bool PointIsInside(const cVector2f &avPoint, bool abOnlyClipped);

	/////////////////////////
	// Hierarchy
	void AttachChild(iWidget *apChild);
	void RemoveChild(iWidget *apChild);

	/////////////////////////
	// Properties
	cGuiSet *GetSet() { return mpSet; }

	iWidget *GetParent() { return mpParent; }

	void SetEnabled(bool abX);
	bool IsEnabled();
	void SetVisible(bool abX);
	bool IsVisible();

	bool HasFocus();

	void SetName(const tString &asName) { msName = asName; }
	const tString &GetName() { return msName; }

	void SetText(const tWString &asText);
	const tWString &GetText() { return msText; }

	FontData *GetDefaultFontType() { return mpDefaultFontType; }
	void SetDefaultFontType(FontData *apFont) { mpDefaultFontType = apFont; }

	const cColor &GetDefaultFontColor() { return mDefaultFontColor; }
	void SetDefaultFontColor(const cColor &aColor) { mDefaultFontColor = aColor; }

	const cVector2f &GetDefaultFontSize() { return mvDefaultFontSize; }
	void SetDefaultFontSize(const cVector2f &avSize) { mvDefaultFontSize = avSize; }

	void SetClipActive(bool abX) { mbClipsGraphics = abX; }
	bool GetClipActive() { return mbClipsGraphics; }

	void SetPosition(const cVector3f &avPos);
	void SetGlobalPosition(const cVector3f &avPos);
	const cVector3f &GetLocalPosition();
	const cVector3f &GetGlobalPosition();

	void SetSize(const cVector2f &avSize);
	cVector2f GetSize() { return mvSize; }

	bool ClipsGraphics();

	bool GetMouseIsOver() { return mbMouseIsOver; }

	bool IsConnectedTo(iWidget *apWidget, bool abIsStartWidget = true);
	bool IsConnectedToChildren() { return mbConnectedToChildren; }
	void SetConnectedToChildren(bool abX) { mbConnectedToChildren = abX; }

	cGuiGfxElement *GetPointerGfx();

protected:
	/////////////////////////
	// Upper Widget functions
	virtual void OnLoadGraphics() {}

	virtual void OnChangeSize() {}
	virtual void OnChangePosition() {}
	virtual void OnChangeText() {}

	virtual void OnInit() {}

	virtual void OnDraw(float afTimeStep, cGuiClipRegion *apClipRegion) {}
	virtual void OnDrawAfterClip(float afTimeStep, cGuiClipRegion *apClipRegion) {}

	virtual void OnUpdate(float afTimeStep) {}

	virtual bool OnMessage(eGuiMessage aMessage, cGuiMessageData &aData) { return false; }
	virtual bool OnMouseMove(cGuiMessageData &aData) { return false; }
	virtual bool OnMouseDown(cGuiMessageData &aData) { return false; }
	virtual bool OnMouseUp(cGuiMessageData &aData) { return false; }
	virtual bool OnMouseDoubleClick(cGuiMessageData &aData) { return false; }
	virtual bool OnMouseEnter(cGuiMessageData &aData) { return false; }
	virtual bool OnMouseLeave(cGuiMessageData &aData) { return false; }

	virtual bool OnGotFocus(cGuiMessageData &aData);
	virtual bool OnLostFocus(cGuiMessageData &aData) { return false; }

	virtual bool OnKeyPress(cGuiMessageData &aData) { return false; }

	/////////////////////////
	// Private Helper functions
	cVector3f WorldToLocalPosition(const cVector3f &avPos);
	cVector2f GetPosRelativeToMouse(cGuiMessageData &aData);

	// The order must be like this:
	// Borders: Right, Left, Up and Down
	// Corners: LEftUp, RightUp, RightDown and LEftDown.
	void DrawBordersAndCorners(cGuiGfxElement *apBackground,
							   cGuiGfxElement **apBorderVec, cGuiGfxElement **apCornerVec,
							   const cVector3f &avPosition, const cVector2f &avSize);

	void DrawSkinText(const tWString &asText, eGuiSkinFont aFont, const cVector3f &avPosition,
					  eFontAlign aAlign = eFontAlign_Left);

	void DrawDefaultText(const tWString &asText,
						 const cVector3f &avPosition, eFontAlign aAlign);

	void SetPositionUpdated();

	void LoadGraphics();

	/////////////////////////
	// Variables
	cGuiSet *mpSet;
	cGuiSkin *mpSkin;
	cGui *mpGui;

	tWString msText;
	cVector3f mvPosition;
	cVector3f mvGlobalPosition;
	cVector2f mvSize;

	tString msName;

	eWidgetType mType;

	int mlPositionCount;

	cGuiSkinFont *mpDefaultFont;
	FontData *mpDefaultFontType;
	cColor mDefaultFontColor;
	cVector2f mvDefaultFontSize;

	iWidget *mpParent;

	tWidgetList mlstChildren;

	bool mbEnabled;
	bool mbVisible;

	bool mbMouseIsOver;

	bool mbClipsGraphics;

	cGuiGfxElement *mpPointerGfx;

	bool mbConnectedToChildren;

private:
	void SetMouseIsOver(bool abX) { mbMouseIsOver = abX; }
	bool ProcessCallbacks(eGuiMessage aMessage, cGuiMessageData &aData);

	Common::Array<tWidgetCallbackList> mvCallbackLists;

	bool mbPositionIsUpdated;
};

} // namespace hpl

#endif // HPL_WIDGET_H