1

#ifndef WINDOW_H

     2

#define WINDOW_H

     3

     4

typedef union WindowEvent WindowEvent;

     5

     6

//typedef void WindowProc(Window *w, int event, int wparam, long lparam);

     7

     8

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

     9

    10

typedef struct Widget {

    11

	byte type;

    12

	byte color;

    13

	uint16 left, right, top, bottom;

    14

	uint16 unkA;

    15

	uint16 tooltips;

    16

} Widget;

    17

    18

union WindowEvent {

    19

	byte event;

    20

	struct {

    21

		byte event;

    22

		Point pt;

    23

		int widget;

    24

	} click;

    25

    26

	struct {

    27

		byte event;

    28

		Point pt;

    29

		uint tile;

    30

		uint starttile;

    31

		int userdata;

    32

	} place;

    33

    34

	struct {

    35

		byte event;

    36

		Point pt;

    37

		int widget;

    38

	} dragdrop;

    39

    40

	struct {

    41

		byte event;

    42

		byte *str;

    43

	} edittext;

    44

    45

	struct {

    46

		byte event;

    47

		Point pt;

    48

	} popupmenu;

    49

    50

	struct {

    51

		byte event;

    52

		int button;

    53

		int index;

    54

	} dropdown;

    55

    56

	struct {

    57

		byte event;

    64

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

    65

		byte ascii;  // 8-bit ASCII-value of the key

    66

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

    67

	} keypress;

    68

};

    69

    70

enum WindowKeyCodes {

    71

	WKC_SHIFT = 0x8000,

    72

	WKC_CTRL  = 0x4000,

    73

	WKC_ALT   = 0x2000,

    74

	WKC_META  = 0x1000,

    75

    76

	// Special ones

    77

	WKC_NONE = 0,

    78

	WKC_ESC=1,

    79

	WKC_BACKSPACE = 2,

    80

	WKC_INSERT = 3,

    81

	WKC_DELETE = 4,

    82

    83

	WKC_PAGEUP = 5,

    84

	WKC_PAGEDOWN = 6,

    85

	WKC_END = 7,

    86

	WKC_HOME = 8,

    87

    88

	// Arrow keys

    89

	WKC_LEFT = 9,

    90

	WKC_UP = 10,

    91

	WKC_RIGHT = 11,

    92

	WKC_DOWN = 12,

    93

    94

	// Return & tab

    95

	WKC_RETURN = 13,

    96

	WKC_TAB = 14,

    97

    98

	// Numerical keyboard

    99

	WKC_NUM_0 = 16,

   100

	WKC_NUM_1 = 17,

   101

	WKC_NUM_2 = 18,

   102

	WKC_NUM_3 = 19,

   103

	WKC_NUM_4 = 20,

   104

	WKC_NUM_5 = 21,

   105

	WKC_NUM_6 = 22,

   106

	WKC_NUM_7 = 23,

   107

	WKC_NUM_8 = 24,

   108

	WKC_NUM_9 = 25,

   109

	WKC_NUM_DIV = 26,

   110

	WKC_NUM_MUL = 27,

   111

	WKC_NUM_MINUS = 28,

   112

	WKC_NUM_PLUS = 29,

   113

	WKC_NUM_ENTER = 30,

   114

	WKC_NUM_DECIMAL = 31,

   115

   116

	// Space

   117

	WKC_SPACE = 32,

   118

   119

	// Function keys

   120

	WKC_F1 = 33,

   121

	WKC_F2 = 34,

   122

	WKC_F3 = 35,

   123

	WKC_F4 = 36,

   124

	WKC_F5 = 37,

   125

	WKC_F6 = 38,

   126

	WKC_F7 = 39,

   127

	WKC_F8 = 40,

   128

	WKC_F9 = 41,

   129

	WKC_F10 = 42,

   130

	WKC_F11 = 43,

   131

	WKC_F12 = 44,

   132

   133

	// backquote is the key left of "1"

   134

	// we only store this key here, no matter what character is really mapped to it

   135

	// on a particular keyboard. (US keyboard: ` and ~ ; German keyboard: ^ and °)

   136

	WKC_BACKQUOTE = 45,

   137

	WKC_PAUSE     = 46,

   138

   139

	// 0-9 are mapped to 48-57

   140

	// A-Z are mapped to 65-90

   141

	// a-z are mapped to 97-122

   142

   143

   144

	//WKC_UNKNOWN = 0xFF,

   145

   146

};

   147

   148

typedef struct WindowDesc {

   149

	int16 left, top, width, height;

   150

	byte cls;

   151

	byte parent_cls;

   152

	uint32 flags;

   153

	const Widget *widgets;

   154

	WindowProc *proc;

   155

} WindowDesc;

   156

   157

enum {

   158

	WDF_STD_TOOLTIPS = 1,		/* use standard routine when displaying tooltips */

   159

	WDF_DEF_WIDGET = 2,			/* default widget control for some widgets in the on click event */

   160

	WDF_STD_BTN = 4,				/* default handling for close and drag widgets (widget no 0 and 1) */

   161

	WDF_RESTORE_DPARAM = 8, /* when drawing widgets, restore the dparam so all widgets recieve the same set of them */

   162

	WDF_UNCLICK_BUTTONS=16, /* Unclick buttons when the window event times out */

   163

};

   164

   165

/* can be used as x or y coordinates to cause a specific placement */

   166

enum {

   167

	WDP_AUTO = -1,

   168

	WDP_CENTER = -2,

   169

};

   170

   171

typedef struct {

   172

	StringID caption;

   173

	bool caret;

   174

	WindowClass wnd_class;

   175

	WindowNumber wnd_num;

   176

	uint16 maxlen, maxwidth;

   177

	byte *buf;

   178

} querystr_d;

   179

   180

#define WP(ptr,str) (*(str*)(ptr)->custom)

   181

// querystr_d is the bigest struct that comes in w->custom

   182

//  because 64-bit systems use 64-bit pointers, it is bigger on a 64-bit system

   183

//  then on a 32-bit system. Therefor the size is calculated from querystr_d

   184

//  instead of a hardcoded number.

   185

// if any struct becomes bigger the querystr_d, it should be replaced.

   186

#define WINDOW_CUSTOM_SIZE sizeof(querystr_d)

   187

   188

typedef struct {

   189

	uint16 count, cap, pos;

   190

} Scrollbar;

   191

   192

struct Window {

   193

	uint16 flags4;

   194

	WindowClass window_class;

   195

	WindowNumber window_number;

   196

   197

	int left,top;

   198

	int width,height;

   199

   200

	Scrollbar hscroll, vscroll;

   201

   202

	byte caption_color;

   203

   204

	uint32 click_state, disabled_state, hidden_state;

   205

	WindowProc *wndproc;

   206

	ViewPort *viewport;

   207

	const Widget *widget;

   208

	//const WindowDesc *desc;

   209

	uint32 desc_flags;

   210

   211

	byte custom[WINDOW_CUSTOM_SIZE];

   212

};

   213

   214

typedef struct {

   215

	byte item_count; /* follow_vehicle */

   216

	byte sel_index;		/* scrollpos_x */

   217

	byte main_button; /* scrollpos_y */

   218

	byte action_id;

   219

	StringID string_id; /* unk30 */

   220

	uint16 checked_items; /* unk32 */

   221

} menu_d;

   222

   223

typedef struct {

   224

	int16 data_1, data_2, data_3;

   225

	int16 data_4, data_5;

   226

	bool close; /* scrollpos_y */

   227

	byte byte_1;

   228

} def_d;

   229

   230

typedef struct {

   231

	void *data;

   232

} void_d;

   233

   234

typedef struct {

   235

	uint16 base; /* follow_vehicle */

   236

	uint16 count;/* scrollpos_x */

   237

} tree_d;

   238

   239

typedef struct {

   240

	byte refresh_counter; /* follow_vehicle */

   241

} plstations_d;

   242

   243

typedef struct {

   244

	StringID string_id;

   245

} tooltips_d;

   246

   247

typedef struct {

   248

	byte railtype;

   249

	byte sel_index;

   250

	int16 sel_engine;

   251

	int16 rename_engine;

   252

} buildtrain_d;

   253

   254

typedef struct {

   255

	VehicleID sel;

   256

} traindepot_d;

   257

   258

typedef struct {

   259

	int sel;

   260

} order_d;

   261

   262

typedef struct {

   263

	byte tab;

   264

} traindetails_d;

   265

   266

typedef struct {

   267

	int16 scroll_x, scroll_y, subscroll;

   268

} smallmap_d;

   269

   270

typedef struct {

   271

	uint32 face;

   272

	byte gender;

   273

} facesel_d;

   274

   275

typedef struct {

   276

	int sel;

   277

	byte cargo;

   278

} refit_d;

   279

   280

typedef struct {

   281

	uint16 follow_vehicle;

   282

	int16 scrollpos_x, scrollpos_y;

   283

} vp_d;

   284

   285

typedef struct {

   286

	uint16 follow_vehicle;

   287

	int16 scrollpos_x, scrollpos_y;

   288

	NewsItem *ni;

   289

} news_d;

   290

   291

enum WindowEvents {

   292

	WE_CLICK = 0,

   293

	WE_PAINT = 1,

   294

	WE_MOUSELOOP = 2,

   295

	WE_TICK = 3,

   296

	WE_4 = 4,

   297

	WE_TIMEOUT = 5,

   298

	WE_PLACE_OBJ = 6,

   299

	WE_ABORT_PLACE_OBJ = 7,

   300

	WE_DESTROY = 8,

   301

	WE_ON_EDIT_TEXT = 9,

   302

	WE_POPUPMENU_SELECT = 10,

   303

	WE_POPUPMENU_OVER = 11,

   304

	WE_DRAGDROP = 12,

   305

	WE_PLACE_DRAG = 13,

   306

	WE_PLACE_MOUSEUP = 14,

   307

	WE_PLACE_PRESIZE = 15,

   308

	WE_DROPDOWN_SELECT = 16,

   309

	WE_RCLICK = 17,

   310

	WE_KEYPRESS = 18,

   311

	WE_CREATE = 19,

   314

};

   315

   316

   317

/****************** THESE ARE NOT WIDGET TYPES!!!!! *******************/

   318

enum WindowWidgetBehaviours {

   319

	WWB_PUSHBUTTON = 1 << 5,

   320

	WWB_NODISBUTTON = 2 << 5,

   321

};

   322

   323

   324

enum WindowWidgetTypes {

   325

	WWT_EMPTY = 0,

   326

   327

	WWT_IMGBTN = 1,						/* button with image */

   328

	WWT_PANEL = WWT_IMGBTN,

   329

	WWT_PANEL_2 = 2,					/* button with diff image when clicked */

   330

   331

	WWT_TEXTBTN = 3,					/* button with text */

   332

	WWT_CLOSEBOX = WWT_TEXTBTN,

   333

	WWT_4 = 4,								/* button with diff text when clicked */

   334

	WWT_5 = 5,								/* label */

   335

	WWT_6 = 6,								/* combo box text area */

   336

	WWT_MATRIX = 7,

   337

	WWT_SCROLLBAR = 8,

   338

	WWT_FRAME = 9,						/* frame */

   339

	WWT_CAPTION = 10,

   340

   341

	WWT_HSCROLLBAR = 11,

   342

	WWT_LAST = 12,						/* Last Item. use WIDGETS_END to fill up padding!! */

   343

   344

	WWT_MASK = 31,

   345

   346

	WWT_PUSHTXTBTN	= WWT_TEXTBTN	| WWB_PUSHBUTTON,

   347

	WWT_PUSHIMGBTN	= WWT_IMGBTN	| WWB_PUSHBUTTON,

   348

	WWT_NODISTXTBTN = WWT_TEXTBTN	| WWB_NODISBUTTON,

   349

};

   350

   351

#define WIDGETS_END WWT_LAST,     0,     0,     0,     0,     0, 0, STR_NULL

   352

   353

enum WindowFlags {

   354

	WF_TIMEOUT_SHL = 0,

   355

	WF_TIMEOUT_MASK = 7,

   356

	WF_DRAGGING = 1 << 3,

   357

	WF_SCROLL_UP = 1 << 4,

   358

	WF_SCROLL_DOWN = 1 << 5,

   359

	WF_SCROLL_MIDDLE = 1 << 6,

   360

	WF_HSCROLL = 1 << 7,

   361

	WF_SIZING = 1 << 8,

   362

   363

	WF_DISABLE_VP_SCROLL = 1 << 10,

   364

   365

	WF_WHITE_BORDER_ONE = 1 << 11,

   366

	WF_WHITE_BORDER_MASK = 3 << 11,

   367

};

   368

   369

   370

void DispatchLeftClickEvent(Window *w, int x, int y);

   371

void DispatchRightClickEvent(Window *w, int x, int y);

   372

void DispatchMouseWheelEvent(Window *w, int wheel);

   373

   374

/* window.c */

   375

void DrawOverlappedWindow(Window *w, int left, int top, int right, int bottom);

   376

void CallWindowEventNP(Window *w, int event);

   377

void CallWindowTickEvent();

   378

void DrawDirtyBlocks();

   379

void SetDirtyBlocks(int left, int top, int right, int bottom);

   380

void SetWindowDirty(Window *w);

   381

   382

Window *FindWindowById(WindowClass cls, WindowNumber number);

   383

void DeleteWindow(Window *w);

   384

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number);

   385

Window *BringWindowToFront(Window *w);

   386

Window *StartWindowDrag(Window *w);

   387

Window *StartWindowSizing(Window *w);

   388

Window *FindWindowFromPt(int x, int y);

   389

   390

Window *AllocateWindow(

   391

							int x,

   392

							int y,

   393

							int width,

   394

							int height,

   395

							WindowProc *proc,

   396

							WindowClass cls,

   397

							const Widget *widget);

   398

   399

Window *AllocateWindowDesc(const WindowDesc *desc);

   400

Window *AllocateWindowDescFront(const WindowDesc *desc, int value);

   401

   402

Window *AllocateWindowAutoPlace(

   403

	int width,

   404

	int height,

   405

	WindowProc *proc,

   406

	WindowClass cls,

   407

	const Widget *widget);

   408

   409

Window *AllocateWindowAutoPlace2(

   410

	WindowClass exist_class,

   411

	WindowNumber exist_num,

   412

	int width,

   413

	int height,

   414

	WindowProc *proc,

   415

	WindowClass cls,

   416

	const Widget *widget);

   417

   418

void DrawWindowViewport(Window *w);

   419

   420

void InitWindowSystem();

   421

int GetMenuItemIndex(Window *w, int x, int y);

   422

void MouseLoop();

   423

void UpdateWindows();

   424

void InvalidateWidget(Window *w, byte widget_index);

   425

   426

void GuiShowTooltips(uint16 string_id);

   427

   428

void UnclickWindowButtons(Window *w);

   429

void UnclickSomeWindowButtons(Window *w, uint32 mask);

   430

void RelocateAllWindows(int neww, int newh);

   431

int PositionMainToolbar(Window *w);

   432

   433

/* widget.c */

   434

int GetWidgetFromPos(Window *w, int x, int y);

   435

void DrawWindowWidgets(Window *w);

   436

void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask);

   437

   438

void HandleButtonClick(Window *w, byte widget);

   439

   440

Window *GetCallbackWnd();

   441

void DeleteNonVitalWindows();

   442

   443

/* window.c */

   444

VARDEF Window _windows[20];

   445

VARDEF Window *_last_window;

   446

   447

VARDEF Point _cursorpos_drag_start;

   448

   449

VARDEF bool _left_button_down;

   450

VARDEF bool _left_button_clicked;

   451

   452

VARDEF bool _right_button_down;

   453

VARDEF bool _right_button_clicked;

   454

   455

VARDEF int _alloc_wnd_parent_num;

   456

   457

VARDEF int _scrollbar_start_pos;

   458

VARDEF int _scrollbar_size;

   459

VARDEF bool _demo_mode;

   460

VARDEF byte _scroller_click_timeout;

   461

   462

VARDEF bool _dragging_window;

   463

VARDEF bool _scrolling_scrollbar;

   464

VARDEF bool _scrolling_viewport;

   465

VARDEF bool _popup_menu_active;

   466

//VARDEF bool _dragdrop_active;

   467

   468

VARDEF Point _fix_mouse_at;

   469

   470

VARDEF byte _special_mouse_mode;

   471

enum SpecialMouseMode {

   472

	WSM_NONE = 0,

   473

	WSM_DRAGDROP = 1,

   474

	WSM_SIZING = 2,

   475

	WSM_PRESIZE = 3,

   476

};

   477

   478

void ScrollbarClickHandler(Window *w, const Widget *wi, int x, int y);

   479

   480

#endif /* WINDOW_H */