1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*
This file is part of Warzone 2100.
Copyright (C) 1999-2004 Eidos Interactive
Copyright (C) 2005-2020 Warzone 2100 Project
Warzone 2100 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Warzone 2100 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/** @file
* Definitions for the edit box functions.
*/
#ifndef __INCLUDED_LIB_WIDGET_EDITBOX_H__
#define __INCLUDED_LIB_WIDGET_EDITBOX_H__
#include "widget.h"
#include "widgbase.h"
#include "lib/framework/wzstring.h"
#include <functional>
/* Edit Box states */
#define WEDBS_FIXED 0x0001 // No editing is going on
#define WEDBS_INSERT 0x0002 // Insertion editing
#define WEDBS_OVER 0x0003 // Overwrite editing
#define WEDBS_MASK 0x000f //
#define WEDBS_HILITE 0x0010 //
#define WEDBS_DISABLE 0x0020 // disable button from selection
struct EditBoxDisplayCache {
WzText wzDisplayedText;
WzText modeText;
};
class W_EDITBOX : public WIDGET
{
public:
W_EDITBOX(W_EDBINIT const *init);
W_EDITBOX();
~W_EDITBOX();
void clicked(W_CONTEXT *psContext, WIDGET_KEY key = WKEY_PRIMARY) override;
void simulateClick(W_CONTEXT *psContext, bool silenceClickAudio = false, WIDGET_KEY key = WKEY_PRIMARY);
void highlight(W_CONTEXT *psContext) override;
void highlightLost() override;
void focusLost() override;
void run(W_CONTEXT *psContext) override;
void display(int xOffset, int yOffset) override;
void geometryChanged() override;
void stopEditing();
bool isEditing();
void setState(unsigned state) override;
WzString getString() const override;
void setString(WzString string) override;
void setPlaceholder(WzString value);
void setPlaceholderTextColor(optional<PIELIGHT> fixedPlaceholderTextColor);
void setMaxStringSize(int size);
void setTip(std::string string) override;
std::string getTip() override
{
return pTip;
}
void setBoxColours(PIELIGHT first, PIELIGHT second, PIELIGHT background);
typedef std::function<void (W_EDITBOX&)> OnReturnHandler;
void setOnReturnHandler(const OnReturnHandler& func);
void setOnEscapeHandler(const OnReturnHandler& func);
void setOnEditingStoppedHandler(const OnReturnHandler& func);
typedef std::function<bool (W_EDITBOX&)> OnTabHandler; // Returns true if the editbox should be done processing the current input
void setOnTabHandler(const OnTabHandler& func);
UDWORD state; // The current edit box state
WzString aText; // The text in the edit box
WzString placeholderText;
iV_fonts FontID;
int blinkOffset; // Cursor should be visible at time blinkOffset.
int maxStringSize; // max characters string will accept
int insPos; // The insertion point in the buffer
int printStart; // Where in the string appears at the far left of the box
int printChars; // The number of characters appearing in the box
int printWidth; // The pixel width of the characters in the box
WIDGET_DISPLAY pBoxDisplay; // Optional callback to display the edit box background.
SWORD HilightAudioID; // Audio ID for form clicked sound
SWORD ClickedAudioID; // Audio ID for form hilighted sound
SWORD ErrorAudioID; // Audio ID for error sound
WIDGET_AUDIOCALLBACK AudioCallback; // Pointer to audio callback function
private:
void initialise(); // Moves the cursor to the end.
void delCharRight();
void delCharLeft();
bool insertChar(WzUniCodepoint ch);
bool overwriteChar(WzUniCodepoint ch);
void fitStringStart(); // Calculate how much of the start of a string can fit into the edit box
void fitStringEnd();
void setCursorPosPixels(int xPos);
PIELIGHT boxColourFirst, boxColourSecond, boxColourBackground;
optional<PIELIGHT> fixedPlaceholderTextColor;
EditBoxDisplayCache displayCache;
bool suppressAudioCallback = false;
OnReturnHandler onRetHandler = nullptr;
OnTabHandler onTabHandler = nullptr;
OnReturnHandler onEscHandler = nullptr;
OnReturnHandler onEditingStoppedHandler = nullptr;
std::string pTip; // The tool tip for the edit box
};
#endif // __INCLUDED_LIB_WIDGET_EDITBOX_H__
|
