]>
Commit | Line | Data |
---|---|---|
1 | /////////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/accel.h | |
3 | // Purpose: wxAcceleratorEntry and wxAcceleratorTable classes | |
4 | // Author: Julian Smart, Robert Roebling, Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 31.05.01 (extracted from other files) | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) wxWidgets team | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_ACCEL_H_BASE_ | |
13 | #define _WX_ACCEL_H_BASE_ | |
14 | ||
15 | #include "wx/defs.h" | |
16 | ||
17 | #if wxUSE_ACCEL | |
18 | ||
19 | #include "wx/object.h" | |
20 | ||
21 | class WXDLLIMPEXP_FWD_CORE wxAcceleratorTable; | |
22 | class WXDLLIMPEXP_FWD_CORE wxMenuItem; | |
23 | class WXDLLIMPEXP_FWD_CORE wxKeyEvent; | |
24 | ||
25 | // ---------------------------------------------------------------------------- | |
26 | // constants | |
27 | // ---------------------------------------------------------------------------- | |
28 | ||
29 | // wxAcceleratorEntry flags | |
30 | enum | |
31 | { | |
32 | wxACCEL_NORMAL = 0x0000, // no modifiers | |
33 | wxACCEL_ALT = 0x0001, // hold Alt key down | |
34 | wxACCEL_CTRL = 0x0002, // hold Ctrl key down | |
35 | wxACCEL_SHIFT = 0x0004, // hold Shift key down | |
36 | #if defined(__WXMAC__) || defined(__WXCOCOA__) | |
37 | wxACCEL_CMD = 0x0008 // Command key on OS X | |
38 | #else | |
39 | wxACCEL_CMD = wxACCEL_CTRL | |
40 | #endif | |
41 | }; | |
42 | ||
43 | // ---------------------------------------------------------------------------- | |
44 | // an entry in wxAcceleratorTable corresponds to one accelerator | |
45 | // ---------------------------------------------------------------------------- | |
46 | ||
47 | class WXDLLEXPORT wxAcceleratorEntry | |
48 | { | |
49 | public: | |
50 | wxAcceleratorEntry(int flags = 0, int keyCode = 0, int cmd = 0, | |
51 | wxMenuItem *item = NULL) | |
52 | : m_flags(flags) | |
53 | , m_keyCode(keyCode) | |
54 | , m_command(cmd) | |
55 | , m_item(item) | |
56 | { } | |
57 | ||
58 | wxAcceleratorEntry(const wxAcceleratorEntry& entry) | |
59 | : m_flags(entry.m_flags) | |
60 | , m_keyCode(entry.m_keyCode) | |
61 | , m_command(entry.m_command) | |
62 | , m_item(entry.m_item) | |
63 | { } | |
64 | ||
65 | // create accelerator corresponding to the specified string, return NULL if | |
66 | // string couldn't be parsed or a pointer to be deleted by the caller | |
67 | static wxAcceleratorEntry *Create(const wxString& str); | |
68 | ||
69 | wxAcceleratorEntry& operator=(const wxAcceleratorEntry& entry) | |
70 | { | |
71 | if (&entry != this) | |
72 | Set(entry.m_flags, entry.m_keyCode, entry.m_command, entry.m_item); | |
73 | return *this; | |
74 | } | |
75 | ||
76 | void Set(int flags, int keyCode, int cmd, wxMenuItem *item = NULL) | |
77 | { | |
78 | m_flags = flags; | |
79 | m_keyCode = keyCode; | |
80 | m_command = cmd; | |
81 | m_item = item; | |
82 | } | |
83 | ||
84 | void SetMenuItem(wxMenuItem *item) { m_item = item; } | |
85 | ||
86 | int GetFlags() const { return m_flags; } | |
87 | int GetKeyCode() const { return m_keyCode; } | |
88 | int GetCommand() const { return m_command; } | |
89 | ||
90 | wxMenuItem *GetMenuItem() const { return m_item; } | |
91 | ||
92 | bool operator==(const wxAcceleratorEntry& entry) const | |
93 | { | |
94 | return m_flags == entry.m_flags && | |
95 | m_keyCode == entry.m_keyCode && | |
96 | m_command == entry.m_command && | |
97 | m_item == entry.m_item; | |
98 | } | |
99 | ||
100 | bool operator!=(const wxAcceleratorEntry& entry) const | |
101 | { return !(*this == entry); } | |
102 | ||
103 | #if defined(__WXMOTIF__) | |
104 | // Implementation use only | |
105 | bool MatchesEvent(const wxKeyEvent& event) const; | |
106 | #endif | |
107 | ||
108 | bool IsOk() const | |
109 | { | |
110 | return m_flags != 0 && | |
111 | m_keyCode != 0; | |
112 | } | |
113 | ||
114 | ||
115 | // string <-> wxAcceleratorEntry conversion | |
116 | // ---------------------------------------- | |
117 | ||
118 | // returns a wxString for the this accelerator. | |
119 | // this function formats it using the <flags>-<keycode> format | |
120 | // where <flags> maybe a hyphen-separed list of "shift|alt|ctrl" | |
121 | wxString ToString() const; | |
122 | ||
123 | // returns true if the given string correctly initialized this object | |
124 | // (i.e. if IsOk() returns true after this call) | |
125 | bool FromString(const wxString& str); | |
126 | ||
127 | ||
128 | private: | |
129 | // common part of Create() and FromString() | |
130 | static bool ParseAccel(const wxString& str, int *flags, int *keycode); | |
131 | ||
132 | ||
133 | int m_flags; // combination of wxACCEL_XXX constants | |
134 | int m_keyCode; // ASCII or virtual keycode | |
135 | int m_command; // Command id to generate | |
136 | ||
137 | // the menu item this entry corresponds to, may be NULL | |
138 | wxMenuItem *m_item; | |
139 | ||
140 | // for compatibility with old code, use accessors now! | |
141 | friend class WXDLLIMPEXP_FWD_CORE wxMenu; | |
142 | }; | |
143 | ||
144 | // ---------------------------------------------------------------------------- | |
145 | // include wxAcceleratorTable class declaration, it is only used by the library | |
146 | // and so doesn't have any published user visible interface | |
147 | // ---------------------------------------------------------------------------- | |
148 | ||
149 | #if defined(__WXUNIVERSAL__) | |
150 | #include "wx/generic/accel.h" | |
151 | #elif defined(__WXMSW__) | |
152 | #include "wx/msw/accel.h" | |
153 | #elif defined(__WXMOTIF__) | |
154 | #include "wx/motif/accel.h" | |
155 | #elif defined(__WXGTK20__) | |
156 | #include "wx/gtk/accel.h" | |
157 | #elif defined(__WXGTK__) | |
158 | #include "wx/gtk1/accel.h" | |
159 | #elif defined(__WXMAC__) | |
160 | #include "wx/mac/accel.h" | |
161 | #elif defined(__WXCOCOA__) | |
162 | #include "wx/generic/accel.h" | |
163 | #elif defined(__WXPM__) | |
164 | #include "wx/os2/accel.h" | |
165 | #endif | |
166 | ||
167 | extern WXDLLEXPORT_DATA(wxAcceleratorTable) wxNullAcceleratorTable; | |
168 | ||
169 | #endif // wxUSE_ACCEL | |
170 | ||
171 | #endif | |
172 | // _WX_ACCEL_H_BASE_ |