1

/* $Id$ */

     2

     3

/** @file window.h regroups declarations for all windowing system, as well as a few helper functions */

     4

     5

#ifndef WINDOW_H

     6

#define WINDOW_H

     7

     8

#include "macros.h"

     9

#include "string.h"

    10

#include "order.h"

    11

#include "rail.h"

    12

#include "road.h"

    13

#include "airport.h"

    14

#include "vehicle.h"

    15

#include "viewport.h"

    16

    17

struct WindowEvent;

    18

    19

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

    20

    21

/* How the resize system works:

    22

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

    23

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

    24

     to resize itself.

    25

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

    26

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

    27

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

    28

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

    29

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

    30

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

    31

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

    32

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

    33

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

    34

     widgets moves downwards without resizing, and appears to be clamped

    35

     to the bottom. Nice aint it?

    36

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

    37

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

    38

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

    39

    after making the window, like this:

    40

      w->resize.step_height = 10;

    41

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

    42

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

    43

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

    44

    AFTER window-creation, with:

    45

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

    46

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

    47

    48

enum ResizeFlag {

    49

	RESIZE_NONE   = 0,  ///< no resize required

    50

    51

	RESIZE_LEFT   = 1,  ///< left resize flag

    52

	RESIZE_RIGHT  = 2,  ///< rigth resize flag

    53

	RESIZE_TOP    = 4,  ///< top resize flag

    54

	RESIZE_BOTTOM = 8,  ///< bottom resize flag

    55

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

    63

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

    64

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

    65

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

    66

	 * Enabled, visible or unclicked widgets*/

    67

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

    68

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

    69

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

    70

};

    71

    72

enum {

    73

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

    74

};

    75

    76

struct Widget {

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

};

    84

    85

enum FrameFlags {

    86

	FR_NONE         =  0,

    87

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

    88

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

    89

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

    90

	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)

    91

};

    92

    93

DECLARE_ENUM_AS_BIT_SET(FrameFlags);

    94

    95

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

    96

    97

enum WindowEventCodes {

    98

	WE_CREATE,

    99

	WE_DESTROY,

   100

	WE_PAINT,

   101

	WE_KEYPRESS,

   102

	WE_CLICK,

   103

	WE_DOUBLE_CLICK,

   104

	WE_RCLICK,

   105

	WE_MOUSEOVER,

   106

	WE_MOUSELOOP,

   107

	WE_MOUSEWHEEL,

   108

	WE_TICK,

   109

	WE_4,

   110

	WE_TIMEOUT,

   111

	WE_PLACE_OBJ,

   112

	WE_ABORT_PLACE_OBJ,

   113

	WE_ON_EDIT_TEXT,

   114

	WE_ON_EDIT_TEXT_CANCEL,

   115

	WE_POPUPMENU_SELECT,

   116

	WE_POPUPMENU_OVER,

   117

	WE_DRAGDROP,

   118

	WE_PLACE_DRAG,

   119

	WE_PLACE_MOUSEUP,

   120

	WE_PLACE_PRESIZE,

   121

	WE_DROPDOWN_SELECT,

   122

	WE_RESIZE,

   123

	WE_MESSAGE,

   124

	WE_SCROLL,

   125

	WE_INVALIDATE_DATA,

   126

};

   127

   128

struct WindowEvent {

   129

	byte event;

   130

	union {

   131

		struct {

   132

			void *data;

   133

		} create;

   134

   135

		struct {

   136

			Point pt;

   137

			int widget;

   138

		} click;

   139

   140

		struct {

   141

			Point pt;

   142

			TileIndex tile;

   143

			TileIndex starttile;

   144

			ViewportPlaceMethod select_method;

   145

			byte select_proc;

   146

		} place;

   147

   148

		struct {

   149

			Point pt;

   150

			int widget;

   151

		} dragdrop;

   152

   153

		struct {

   154

			Point size;

   155

			Point diff;

   156

		} sizing;

   157

   158

		struct {

   159

			char *str;

   160

		} edittext;

   161

   162

		struct {

   163

			Point pt;

   164

		} popupmenu;

   165

   166

		struct {

   167

			int button;

   168

			int index;

   169

		} dropdown;

   170

   171

		struct {

   172

			Point pt;

   173

			int widget;

   174

		} mouseover;

   175

   176

		struct {

   177

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

   178

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

   179

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

   180

		} keypress;

   181

   182

		struct {

   183

			int msg;      ///< message to be sent

   184

			int wparam;   ///< additional message-specific information

   185

			int lparam;   ///< additional message-specific information

   186

		} message;

   187

   188

		struct {

   189

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

   190

		} scroll;

   191

   192

		struct {

   193

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

   194

		} wheel;

   195

	} we;

   196

};

   197

   198

struct WindowDesc {

   199

	int16 left, top, minimum_width, minimum_height, default_width, default_height;

   200

	WindowClass cls;

   201

	WindowClass parent_cls;

   202

	uint32 flags;

   203

	const Widget *widgets;

   204

	WindowProc *proc;

   205

};

   206

   207

enum WindowDefaultFlag {

   208

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

   209

	WDF_DEF_WIDGET      =   1 << 1, ///< default widget control for some widgets in the on click event

   210

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

   211

   212

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

   213

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

   214

	WDF_RESIZABLE       =   1 << 6, ///< A window can be resized

   215

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

   216

};

   217

   218

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

   219

enum WindowDefaultPosition {

   220

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

   221

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

   222

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

   223

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

   224

};

   225

   226

struct Textbuf {

   227

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

   228

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

   229

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

   230

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

   231

	uint16 caretpos;            ///< the current position of the caret in the buffer, in bytes

   232

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

   233

};

   234

   235

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

   236

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

   237

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

   238

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

   239

#define WINDOW_CUSTOM_SIZE 96

   240

   241

struct Scrollbar {

   242

	uint16 count, cap, pos;

   243

};

   244

   245

struct ResizeInfo {

   246

	uint width; ///< Minimum width and height

   247

	uint height;

   248

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

   249

	uint step_height;

   250

};

   251

   252

struct WindowMessage {

   253

	int msg;

   254

	int wparam;

   255

	int lparam;

   256

};

   257

   258

struct Window {

   259

	uint16 flags4;

   260

	WindowClass window_class;

   261

	WindowNumber window_number;

   262

   263

	int left, top;

   264

	int width, height;

   265

   266

	Scrollbar hscroll, vscroll, vscroll2;

   267

	ResizeInfo resize;

   268

   269

	byte caption_color;

   270

   271

	WindowProc *wndproc;

   272

	ViewPort *viewport;

   273

	const Widget *original_widget;

   274

	Widget *widget;

   275

	uint widget_count;

   276

	uint32 desc_flags;

   277

   278

	WindowMessage message;

   279

	Window *parent;

   280

	byte custom[WINDOW_CUSTOM_SIZE];

   281

   284

	void SetWidgetDisabledState(byte widget_index, bool disab_stat);

   285

	void DisableWidget(byte widget_index);

   286

	void EnableWidget(byte widget_index);

   287

	bool IsWidgetDisabled(byte widget_index) const;

   288

	void SetWidgetHiddenState(byte widget_index, bool hidden_stat);

   289

	void HideWidget(byte widget_index);

   290

	void ShowWidget(byte widget_index);

   291

	bool IsWidgetHidden(byte widget_index) const;

   292

	void SetWidgetLoweredState(byte widget_index, bool lowered_stat);

   293

	void ToggleWidgetLoweredState(byte widget_index);

   294

	void LowerWidget(byte widget_index);

   295

	void RaiseWidget(byte widget_index);

   296

	bool IsWidgetLowered(byte widget_index) const;

   297

   298

	void RaiseButtons();

   299

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

   300

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

   301

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

   302

	void InvalidateWidget(byte widget_index) const;

   303

};

   304

   305

struct querystr_d {

   306

	StringID caption;

   307

	Textbuf text;

   308

	const char *orig;

   309

	CharSetFilter afilter;

   310

	bool handled;

   311

};

   312

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(querystr_d));

   313

   314

struct chatquerystr_d : public querystr_d {

   315

	int dest;

   316

};

   317

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(chatquerystr_d));

   318

   319

struct menu_d {

   320

	byte item_count;      ///< follow_vehicle

   321

	byte sel_index;       ///< scrollpos_x

   322

	byte main_button;     ///< scrollpos_y

   323

	byte action_id;

   324

	StringID string_id;   ///< unk30

   325

	uint16 checked_items; ///< unk32

   326

	byte disabled_items;

   327

};

   328

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(menu_d));

   329

   330

struct def_d {

   331

	int16 data_1, data_2, data_3;

   332

	int16 data_4, data_5;

   333

	bool close;

   334

	byte byte_1;

   335

};

   336

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(def_d));

   337

   338

struct void_d {

   339

	void *data;

   340

};

   341

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(void_d));

   342

   343

struct tree_d {

   344

	uint16 base;

   345

	uint16 count;

   346

};

   347

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(tree_d));

   348

   349

struct tooltips_d {

   350

	StringID string_id;

   351

	byte paramcount;

   352

	uint64 params[5];

   353

};

   354

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(tooltips_d));

   355

   356

struct buildvehicle_d {

   357

	VehicleType vehicle_type;

   358

	union {

   359

		RailTypeByte railtype;

   360

		AirportFTAClass::Flags flags;

   361

		RoadTypes roadtypes;

   362

	} filter;

   363

	byte sel_index;  ///< deprecated value, used for 'unified' ship and road

   364

	bool descending_sort_order;

   365

	byte sort_criteria;

   366

	bool regenerate_list;

   367

	EngineID sel_engine;

   368

	EngineID rename_engine;

   369

	EngineList eng_list;

   370

};

   371

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(buildvehicle_d));

   372

   373

struct replaceveh_d {

   374

	byte sel_index[2];

   375

	EngineID sel_engine[2];

   376

	uint16 count[2];

   377

	bool wagon_btnstate; ///< true means engine is selected

   378

	EngineList list[2];

   379

	bool update_left;

   380

	bool update_right;

   381

	bool init_lists;

   382

	GroupID sel_group;

   383

};

   384

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(replaceveh_d));

   385

   386

struct depot_d {

   387

	VehicleID sel;

   388

	VehicleType type;

   389

	bool generate_list;

   390

	uint16 engine_list_length;

   391

	uint16 wagon_list_length;

   392

	uint16 engine_count;

   393

	uint16 wagon_count;

   394

	Vehicle **vehicle_list;

   395

	Vehicle **wagon_list;

   396

};

   397

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(depot_d));

   398

   399

struct order_d {

   400

	int sel;

   401

};

   402

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(order_d));

   403

   404

struct vehicledetails_d {

   405

	byte tab;

   406

};

   407

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vehicledetails_d));

   408

   409

struct smallmap_d {

   410

	int32 scroll_x;

   411

	int32 scroll_y;

   412

	int32 subscroll;

   413

};

   414

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(smallmap_d));

   415

   416

/* player face selection window */

   417

struct facesel_d {

   418

	PlayerFace face; // player face bits

   419

	bool advanced;   // advance player face selection window

   420

};

   421

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(facesel_d));

   422

   423

struct refit_d {

   424

	int sel;

   425

	struct RefitOption *cargo;

   426

	struct RefitList *list;

   427

	uint length;

   428

	VehicleOrderID order;

   429

};

   430

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(refit_d));

   431

   432

struct vp_d {

   433

	VehicleID follow_vehicle;

   434

	int32 scrollpos_x;

   435

	int32 scrollpos_y;

   436

	int32 dest_scrollpos_x;

   437

	int32 dest_scrollpos_y;

   438

};

   439

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(vp_d));

   440

   441

struct news_d {

   442

	uint16 follow_vehicle;

   443

	int32 scrollpos_x;

   444

	int32 scrollpos_y;

   445

	int32 dest_scrollpos_x;

   446

	int32 dest_scrollpos_y;

   447

	NewsItem *ni;

   448

};

   449

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(news_d));

   450

   451

struct highscore_d {

   452

	uint32 background_img;

   453

	int8 rank;

   454

};

   455

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(highscore_d));

   456

   457

struct scroller_d {

   458

	int height;

   459

	uint16 counter;

   460

};

   461

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(scroller_d));

   462

   463

enum SortListFlags {

   464

	VL_NONE    = 0,      ///< no sort

   465

	VL_DESC    = 1 << 0, ///< sort descending or ascending

   466

	VL_RESORT  = 1 << 1, ///< instruct the code to resort the list in the next loop

   467

	VL_REBUILD = 1 << 2, ///< create sort-listing to use for qsort and friends

   468

	VL_END     = 1 << 3,

   469

};

   470

   471

DECLARE_ENUM_AS_BIT_SET(SortListFlags);

   472

   473

struct Listing {

   474

	bool order;    ///< Ascending/descending

   475

	byte criteria; ///< Sorting criteria

   476

};

   477

   478

struct list_d {

   479

	uint16 list_length;  ///< length of the list being sorted

   480

	byte sort_type;      ///< what criteria to sort on

   481

	SortListFlags flags; ///< used to control sorting/resorting/etc.

   482

	uint16 resort_timer; ///< resort list after a given amount of ticks if set

   483

};