1

/* $Id$ */

     2

     3

/** @file window_gui.h Functions, definitions and such used only by the GUI. */

     4

     5

#ifndef WINDOW_GUI_H

     6

#define WINDOW_GUI_H

     7

     8

#include "core/bitmath_func.hpp"

     9

#include "core/geometry_type.hpp"

    10

#include "vehicle_type.h"

    11

#include "viewport_type.h"

    12

#include "player_type.h"

    13

#include "strings_type.h"

    14

#include "core/alloc_type.hpp"

    15

#include "window_type.h"

    16

#include "tile_type.h"

    17

    18

/**

    19

 * The maximum number of windows that can be opened.

    20

 */

    21

static const int MAX_NUMBER_OF_WINDOWS = 25;

    22

    23

typedef void WindowProc(Window *w, WindowEvent *e);

    24

    25

/* How the resize system works:

    26

    First, you need to add a WWT_RESIZEBOX to the widgets, and you need

    27

     to add the flag WDF_RESIZABLE to the window. Now the window is ready

    28

     to resize itself.

    29

    As you may have noticed, all widgets have a RESIZE_XXX in their line.

    30

     This lines controls how the widgets behave on resize. RESIZE_NONE means

    31

     it doesn't do anything. Any other option let's one of the borders

    32

     move with the changed width/height. So if a widget has

    33

     RESIZE_RIGHT, and the window is made 5 pixels wider by the user,

    34

     the right of the window will also be made 5 pixels wider.

    35

    Now, what if you want to clamp a widget to the bottom? Give it the flag

    36

     RESIZE_TB. This is RESIZE_TOP + RESIZE_BOTTOM. Now if the window gets

    37

     5 pixels bigger, both the top and bottom gets 5 bigger, so the whole

    38

     widgets moves downwards without resizing, and appears to be clamped

    39

     to the bottom. Nice aint it?

    40

   You should know one more thing about this system. Most windows can't

    41

    handle an increase of 1 pixel. So there is a step function, which

    42

    let the windowsize only be changed by X pixels. You configure this

    43

    after making the window, like this:

    44

      w->resize.step_height = 10;

    45

    Now the window will only change in height in steps of 10.

    46

   You can also give a minimum width and height. The default value is

    47

    the default height/width of the window itself. You can change this

    48

    AFTER window - creation, with:

    49

     w->resize.width or w->resize.height.

    50

   That was all.. good luck, and enjoy :) -- TrueLight */

    51

    52

enum ResizeFlag {

    53

	RESIZE_NONE   = 0,  ///< no resize required

    54

    55

	RESIZE_LEFT   = 1,  ///< left resize flag

    56

	RESIZE_RIGHT  = 2,  ///< rigth resize flag

    57

	RESIZE_TOP    = 4,  ///< top resize flag

    58

	RESIZE_BOTTOM = 8,  ///< bottom resize flag

    59

    60

	RESIZE_LR     = RESIZE_LEFT  | RESIZE_RIGHT,   ///<  combination of left and right resize flags

    61

	RESIZE_RB     = RESIZE_RIGHT | RESIZE_BOTTOM,  ///<  combination of right and bottom resize flags

    62

	RESIZE_TB     = RESIZE_TOP   | RESIZE_BOTTOM,  ///<  combination of top and bottom resize flags

    63

	RESIZE_LRB    = RESIZE_LEFT  | RESIZE_RIGHT  | RESIZE_BOTTOM, ///< combination of left, right and bottom resize flags

    64

	RESIZE_LRTB   = RESIZE_LEFT  | RESIZE_RIGHT  | RESIZE_TOP | RESIZE_BOTTOM,  ///<  combination of all resize flags

    65

	RESIZE_RTB    = RESIZE_RIGHT | RESIZE_TOP    | RESIZE_BOTTOM, ///<  combination of right, top and bottom resize flag

    66

    67

	/* The following flags are used by the system to specify what is disabled, hidden, or clicked

    68

	 * They are used in the same place as the above RESIZE_x flags, Widget visual_flags.

    69

	 * These states are used in exceptions. If nothing is specified, they will indicate

    70

	 * Enabled, visible or unclicked widgets*/

    71

	WIDG_DISABLED = 4,  ///< widget is greyed out, not available

    72

	WIDG_HIDDEN   = 5,  ///< widget is made invisible

    73

	WIDG_LOWERED  = 6,  ///< widget is paint lowered, a pressed button in fact

    74

};

    75

    76

enum {

    77

	WIDGET_LIST_END = -1, ///< indicate the end of widgets' list for vararg functions

    78

};

    79

    80

/**

    81

 * Window widget data structure

    82

 */

    83

struct Widget {

    84

	byte type;                        ///< Widget type, see WindowWidgetTypes

    85

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

    86

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

    87

	int16 left, right, top, bottom;   ///< The position offsets inside the window

    88

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

    89

	StringID tooltips;                ///< Tooltips that are shown when rightclicking on a widget

    90

};

    91

    92

/**

    93

 * Flags to describe the look of the frame

    94

 */

    95

enum FrameFlags {

    96

	FR_NONE         =  0,

    97

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

    98

	FR_BORDERONLY   =  1 << 4,  ///< Draw border only, no background

    99

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

   100

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

   101

};

   102

   103

DECLARE_ENUM_AS_BIT_SET(FrameFlags);

   104

   105

/* wiget.cpp */

   106

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

   107

   108

/**

   109

 * Available window events

   110

 */

   111

enum WindowEventCodes {

   112

	WE_CREATE,       ///< Initialize the Window

   113

	WE_DESTROY,      ///< Prepare for deletion of the window

   114

	WE_PAINT,        ///< Repaint the window contents

   115

	WE_KEYPRESS,     ///< Key pressed

   116

	WE_CLICK,        ///< Left mouse button click

   117

	WE_MOUSELOOP,    ///< Event for each mouse event in the game (at least once every game tick)

   118

	WE_TICK,         ///< Regularly occurring event (every game tick)

   119

	WE_100_TICKS,    ///< Regularly occurring event (every 100 game ticks, approximatelly 3 seconds)

   120

	WE_TIMEOUT,

   121

	WE_PLACE_OBJ,

   122

	WE_ABORT_PLACE_OBJ,

   123

	WE_ON_EDIT_TEXT,

   124

	WE_PLACE_DRAG,

   125

	WE_PLACE_MOUSEUP,

   126

	WE_PLACE_PRESIZE,

   127

	WE_DROPDOWN_SELECT,

   128

	WE_RESIZE,          ///< Request to resize the window, @see WindowEvent.we.resize

   129

	WE_INVALIDATE_DATA, ///< Notification that data displayed by the window is obsolete

   130

	WE_CTRL_CHANGED,    ///< CTRL key has changed state

   131

};

   132

   133

/**

   134

 * Data structures for additional data associated with a window event

   135

 * @see WindowEventCodes

   136

 */

   137

struct WindowEvent {

   138

	byte event;

   139

	union {

   140

		struct {

   141

			Point pt;

   142

			int widget;

   143

		} click;

   144

   145

		struct {

   146

			Point pt;

   147

			TileIndex tile;

   148

			TileIndex starttile;

   149

			ViewportPlaceMethod select_method;

   150

			byte select_proc;

   151

		} place;

   152

   153

		struct {

   154

			Point pt;

   155

			int widget;

   156

		} dragdrop;

   157

   158

		struct {

   159

			Point size;

   160

			Point diff;

   161

		} sizing;

   162

   163

		struct {

   164

			char *str;

   165

		} edittext;

   166

   167

		struct {

   168

			int button;

   169

			int index;

   170

		} dropdown;

   171

   172

		struct {

   173

			bool cont;      ///< continue the search? (default true)

   174

			uint16 key;     ///< 16-bit Unicode value of the key

   175

			uint16 keycode; ///< untranslated key (including shift-state)

   176

		} keypress;

   177

   178

		struct {

   179

			int data;

   180

		} invalidate;

   181

   182

		struct {

   183

			bool cont;     ///< continue the search? (default true)

   184

		} ctrl;

   185

	} we;

   186

};

   187

   188

/**

   189

 * High level window description

   190

 */

   191

struct WindowDesc {

   192

	int16 left;             ///< Prefered x position of left edge of the window, @see WindowDefaultPosition()

   193

	int16 top;              ///< Prefered y position of the top of the window, @see WindowDefaultPosition()

   194

	int16 minimum_width;    ///< Minimal width of the window

   195

	int16 minimum_height;   ///< Minimal height of the window

   196

	int16 default_width;    ///< Prefered initial width of the window

   197

	int16 default_height;   ///< Prefered initial height of the window

   198

	WindowClass cls;        ///< Class of the window, @see WindowClass

   199

	WindowClass parent_cls; ///< Class of the parent window, @see WindowClass

   200

	uint32 flags;           ///< Flags, @see WindowDefaultFlags

   201

	const Widget *widgets;  ///< List of widgets with their position and size for the window

   202

	WindowProc *proc;       ///< Window event handler function for the window

   203

};

   204

   205

/**

   206

 * Window default widget/window handling flags

   207

 */

   208

enum WindowDefaultFlag {

   209

	WDF_STD_TOOLTIPS    =   1 << 0, ///< use standard routine when displaying tooltips

   210

	WDF_DEF_WIDGET      =   1 << 1, ///< Default widget control for some widgets in the on click event, @see DispatchLeftClickEvent()

   211

	WDF_STD_BTN         =   1 << 2, ///< Default handling for close and titlebar widgets (widget no 0 and 1)

   212

   213

	WDF_UNCLICK_BUTTONS =   1 << 4, ///< Unclick buttons when the window event times out

   214

	WDF_STICKY_BUTTON   =   1 << 5, ///< Set window to sticky mode; they are not closed unless closed with 'X' (widget 2)

   215

	WDF_RESIZABLE       =   1 << 6, ///< Window can be resized

   216

	WDF_MODAL           =   1 << 7, ///< The window is a modal child of some other window, meaning the parent is 'inactive'

   217

};

   218

   219

/**

   220

 * Special values for 'left' and 'top' to cause a specific placement

   221

 */

   222

enum WindowDefaultPosition {

   223

	WDP_AUTO      = -1, ///< Find a place automatically

   224

	WDP_CENTER    = -2, ///< Center the window (left/right or top/bottom)

   225

	WDP_ALIGN_TBR = -3, ///< Align the right side of the window with the right side of the main toolbar

   226

	WDP_ALIGN_TBL = -4, ///< Align the left side of the window with the left side of the main toolbar

   227

};

   228

   229

/**

   230

 * Scrollbar data structure

   231

 */

   232

struct Scrollbar {

   233

	uint16 count;  ///< Number of elements in the list

   234

	uint16 cap;    ///< Number of visible elements of the scroll bar

   235

	uint16 pos;

   236

};

   237

   238

/**

   239

 * Data structure for resizing a window

   240

 */

   241

struct ResizeInfo {

   242

	uint width;       ///< Minimum allowed width of the window

   243

	uint height;      ///< Minimum allowed height of the window

   244

	uint step_width;  ///< Step-size of width resize changes

   245

	uint step_height; ///< Step-size of height resize changes

   246

};

   247

   248

/**

   249

 * Data structure for a window viewport

   250

 */

   251

struct ViewportData : ViewPort {

   252

	VehicleID follow_vehicle;

   253

	int32 scrollpos_x;

   254

	int32 scrollpos_y;

   255

	int32 dest_scrollpos_x;

   256

	int32 dest_scrollpos_y;

   257

};

   258

   259

/**

   260

 * Data structure for an opened window

   261

 */

   262

struct Window : ZeroedMemoryAllocator {

   263

private:

   264

	WindowProc *wndproc;   ///< Event handler function for the window. Do not use directly, call HandleWindowEvent() instead.

   265

	void HandleWindowEvent(WindowEvent *e);

   266

   267

protected:

   268

	void Initialize(int x, int y, int min_width, int min_height,

   269

			WindowProc *proc, WindowClass cls, const Widget *widget, int window_number);

   270

	void FindWindowPlacementAndResize(int def_width, int def_height);

   271

	void FindWindowPlacementAndResize(const WindowDesc *desc);

   272

   273

public:

   274

	Window(int x, int y, int width, int height, WindowProc *proc, WindowClass cls, const Widget *widget);

   275

	Window(const WindowDesc *desc, WindowNumber number = 0);

   276

   277

	virtual ~Window();

   278

   279

	uint16 flags4;              ///< Window flags, @see WindowFlags

   280

	WindowClass window_class;   ///< Window class

   281

	WindowNumber window_number; ///< Window number within the window class

   282

   283

	int left;   ///< x position of left edge of the window

   284

	int top;    ///< y position of top edge of the window

   285

	int width;  ///< width of the window (number of pixels to the right in x direction)

   286

	int height; ///< Height of the window (number of pixels down in y direction)

   287

   288

	Scrollbar hscroll;  ///< Horizontal scroll bar

   289

	Scrollbar vscroll;  ///< First vertical scroll bar

   290

	Scrollbar vscroll2; ///< Second vertical scroll bar

   291

	ResizeInfo resize;  ///< Resize information

   292

   293

	byte caption_color; ///< Background color of the window caption, contains PlayerID

   294

   295

	ViewportData *viewport;      ///< Pointer to viewport data, if present

   296

	const Widget *original_widget; ///< Original widget layout, copied from WindowDesc

   297

	Widget *widget;        ///< Widgets of the window

   298

	uint widget_count;     ///< Number of widgets of the window

   299

	uint32 desc_flags;     ///< Window/widgets default flags setting, @see WindowDefaultFlag

   300

   301

	Window *parent;        ///< Parent window

   302

   303

	void HandleButtonClick(byte widget);

   304

   305

	void SetWidgetDisabledState(byte widget_index, bool disab_stat);

   306

	void DisableWidget(byte widget_index);

   307

	void EnableWidget(byte widget_index);

   308

	bool IsWidgetDisabled(byte widget_index) const;

   309

	void SetWidgetHiddenState(byte widget_index, bool hidden_stat);

   310

	void HideWidget(byte widget_index);

   311

	void ShowWidget(byte widget_index);

   312

	bool IsWidgetHidden(byte widget_index) const;

   313

	void SetWidgetLoweredState(byte widget_index, bool lowered_stat);

   314

	void ToggleWidgetLoweredState(byte widget_index);

   315

	void LowerWidget(byte widget_index);

   316

	void RaiseWidget(byte widget_index);

   317

	bool IsWidgetLowered(byte widget_index) const;

   318

   319

	void RaiseButtons();

   320

	void CDECL SetWidgetsDisabledState(bool disab_stat, int widgets, ...);

   321

	void CDECL SetWidgetsHiddenState(bool hidden_stat, int widgets, ...);

   322

	void CDECL SetWidgetsLoweredState(bool lowered_stat, int widgets, ...);

   323

	void InvalidateWidget(byte widget_index) const;

   324

   325

	void SetDirty() const;

   326

   327

	/*** Event handling ***/

   328

   329

	/**

   330

	 * This window is currently being repainted.

   331

	 */

   332

	virtual void OnPaint();

   333

   334

   335

	/**

   336

	 * A key has been pressed.

   337

	 * @param key     the Unicode value of the key.

   338

	 * @param keycode the untranslated key code including shift state.

   339

	 * @return true if the key press has been handled and no other

   340

	 *         window should receive the event.

   341

	 */

   342

	virtual bool OnKeyPress(uint16 key, uint16 keycode);

   343

   344

	/**

   345

	 * The state of the control key has changed

   346

	 * @return true if the change has been handled and no other

   347

	 *         window should receive the event.

   348

	 */

   349

	virtual bool OnCTRLStateChange();

   350

   351

   352

	/**

   353

	 * A click with the left mouse button has been made on the window.

   354

	 * @param pt     the point inside the window that has been clicked.

   355

	 * @param widget the clicked widget.

   356

	 */

   357

	virtual void OnClick(Point pt, int widget);

   358

   359

	/**

   360

	 * A double click with the left mouse button has been made on the window.

   361

	 * @param pt     the point inside the window that has been clicked.

   362

	 * @param widget the clicked widget.

   363

	 */

   364

	virtual void OnDoubleClick(Point pt, int widget) {}

   365

   366

	/**

   367

	 * A click with the right mouse button has been made on the window.

   368

	 * @param pt     the point inside the window that has been clicked.

   369

	 * @param widget the clicked widget.

   370

	 */

   371

	virtual void OnRightClick(Point pt, int widget) {}

   372

   373

	/**

   374

	 * A dragged 'object' has been released.

   375

	 * @param pt     the point inside the window where the release took place.

   376

	 * @param widget the widget where the release took place.

   377

	 */

   378

	virtual void OnDragDrop(Point pt, int widget) {}

   379

   380

	/**

   381

	 * Handle the request for (viewport) scrolling.

   382

	 * @param delta the amount the viewport must be scrolled.

   383

	 */

   384

	virtual void OnScroll(Point delta) {}

   385

   386

	/**

   387

	 * The mouse is currently moving over the window or has just moved outside

   388

	 * of the window. In the latter case pt is (-1, -1).

   389

	 * @param pt     the point inside the window that the mouse hovers over.

   390

	 * @param widget the widget the mouse hovers over.

   391

	 */

   392

	virtual void OnMouseOver(Point pt, int widget) {}

   393

   394

	/**

   395

	 * The mouse wheel has been turned.

   396

	 * @param wheel the amount of movement of the mouse wheel.

   397

	 */

   398

	virtual void OnMouseWheel(int wheel) {}

   399

   400

   401

	/**

   402

	 * Called for every mouse loop run, which is at least once per (game) tick.

   403

	 */

   404

	virtual void OnMouseLoop();

   405

   406

	/**

   407

	 * Called once per (game) tick.

   408

	 */

   409

	virtual void OnTick();

   410

   411

	/**

   412

	 * Called once every 100 (game) ticks.

   413

	 */

   414

	virtual void OnHundredthTick();

   415

   416

	/**

   417

	 * Called when this window's timeout has been reached.

   418

	 */

   419

	virtual void OnTimeout();

   420

   421

   422

	/**

   423

	 * Called when the window got resized.

   424

	 * @param new_size the new size of the window.

   425

	 * @param delta    the amount of which the window size changed.

   426

	 */

   427

	virtual void OnResize(Point new_size, Point delta);

   428

   429

	/**

   430

	 * A dropdown option associated to this window has been selected.

   431

	 * @param widget the widget (button) that the dropdown is associated with.

   432

	 * @param index  the element in the dropdown that is selected.

   433

	 */

   434

	virtual void OnDropdownSelect(int widget, int index);

   435

   436

	/**

   437

	 * The query window opened from this window has closed.

   438

	 * @param str the new value of the string or NULL if the window

   439

	 *            was cancelled.

   440

	 */

   441

	virtual void OnQueryTextFinished(char *str);

   442

   443

	/**

   444

	 * Some data on this window has become invalid.

   445

	 * @param data information about the changed data.

   446

	 */

   447

	virtual void OnInvalidateData(int data = 0);

   448

   449

   450

	/**

   451

	 * The user clicked some place on the map when a tile highlight mode

   452

	 * has been set.

   453

	 * @param pt   the exact point on the map that has been clicked.

   454

	 * @param tile the tile on the map that has been clicked.

   455

	 */

   456

	virtual void OnPlaceObject(Point pt, TileIndex tile);

   457

   458

	/**

   459

	 * The user cancelled a tile highlight mode that has been set.

   460

	 */

   461

	virtual void OnPlaceObjectAbort();

   462

   463

   464

	/**

   465

	 * The user is dragging over the map when the tile highlight mode

   466

	 * has been set.

   467

	 * @param select_method the method of selection (allowed directions)

   468

	 * @param select_proc   what will be created when the drag is over.

   469

	 * @param pt            the exact point on the map where the mouse is.

   470

	 */

   471

	virtual void OnPlaceDrag(ViewportPlaceMethod select_method, byte select_proc, Point pt);

   472

   473

	/**

   474

	 * The user has dragged over the map when the tile highlight mode

   475

	 * has been set.

   476

	 * @param select_method the method of selection (allowed directions)

   477

	 * @param select_proc   what should be created.

   478

	 * @param pt            the exact point on the map where the mouse was released.

   479

	 * @param start_tile    the begin tile of the drag.

   480

	 * @param end_tile      the end tile of the drag.

   481

	 */

   482

	virtual void OnPlaceMouseUp(ViewportPlaceMethod select_method, byte select_proc, Point pt, TileIndex start_tile, TileIndex end_tile);

   483

   484

	/**

   485

	 * The user moves over the map when a tile highlight mode has been set

   486

	 * when the special mouse mode has been set to 'PRESIZE' mode. An

   487

	 * example of this is the tile highlight for dock building.