1

/* $Id$ */

     2

     3

/** @file dropdown_type.h Types related to the drop down widget. */

     4

     5

#ifndef WIDGETS_DROPDOWN_TYPE_H

     6

#define WIDGETS_DROPDOWN_TYPE_H

     7

     8

#include "../window_type.h"

     9

#include <list>

    10

    11

/**

    12

 * Base list item class from which others are derived. If placed in a list it

    13

 * will appear as a horizontal line in the menu.

    14

 */

    15

class DropDownListItem {

    16

public:

    17

	int result;  ///< Result code to return to window on selection

    18

	bool masked; ///< Masked and unselectable item

    19

    20

	DropDownListItem(int result, bool masked) : result(result), masked(masked) {}

    21

	virtual ~DropDownListItem() {}

    22

    23

	virtual bool Selectable() const { return false; }

    24

	virtual uint Height(uint width) const { return 10; }

    25

	virtual uint Width() const { return 0; }

    26

	virtual void Draw(int x, int y, uint width, uint height, bool sel, int bg_colour) const;

    27

};

    28

    29

/**

    30

 * Common string list item.

    31

 */

    32

class DropDownListStringItem : public DropDownListItem {

    33

public:

    34

	StringID string; ///< String ID of item

    35

    36

	DropDownListStringItem(StringID string, int result, bool masked) : DropDownListItem(result, masked), string(string) {}

    37

	virtual ~DropDownListStringItem() {}

    38

    39

	virtual bool Selectable() const { return true; }

    40

	virtual uint Width() const;

    41

	virtual void Draw(int x, int y, uint width, uint height, bool sel, int bg_colour) const;

    42

	virtual StringID String() const { return this->string; }

    43

};

    44

    45

/**

    46

 * String list item with parameters.

    47

 */

    48

class DropDownListParamStringItem : public DropDownListStringItem {

    49

public:

    50

	uint64 decode_params[10]; ///< Parameters of the string

    51

    52

	DropDownListParamStringItem(StringID string, int result, bool masked) : DropDownListStringItem(string, result, masked) {}

    53

	virtual ~DropDownListParamStringItem() {}

    54

    55

	virtual StringID String() const;

    56

	virtual void SetParam(uint index, uint64 value) { decode_params[index] = value; }

    57

};

    58

    59

/**

    60

 * A drop down list is a collection of drop down list items.

    61

 */

    62

typedef std::list<DropDownListItem *> DropDownList;

    63

    64

/**

    65

 * Show a drop down list.

    66

 * @param w        Parent window for the list.

    67

 * @param list     Prepopulated DropDownList. Will be deleted when the list is

    68

 *                 closed.

    69

 * @param selected The initially selected list item.

    70

 * @param button   The widget within the parent window that is used to determine

    71

 *                 the list's location.

    72

 * @param width    Override the width determined by the selected widget.

    73

 * @param auto_width Maximum width is determined by the widest item in the list.

    74

 * @param instant_close Set to true if releasing mouse button should close the

    75

 *                      list regardless of where the cursor is.

    76

 */

    77

void ShowDropDownList(Window *w, DropDownList *list, int selected, int button, uint width = 0, bool auto_width = false, bool instant_close = false);

    78

    79

#endif /* WIDGETS_DROPDOWN_TYPE_H */