1

/* $Id$ */

     2

     3

#ifndef WINDOW_H

     4

#define WINDOW_H

     5

     6

#include "macros.h"

     7

#include "string.h"

     8

#include "order.h"

     9

    10

typedef struct WindowEvent WindowEvent;

    11

    12

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

    13

    14

/* How the resize system works:

    15

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

    16

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

    17

     to resize itself.

    18

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

    19

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

    20

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

    21

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

    22

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

    23

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

    24

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

    25

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

    26

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

    27

     widgets moves downwards without resizing, and appears to be clamped

    28

     to the bottom. Nice aint it?

    29

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

    30

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

    31

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

    32

    after making the window, like this:

    33

      w->resize.step_height = 10;

    34

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

    35

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

    36

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

    37

    AFTER window-creation, with:

    38

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

    39

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

    40

    41

enum ResizeFlags {

    42

	RESIZE_NONE   = 0,

    43

    44

	RESIZE_LEFT   = 1,

    45

	RESIZE_RIGHT  = 2,

    46

	RESIZE_TOP    = 4,

    47

	RESIZE_BOTTOM = 8,

    48

    49

	RESIZE_LR     = RESIZE_LEFT  | RESIZE_RIGHT,

    50

	RESIZE_RB     = RESIZE_RIGHT | RESIZE_BOTTOM,

    51

	RESIZE_TB     = RESIZE_TOP   | RESIZE_BOTTOM,

    52

	RESIZE_LRB    = RESIZE_LEFT  | RESIZE_RIGHT  | RESIZE_BOTTOM,

    53

	RESIZE_LRTB   = RESIZE_LEFT  | RESIZE_RIGHT  | RESIZE_TOP | RESIZE_BOTTOM,

    54

	RESIZE_RTB    = RESIZE_RIGHT | RESIZE_TOP    | RESIZE_BOTTOM,

    55

    56

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

    57

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

    58

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

    59

	 * Enabled, visible or unclicked widgets*/

    60

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

    61

	WIDG_HIDDEN   = 5,  // widget is made invisible

    62

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

    63

} ResizeFlag;

    64

    65

/* used to indicate the end of widgets' list for vararg functions */

    66

enum {

    67

	WIDGET_LIST_END = -1,

    68

};

    69

    70

typedef struct Widget {

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

} Widget;

    78

    79

typedef enum FrameFlags {

    80

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

    81

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

    82

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

    83

	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)

    84

} FrameFlags;

    85

    86

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

    87

    88

enum WindowEventCodes {

    89

	WE_CLICK               =  0,

    90

	WE_PAINT               =  1,

    91

	WE_MOUSELOOP           =  2,

    92

	WE_TICK                =  3,

    93

	WE_4                   =  4,

    94

	WE_TIMEOUT             =  5,

    95

	WE_PLACE_OBJ           =  6,

    96

	WE_ABORT_PLACE_OBJ     =  7,

    97

	WE_DESTROY             =  8,

    98

	WE_ON_EDIT_TEXT        =  9,

    99

	WE_POPUPMENU_SELECT    = 10,

   100

	WE_POPUPMENU_OVER      = 11,

   101

	WE_DRAGDROP            = 12,

   102

	WE_PLACE_DRAG          = 13,

   103

	WE_PLACE_MOUSEUP       = 14,

   104

	WE_PLACE_PRESIZE       = 15,

   105

	WE_DROPDOWN_SELECT     = 16,

   106

	WE_RCLICK              = 17,

   107

	WE_KEYPRESS            = 18,

   108

	WE_CREATE              = 19,

   109

	WE_MOUSEOVER           = 20,

   110

	WE_ON_EDIT_TEXT_CANCEL = 21,

   111

	WE_RESIZE              = 22,

   112

	WE_MESSAGE             = 23,

   113

	WE_SCROLL              = 24,

   114

	WE_MOUSEWHEEL          = 25,

   115

	WE_INVALIDATE_DATA     = 26,

   116

};

   117

   118

struct WindowEvent {

   119

	byte event;

   120

	union {

   121

		struct{

   122

			Point pt;

   123

			int widget;

   124

		} click;

   125

   126

		struct {

   127

			Point pt;

   128

			TileIndex tile;

   129

			TileIndex starttile;

   130

			int userdata;

   131

		} place;

   132

   133

		struct {

   134

			Point pt;

   135

			int widget;

   136

		} dragdrop;

   137

   138

		struct {

   139

			Point size;

   140

			Point diff;

   141

		} sizing;

   142

   143

		struct {

   144

			char *str;

   145

		} edittext;

   146

   147

		struct {

   148

			Point pt;

   149

		} popupmenu;

   150

   151

		struct {

   152

			int button;

   153

			int index;

   154

		} dropdown;

   155

   156

		struct {

   157

			Point pt;

   158

			int widget;

   159

		} mouseover;

   160

   161

		struct {

   162

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

   163

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

   164

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

   165

		} keypress;

   166

   167

		struct {

   168

			uint msg;      // message to be sent

   169

			uint wparam;   // additional message-specific information

   170

			uint lparam;   // additional message-specific information

   171

		} message;

   172

   173

		struct {

   174

			Point delta;   // delta position against position of last call

   175

		} scroll;

   176

   177

		struct {

   178

			int wheel;     // how much was 'wheel'd'

   179

		} wheel;

   180

	} we;

   181

};

   182

   183

enum WindowKeyCodes {

   184

	WKC_SHIFT = 0x8000,

   185

	WKC_CTRL  = 0x4000,

   186

	WKC_ALT   = 0x2000,

   187

	WKC_META  = 0x1000,

   188

   189

	// Special ones

   190

	WKC_NONE        =  0,

   191

	WKC_ESC         =  1,

   192

	WKC_BACKSPACE   =  2,

   193

	WKC_INSERT      =  3,

   194

	WKC_DELETE      =  4,

   195

   196

	WKC_PAGEUP      =  5,

   197

	WKC_PAGEDOWN    =  6,

   198

	WKC_END         =  7,

   199

	WKC_HOME        =  8,

   200

   201

	// Arrow keys

   202

	WKC_LEFT        =  9,

   203

	WKC_UP          = 10,

   204

	WKC_RIGHT       = 11,

   205

	WKC_DOWN        = 12,

   206

   207

	// Return & tab

   208

	WKC_RETURN      = 13,

   209

	WKC_TAB         = 14,

   210

   211

	// Numerical keyboard

   212

	WKC_NUM_0       = 16,

   213

	WKC_NUM_1       = 17,

   214

	WKC_NUM_2       = 18,

   215

	WKC_NUM_3       = 19,

   216

	WKC_NUM_4       = 20,

   217

	WKC_NUM_5       = 21,

   218

	WKC_NUM_6       = 22,

   219

	WKC_NUM_7       = 23,

   220

	WKC_NUM_8       = 24,

   221

	WKC_NUM_9       = 25,

   222

	WKC_NUM_DIV     = 26,

   223

	WKC_NUM_MUL     = 27,

   224

	WKC_NUM_MINUS   = 28,

   225

	WKC_NUM_PLUS    = 29,

   226

	WKC_NUM_ENTER   = 30,

   227

	WKC_NUM_DECIMAL = 31,

   228

   229

	// Space

   230

	WKC_SPACE       = 32,

   231

   232

	// Function keys

   233

	WKC_F1          = 33,

   234

	WKC_F2          = 34,

   235

	WKC_F3          = 35,

   236

	WKC_F4          = 36,

   237

	WKC_F5          = 37,

   238

	WKC_F6          = 38,

   239

	WKC_F7          = 39,

   240

	WKC_F8          = 40,

   241

	WKC_F9          = 41,

   242

	WKC_F10         = 42,

   243

	WKC_F11         = 43,

   244

	WKC_F12         = 44,

   245

   246

	// backquote is the key left of "1"

   247

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

   248

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

   249

	WKC_BACKQUOTE   = 45,

   250

	WKC_PAUSE       = 46,

   251

   252

	// 0-9 are mapped to 48-57

   253

	// A-Z are mapped to 65-90

   254

	// a-z are mapped to 97-122

   255

};

   256

   257

typedef struct WindowDesc {

   258

	int16 left, top, width, height;

   259

	WindowClass cls;

   260

	WindowClass parent_cls;

   261

	uint32 flags;

   262

	const Widget *widgets;

   263

	WindowProc *proc;

   264

} WindowDesc;

   265

   266

enum {

   267

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

   268

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

   269

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

   270

   271

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

   272

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

   273

	WDF_RESIZABLE       = 64, /* A window can be resized */

   274

};

   275

   276

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

   277

enum {

   278

	WDP_AUTO   = -1,

   279

	WDP_CENTER = -2,

   280

};

   281

   282

typedef struct Textbuf {

   283

	char *buf;                  /* buffer in which text is saved */

   284

	uint16 maxlength, maxwidth; /* the maximum size of the buffer. Maxwidth specifies screensize in pixels */

   285

	uint16 length, width;       /* the current size of the string. Width specifies screensize in pixels */

   286

	bool caret;                 /* is the caret ("_") visible or not */

   287

	uint16 caretpos;            /* the current position of the caret in the buffer */

   288

	uint16 caretxoffs;          /* the current position of the caret in pixels */

   289

} Textbuf;

   290

   291

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

   292

/* You cannot 100% reliably calculate the biggest custom struct as

   293

 * the number of pointers in it and alignment will have a huge impact.

   294

 * 96 is the largest window-size for 64-bit machines currently */

   295

#define WINDOW_CUSTOM_SIZE 96

   296

   297

typedef struct Scrollbar {

   298

	uint16 count, cap, pos;

   299

} Scrollbar;

   300

   301

typedef struct ResizeInfo {

   302

	uint width; /* Minimum width and height */

   303

	uint height;

   304

   305

	uint step_width; /* In how big steps the width and height go */

   306

	uint step_height;

   307

} ResizeInfo;

   308

   309

typedef struct WindowMessage {

   310

		int msg;

   311

		int wparam;

   312

		int lparam;

   313

} WindowMessage;

   314

   315

struct Window {

   316

	uint16 flags4;

   317

	WindowClass window_class;

   318

	WindowNumber window_number;

   319

   320

	int left, top;

   321

	int width, height;

   322

   323

	Scrollbar hscroll, vscroll, vscroll2;

   324

	ResizeInfo resize;

   325

   326

	byte caption_color;

   327

   328

	WindowProc *wndproc;

   329

	ViewPort *viewport;

   330

	const Widget *original_widget;

   331

	Widget *widget;

   332

	uint32 desc_flags;

   333

   334

	WindowMessage message;

   335

	byte custom[WINDOW_CUSTOM_SIZE];

   336

};

   337

   338

typedef struct querystr_d {

   339

	StringID caption;

   340

	WindowClass wnd_class;

   341

	WindowNumber wnd_num;

   342

	Textbuf text;

   343

	const char *orig;

   344

	CharSetFilter afilter;

   345

} querystr_d;

   346

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(querystr_d));

   347

   348

typedef struct query_d {

   349

	StringID caption;

   350

	StringID message;

   351

	WindowClass wnd_class;

   352

	WindowNumber wnd_num;

   353

	void (*ok_cancel_callback)(bool ok_clicked);

   354

	bool calledback;

   355

} query_d;

   356

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(query_d));

   357

   358

typedef struct {

   359

	byte item_count;      /* follow_vehicle */

   360

	byte sel_index;       /* scrollpos_x */

   361

	byte main_button;     /* scrollpos_y */

   362

	byte action_id;

   363

	StringID string_id;   /* unk30 */

   364

	uint16 checked_items; /* unk32 */

   365

	byte disabled_items;

   366

} menu_d;

   367

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(menu_d));

   368

   369

typedef struct {

   370

	int16 data_1, data_2, data_3;

   371

	int16 data_4, data_5;

   372

	bool close;

   373

	byte byte_1;

   374

} def_d;

   375

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(def_d));

   376

   377

typedef struct {

   378

	void *data;

   379

} void_d;

   380

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(void_d));

   381

   382

typedef struct {

   383

	uint16 base;

   384

	uint16 count;

   385

} tree_d;

   386

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(tree_d));

   387

   388

typedef struct {

   389

	StringID string_id;

   390

} tooltips_d;

   391

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(tooltips_d));

   392

   393

typedef struct {

   394

	byte railtype;

   395

	byte sel_index;

   396

	byte show_engine_wagon;

   398

	EngineID sel_engine;

   399

	EngineID rename_engine;

   400

	EngineID *engines;

   401

	EngineID *wagons;

   402

	uint16 num_engines;

   403

	uint16 num_wagons;

   404

} buildtrain_d;

   405

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(buildtrain_d));

   406

   407

typedef struct {

   408

	byte vehicletype;

   409

	byte sel_index[2];

   410

	EngineID sel_engine[2];

   411

	uint16 count[2];

   412

	bool wagon_btnstate; // true means engine is selected

   413

} replaceveh_d;

   414

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(replaceveh_d));

   415

   416

typedef struct {

   417

	VehicleID sel;

   418

	byte type;

   419

	bool generate_list;

   420

	uint16 engine_list_length;

   421

	uint16 wagon_list_length;

   422

	uint16 engine_count;

   423

	uint16 wagon_count;

   424

	Vehicle **vehicle_list;

   425

	Vehicle **wagon_list;

   426

} depot_d;

   427

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(depot_d));

   428

   429

typedef struct {

   430

	int sel;

   431

} order_d;

   432

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(order_d));

   433

   434

typedef struct {

   435

	byte tab;

   436

} traindetails_d;

   437

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(traindetails_d));

   438

   439

typedef struct {

   440

	int32 scroll_x;

   441

	int32 scroll_y;

   442

	int32 subscroll;

   443

} smallmap_d;

   444

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(smallmap_d));

   445

   446

typedef struct {

   447

	uint32 face;

   448

	byte gender;

   449

} facesel_d;

   450

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(facesel_d));

   451

   452

typedef struct {

   453

	int sel;

   454

	struct RefitOption *cargo;

   455

	struct RefitList *list;

   456

	uint length;

   457

	VehicleOrderID order;

   458

} refit_d;

   459

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(refit_d));

   460

   461

typedef struct {

   462

	VehicleID follow_vehicle;

   463

	int32 scrollpos_x;

   464

	int32 scrollpos_y;

   465

} vp_d;

   466

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vp_d) + 3 * sizeof(byte)); // + 3 * byte is a hack from Miham

   467

   468

// vp2_d is the same as vp_d, except for the data_# values..

   469

typedef struct {

   470

	uint16 follow_vehicle;

   471

	int32 scrollpos_x;

   472

	int32 scrollpos_y;

   473

	byte data_1;

   474

	byte data_2;

   475

	byte data_3;

   476

} vp2_d;

   477

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vp2_d));

   478

   479

typedef struct {

   480

	uint16 follow_vehicle;

   481

	int32 scrollpos_x;

   482

	int32 scrollpos_y;

   483

	NewsItem *ni;

   484

} news_d;

   485

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(news_d));

   486

   487

typedef struct {

   488

	uint32 background_img;

   489

	int8 rank;

   490

} highscore_d;

   491

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(highscore_d));

   492

   493

typedef struct {

   494

	int height;