1

/* $Id$ */

     2

     3

/** @file querystring_gui.h Base for the GUIs that have an edit box in them. */

     4

     5

#ifndef QUERYSTRING_GUI_H

     6

#define QUERYSTRING_GUI_H

     7

     8

#include "textbuf_gui.h"

     9

#include "window_gui.h"

    10

    11

/**

    12

 * Return values for HandleEditBoxKey

    13

 */

    14

enum HandleEditBoxResult

    15

{

    16

	HEBR_EDITING = 0, // Other key pressed.

    17

	HEBR_CONFIRM,     // Return or enter key pressed.

    18

	HEBR_CANCEL,      // Escape key pressed.

    19

};

    20

    21

/**

    22

 * Data stored about a string that can be modified in the GUI

    23

 */

    24

struct QueryString {

    25

	StringID caption;

    26

	Textbuf text;

    27

	const char *orig;

    28

	CharSetFilter afilter;

    29

	bool handled;

    30

    31

	/**

    32

	 * Make sure everything gets initialized properly.

    33

	 */

    34

	QueryString() : orig(NULL)

    35

	{

    36

	}

    37

    38

	/**

    39

	 * Make sure everything gets freed.

    40

	 */

    41

	~QueryString()

    42

	{

    43

		free((void*)this->orig);

    44

	}

    45

    46

	void DrawEditBox(Window *w, int wid);

    47

	void HandleEditBox(Window *w, int wid);

    48

	HandleEditBoxResult HandleEditBoxKey(Window *w, int wid, uint16 key, uint16 keycode, Window::EventState &state);

    49

};

    50

    51

struct QueryStringBaseWindow : public Window, public QueryString {

    52

	char *edit_str_buf;

    53

	char *orig_str_buf;

    54

	const uint16 edit_str_size; ///< maximum length of string (in bytes), including terminating '\0'

    55

    56

	QueryStringBaseWindow(uint16 size, const WindowDesc *desc, WindowNumber window_number = 0) : Window(desc, window_number), edit_str_size(size)

    57

	{

    58

		assert(size != 0);

    59

		this->edit_str_buf = CallocT<char>(size);

    60

	}

    61

    62

	~QueryStringBaseWindow()

    63

	{

    64

		free(this->edit_str_buf);

    65

	}

    66

    67

	void DrawEditBox(int wid);

    68

	void HandleEditBox(int wid);

    69

	int HandleEditBoxKey(int wid, uint16 key, uint16 keycode, EventState &state);

    70

};

    71

    72

void ShowOnScreenKeyboard(QueryStringBaseWindow *parent, int button, int cancel, int ok);

    73

    74

#endif /* QUERYSTRING_GUI_H */