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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/********************************************************************************
* *
* A c c e l e r a t o r T a b l e C l a s s *
* *
*********************************************************************************
* Copyright (C) 1998,2022 by Jeroen van der Zijp. All Rights Reserved. *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License as published by *
* the Free Software Foundation; either version 3 of the License, or *
* (at your option) any later version. *
* *
* This library 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 Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/> *
********************************************************************************/
#ifndef FXACCELTABLE_H
#define FXACCELTABLE_H
#ifndef FXOBJECT_H
#include "FXObject.h"
#endif
namespace FX {
/**
* The accelerator table sends a message to a specific
* target object when the indicated key and modifier combination
* is pressed.
*/
class FXAPI FXAccelTable : public FXObject {
FXDECLARE(FXAccelTable)
protected:
struct FXAccelKey {
FXObject *target; // Target object of message
FXSelector messagedn; // Message being sent
FXSelector messageup; // Message being sent
FXHotKey code; // Keysym and modifier mask to match
};
private:
FXAccelKey *key; // Accelerator table
FXuint max; // Largest table index
FXuint num; // Number of entries
private:
void resize(FXuint m);
private:
FXAccelTable(const FXAccelTable&);
FXAccelTable &operator=(const FXAccelTable&);
public:
long onKeyPress(FXObject*,FXSelector,void*);
long onKeyRelease(FXObject*,FXSelector,void*);
public:
/**
* Construct empty accelerator table.
*/
FXAccelTable();
/**
* Add accelerator key-combination into the accelerator table.
*/
void addAccel(FXHotKey hotkey,FXObject* target=nullptr,FXSelector seldn=0,FXSelector selup=0);
/**
* Parse key-combination description and add it into the accelerator table.
*/
void addAccel(const FXchar* string,FXObject* target=nullptr,FXSelector seldn=0,FXSelector selup=0);
void addAccel(const FXString& string,FXObject* target=nullptr,FXSelector seldn=0,FXSelector selup=0);
/**
* Remove accelerator key combination from the accelerator table.
*/
void removeAccel(FXHotKey hotkey);
/**
* Parse key-combination description and remove it from the accelerator table.
*/
void removeAccel(const FXchar* string);
void removeAccel(const FXString& string);
/**
* Return true if accelerator accelerator key-combination is in accelerator table.
*/
FXbool hasAccel(FXHotKey hotkey) const;
/**
* Parse key-combination description and return true if it is in the accelerator table.
*/
FXbool hasAccel(const FXchar* string) const;
FXbool hasAccel(const FXString& string) const;
/**
* Return target object of the given accelerator key-combination.
*/
FXObject* targetOfAccel(FXHotKey hotkey) const;
/**
* Parse key-combination description and return its target.
*/
FXObject* targetOfAccel(const FXchar* string) const;
FXObject* targetOfAccel(const FXString& string) const;
/**
* Parse accelerator from string, yielding modifier and key code.
* The syntax of the string is:
*
* <Accelerator> ::= (<Modifier> ('-' | '+'))* <Key>
*
* where:
*
* <Modifier> ::= 'Ctl' | 'Ctrl' | 'Alt' | 'Meta' | 'Shift'
*
* <Key> ::= 'Home' | 'End' | 'PgUp' | 'PgDn' | 'Left' | 'Right' |
* 'Up' | 'Down' | 'Ins' | 'Del' | 'Esc' | 'Tab' | 'Return' |
* 'Enter' | 'Back' | 'Spc' | 'Space' |
* 'F'<Digit><Digit>? |
* '#'<HexDigit>+ |
* <Letter>
*
* <Digit> ::= '0' ... '1'
* <Letter> ::= 'A' ... 'Z'
* <HexDigit> ::= '0' ... '9', 'A' ... 'F'
*
* Case is not significant, but uppercase is preferred.
* For example, parseAccel("Ctl+Shift+X") yields the same value as:
* MKUINT(KEY_X,CONTROLMASK|SHIFTMASK).
*/
static FXHotKey parseAccel(const FXchar* string);
static FXHotKey parseAccel(const FXString& string);
/**
* Unparse hot key comprising modifier and key code back
* into a string suitable for parsing with fxparseHotKey.
* For example, an input of MKUINT(KEY_X,CONTROLMASK|SHIFTMASK)
* will return the string "Ctl+Shift+X".
*/
static FXString unparseAccel(FXHotKey key);
/// Save table to a stream
virtual void save(FXStream& store) const;
/// Load table from a stream
virtual void load(FXStream& store);
/**
* Destroy accelerator table.
*/
virtual ~FXAccelTable();
};
/**
* Parse hot key from string of the form "&Hotkey", yielding modifier and
* key code. If a '&' is to be just plain text, it should be doubled.
* For example, parseHotKey(""Salt && &Pepper!"") yields the same value as
* MKUINT(KEY_p,ALTMASK).
*/
extern FXAPI FXHotKey parseHotKey(const FXString& string);
/**
* Obtain hot key offset in string, or -1 if not found.
* For example, findHotKey("Salt && &Pepper!") yields 7.
* Note that this is the byte-offset, not the character
* index!
*/
extern FXAPI FXint findHotKey(const FXString& string);
/**
* Strip hot key combination from the string.
* For example, stripHotKey("Salt && &Pepper") should
* yield "Salt & Pepper".
*/
extern FXAPI FXString stripHotKey(const FXString& string);
}
#endif
|
