1

/* $Id$ */

     2

     3

#ifndef WIDGETS_DROPDOWN_TYPE_H

     4

#define WIDGETS_DROPDOWN_TYPE_H

     5

     6

#include "../window_type.h"

     7

#include <list>

     8

     9

/**

    10

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

    11

 * will appear as a horizontal line in the menu.

    12

 */

    13

class DropDownListItem {

    14

public:

    15

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

    16

	bool masked; ///< Masked and unselectable item

    17

    18

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

    19

	virtual ~DropDownListItem() {}

    20

	virtual StringID String() const;

    21

	virtual uint Height(uint width) const;

    23

};

    24

    25

/**

    26

 * Common string list item.

    27

 */

    28

class DropDownListStringItem : public DropDownListItem {

    29

public:

    30

	StringID string; ///< String ID of item

    31

    32

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

    33

	virtual ~DropDownListStringItem() {}

    34

    35

	StringID String() const;

    36

};

    37

    38

/**

    39

 * String list item with parameters.

    40

 */

    41

class DropDownListParamStringItem : public DropDownListStringItem {

    42

public:

    43

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

    44

    45

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

    46

	virtual ~DropDownListParamStringItem() {}

    47

    48

	StringID String() const;

    49

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

    50

};

    51

    52

/**

    53

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

    54

 */

    55

typedef std::list<DropDownListItem *> DropDownList;

    56

    57

/**

    58

 * Show a drop down list.

    59

 * @param w        Parent window for the list.

    60

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

    61

 *                 closed.

    62

 * @param selected The initially selected list item.

    63

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

    64

 *                 the list's location.

    65

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

    66

 */

    67

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

    68

    69

#endif /* WIDGETS_DROPDOWN_TYPE_H */