1

/* $Id$ */

     2

     3

#ifndef WIDGET_H

     4

#define WIDGET_H

     5

     6

     7

#include <list>

     8

#include <map>

     9

#include "../macros.h"

    10

#include "../string.h"

    11

#include "../order.h"

    12

#include "../rail.h"

    13

#include "../airport.h"

    14

#include "../misc/rect.hpp"

    15

#include "../misc/countedptr.hpp"

    16

    17

#include "window_event_base.h"

    18

    19

enum FrameFlags {

    20

	FR_NONE         = 0x00,

    21

	FR_TRANSPARENT  = 0x01,  ///< Makes the background transparent if set

    22

	FR_BORDERONLY   = 0x10,  ///< Draw border only, no background

    23

	FR_LOWERED      = 0x20,  ///< If set the frame is lowered and the background color brighter (ie. buttons when pressed)

    24

	FR_DARKENED     = 0x40,  ///< If set the background is darker, allows for lowered frames with normal background color when used with FR_LOWERED (ie. dropdown boxes)

    25

};

    26

    27

DECLARE_ENUM_AS_BIT_SET(FrameFlags);

    28

    38

    39

namespace gui {

    40

    41

struct Widget;

    42

typedef CCountedPtr<Widget> WidgetPtr;

    43

    44

struct CompositeWidget;

    45

typedef CCountedPtr<CompositeWidget> CompositeWidgetPtr;

    46

    47

typedef int32 WidgetId;

    48

    49

struct Widget : public SimpleCountedObject {

    50

	typedef AdaptT<EventHandlerDelegatePtr> Handler;

    51

	typedef std::list<Handler> Handlers;

    52

    53

	CompositeWidget *m_container;       ///< widget container (can be any panel or window)

    54

	WidgetId        m_id;               ///< Widget id in its container

    55

	Rect16          m_rect;             ///< The position offsets relative to the container

    56

	uint16          m_data;             ///< The String/Image or special code (list-matrices) of a widget

    57

	byte            m_display_flags;    ///< Resize direction, alignment, etc. during resizing, see @ResizeFlags

    58

	byte            m_color;            ///< Widget color, see docs/ottd-colourtext-palette.png

    59

	bool            m_is_closing : 1;   ///< Widget was logically destroyed

    60

	bool            m_dont_clip : 1;    ///< should not be clipped by parent (container)

    61

	StringID        m_tooltips;         ///< Tooltips that are shown when right clicking on a widget

    63

	Handlers        m_handlers;         ///< dynamically registered event handlers

    64

    65

	Widget()

    66

		: m_container(NULL), m_id(0), m_rect(), m_data(0), m_display_flags(0), m_color(0)

    68

	{}

    69

    70

	Widget(CompositeWidget *container, WidgetId id, byte display_flags, byte color, const Rect16 &rect, StringID tooltips)

    71

		: m_container(container)

    72

		, m_id(id)

    73

		, m_rect(rect)

    74

		, m_data(0)

    75

		, m_display_flags(display_flags)

    76

		, m_color(color)

    77

		, m_is_closing(false)

    78

		, m_dont_clip(false)

    79

		, m_tooltips(tooltips)

    81

	{}

    82

    83

	int16 Left() const;

    84

	int16 Top() const;

    85

	int16 Right() const;

    86

	int16 Bottom() const;

    87

	int16 Width() const;

    88

	int16 Height() const;

    89

	const Point16& TopLeft() const;

    90

	const Point16& BottomRight() const;

    91

	Point16 Size() const;

    92

	Point16 CenterPt() const;

    93

	const Rect16& GetRect() const;

    94

    95

	void SetLeft(int16 val);

    96

	void SetTop(int16 val);

    97

	void SetRight(int16 val);

    98

	void SetBottom(int16 val);

    99

	void SetWidth(int16 val);

   100

	void SetHeight(int16 val);

   101

	void SetTopLeft(const Point16 &pt);

   102

	void SetBottomRight(const Point16 &pt);

   103

	void SetSize(const Point16 &pt);

   104

	void SetRect(const Rect16 &rect);

   105

   108

	WidgetId GetId() const;

   109

   110

	void AddHandler(EventHandlerDelegate *d);

   111

	void CallHandlers(EventBase &e);

   112

   113

	void Invalidate() {}; ///< now we redraw gui all the time, so no processing is needed here

   114

	static /*static*/ void FillRect(const Rect16 &rc, int color);

   115

	static void DrawFrameRect(int left, int top, int right, int bottom, int ctab, FrameFlags flags);

   116

	void DrawFrameRect(int ctab, FrameFlags flags);

   117

   118

	virtual BaseWindow* GetWindow();

   119

	virtual Widget* WidgetFromPt(const Point16 &pt);

   120

   121

	virtual void Close();

   122

   123

	virtual void DrawBackground(EvtPaint &ev);

   124

   125

	/**

   126

	 * OnCreate() handler called when window gets created. Override this method in your

   127

	 * Window subclass and place widgets into your window from there.

   128

	 */

   129

	virtual void OnCreate(EvtCreate &ev) {};

   130

	virtual void OnDestroy(EvtDestroy &ev) {};

   131

	virtual void OnPaint(EvtPaint &ev) = 0;

   132

	virtual void OnKeyPress(EvtKeyPress &ev) {};

   133

	virtual void OnLeftClick(EvtClick &ev);

   134

	virtual void OnRightClick(EvtRightClick &ev);

   135

	virtual void OnMouseOver(EvtMouseOver &ev) {};

   138

   139

	/**

   140

	 * Dispatch event by its type calling appropriate OnCreate(), OnDestroy(), etc.

   141

	 */

   142

	virtual void DispatchEvent(EventBase &ev);

   143

   144

	/**

   145

	 * @function AddReflectHandlerT Registers reflected event handler. Use it from

   146

	 * BaseWindow subclasses (Window implementations) to register custom event handler.

   147

	 * For example if you are implementing 'MyWindow' class and want to handle OnLeftClick()

   148

	 * event for your button 'MyButton', define your handler method inside 'MyWindow' class

   149

	 * like:

   150

	 *       void MyWindow::MyButtonClickHandler(gui::EvtClick &e)

   151

	 *       {

   152

	 *          ...

   153

	 *       }

   154

	 * then from inside OnCreate() handler, create your button 'my_button' and

   155

	 * call:

   156

	 *       my_button->AddReflectHandlerT(&MyWindow::MyButtonClickHandler);

   157

	 * and your MyButtonClickHandler will be called on every click on my_button.

   158

	 */

   159

	template <class Twnd_cls, EventCode Tevt_code> void AddReflectHandlerT(void (Twnd_cls::*handler)(gui::EventT<Tevt_code>&))

   160

	{

   161

		typedef ReflectHandlerDelegateT<Twnd_cls, Tevt_code> Delegate;

   162

		AddHandler(new Delegate(handler));

   163

	}

   164

   165

	/** add capture handler using default delegate type (CaptureHandlerDelegateT<>) */

   166

	template <class Twd_cls, EventCode Tevt_code> CaptureTicket CaptureEventsT(Twd_cls *wd, void (Twd_cls::*handler)(EventT<Tevt_code>&))

   167

	{

   168

		CaptureTicket ticket = EventCaptureStack::AddHandler(new CaptureHandlerDelegateT<Twd_cls, Tevt_code>(wd, handler));

   169

		return ticket;

   170

	}

   171

   172

};

   173

   174

struct CompositeWidget : public Widget {

   175

	typedef Widget super;

   176

	typedef std::map<WidgetId, WidgetPtr> Widgets;

   177

	typedef Widgets::iterator WidgetIterator;

   178

	typedef Widgets::reverse_iterator WidgetReverseIterator;

   179

   180

protected:

   181

	Widgets m_widgets;

   182

   183

public:

   184

	CompositeWidget()

   185

		: Widget()

   186

	{}

   187

   188

	CompositeWidget(CompositeWidget *container, WidgetId id, byte display_flags, byte color, const Rect16 &rect, StringID tooltips)

   189

		: Widget(container, id, display_flags, color, rect, tooltips)

   190

	{}

   191

   192

	void AddWidget(Widget *wd);

   193

	Widget* GetWidget(WidgetId id);

   194

	Widget* RemoveWidget(WidgetId id);

   195

   196

	/*virtual*/ Widget* WidgetFromPt(const Point16 &pt);

   197

   198

	virtual void Close();

   199

   201

	/*virtual*/ void OnPaint(EvtPaint &ev);

   202

	/*virtual*/ void OnLeftClick(EvtClick &ev);

   203

	/*virtual*/ void OnRightClick(EvtRightClick &ev);

   205

};

   206

   207

struct Button : public Widget {

   208

	typedef Widget super;

   209

   210

protected:

   211

	bool m_pushed;

   212

	CaptureTicket m_ticket_pressed;

   213

   214

public:

   215

	Button()

   216

		: Widget()

   217

		, m_pushed(false)

   218

	{}

   219

   220

	Button(CompositeWidget *container, WidgetId id, byte display_flags, byte color, const Rect16 &rect, StringID tooltips)

   221

		: Widget(container, id, display_flags, color, rect, tooltips)

   222

		, m_pushed(false)

   223

	{}

   224

   225

	void OnCapturePressed(EvtMouseOver &e);

   226

   227

	/*virtual*/ void DrawBackground(EvtPaint &ev);

   228

   229

	/*virtual*/ void OnLeftClick(EvtClick &ev);

   230

};

   231

   232

struct TextButton : public Button {

   233

	typedef Button super;

   234

   235

protected:

   236

	StringID m_text;

   237

   238

public:

   239

	TextButton()

   240

		: Button()

   241

	{}

   242

   243

	TextButton(CompositeWidget *container, WidgetId id, byte display_flags, byte color, const Rect16 &rect, StringID tooltips, StringID text)

   244

		: Button(container, id, display_flags, color, rect, tooltips)

   245

		, m_text(text)

   246

	{}

   247

   248

	/*virtual*/ void OnPaint(EvtPaint &ev);

   249

};

   250

   280

struct CaptionBar : public CompositeWidget {

   281

	typedef CompositeWidget super;

   282

   283

	static const int16 DEFAULT_HEIGHT = 14;

   284

   285

protected:

   286

	StringID      m_text;

   287

	byte          m_text_color;

   288

	Point16       m_moving_offset;

   289

	CaptureTicket m_ticket_moving;

   290

   291

public:

   292

	CaptionBar()

   293

		: CompositeWidget()

   294

		, m_text(0)

   295

		, m_text_color(0xFF)

   296

	{}

   297

   298

	CaptionBar(CompositeWidget *container, WidgetId id, byte display_flags, byte color, byte text_color, StringID tooltips, StringID text)

   299

		: CompositeWidget(container, id, display_flags, color, Rect16(0, 0, container->Width() - 1, DEFAULT_HEIGHT - 1), tooltips)

   300

		, m_text(text)

   301

		, m_text_color(text_color)

   302

	{}

   303

   304

	/*virtual*/ void DrawBackground(EvtPaint &ev);

   305

   307

	/*virtual*/ void OnPaint(EvtPaint &ev);

   308

	/*virtual*/ void OnLeftClick(EvtClick &ev);

   309

	void OnCaptureMoving(EvtMouseOver &e);

   310

};

   311

   312

   313

   314

   315

   316

   317

   318

   319

   320

   321

   322

}; // namespace gui

   323

   324

   325

#endif /* WIDGET_H */