1

/* $Id$ */

     2

     3

/** @file textbuf_gui.h Stuff related to the text buffer GUI. */

     4

     5

#ifndef TEXTBUF_GUI_H

     6

#define TEXTBUF_GUI_H

     7

     8

#include "window_type.h"

     9

#include "string_type.h"

    10

#include "strings_type.h"

    11

#include "core/enum_type.hpp"

    12

    13

struct Textbuf {

    14

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

    15

	uint16 maxsize, maxwidth; ///< the maximum size of the buffer. Maxwidth specifies screensize in pixels, maxsize is in bytes (including terminating '\0')

    16

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

    17

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

    18

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

    19

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

    20

};

    21

    22

bool HandleCaret(Textbuf *tb);

    23

    24

void DeleteTextBufferAll(Textbuf *tb);

    25

bool DeleteTextBufferChar(Textbuf *tb, int delmode);

    26

bool InsertTextBufferChar(Textbuf *tb, uint32 key);

    27

bool InsertTextBufferClipboard(Textbuf *tb);

    28

bool MoveTextBufferPos(Textbuf *tb, int navmode);

    29

void InitializeTextBuffer(Textbuf *tb, char *buf, uint16 maxsize, uint16 maxwidth);

    30

void UpdateTextBufferSize(Textbuf *tb);

    31

    32

/** Flags used in ShowQueryString() call */

    33

enum QueryStringFlags {

    34

	QSF_NONE             =    0,

    35

	QSF_ACCEPT_UNCHANGED = 0x01, ///< return success even when the text didn't change

    36

	QSF_ENABLE_DEFAULT   = 0x02, ///< enable the 'Default' button ("\0" is returned)

    37

};

    38

    39

DECLARE_ENUM_AS_BIT_SET(QueryStringFlags)

    40

    41

    42

typedef void QueryCallbackProc(Window*, bool);

    43

    44

void ShowQueryString(StringID str, StringID caption, uint maxlen, uint maxwidth, Window *parent, CharSetFilter afilter, QueryStringFlags flags);

    45

void ShowQuery(StringID caption, StringID message, Window *w, QueryCallbackProc *callback);

    46

    47

/** The number of 'characters' on the on-screen keyboard. */

    48

static const uint OSK_KEYBOARD_ENTRIES = 50;

    49

    50

/**

    51

 * The number of characters has to be OSK_KEYBOARD_ENTRIES. However, these

    52

 * have to be UTF-8 encoded, which means up to 4 bytes per character.

    53

 * Furthermore the string needs to be '\0'-terminated.

    54

 */

    55

extern char _keyboard_opt[2][OSK_KEYBOARD_ENTRIES * 4 + 1];

    56

    57

#endif /* TEXTBUF_GUI_H */