]>
Commit | Line | Data |
---|---|---|
401e3b6e | 1 | /////////////////////////////////////////////////////////////////////////////// |
88a7a4e1 | 2 | // Name: src/common/stockitem.cpp |
401e3b6e VS |
3 | // Purpose: Stock buttons, menu and toolbar items labels |
4 | // Author: Vaclav Slavik | |
5 | // Modified by: | |
6 | // Created: 2004-08-15 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Vaclav Slavik, 2004 | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | // ============================================================================ | |
13 | // declarations | |
14 | // ============================================================================ | |
15 | ||
16 | // ---------------------------------------------------------------------------- | |
17 | // headers | |
18 | // ---------------------------------------------------------------------------- | |
19 | ||
401e3b6e VS |
20 | // For compilers that support precompilation, includes "wx.h". |
21 | #include "wx/wxprec.h" | |
22 | ||
23 | #ifdef __BORLANDC__ | |
24 | #pragma hdrstop | |
25 | #endif | |
26 | ||
27 | #include "wx/stockitem.h" | |
88a7a4e1 WS |
28 | |
29 | #ifndef WX_PRECOMP | |
30 | #include "wx/intl.h" | |
de6185e2 | 31 | #include "wx/utils.h" // for wxStripMenuCodes() |
88a7a4e1 WS |
32 | #endif |
33 | ||
5f7bcb48 VS |
34 | bool wxIsStockID(wxWindowID id) |
35 | { | |
36 | switch (id) | |
37 | { | |
ee0a94cf | 38 | case wxID_ABOUT: |
5f7bcb48 VS |
39 | case wxID_ADD: |
40 | case wxID_APPLY: | |
6b1eedc1 | 41 | case wxID_BACKWARD: |
5f7bcb48 | 42 | case wxID_BOLD: |
6b1eedc1 | 43 | case wxID_BOTTOM: |
5f7bcb48 | 44 | case wxID_CANCEL: |
6b1eedc1 | 45 | case wxID_CDROM: |
5f7bcb48 VS |
46 | case wxID_CLEAR: |
47 | case wxID_CLOSE: | |
6b1eedc1 | 48 | case wxID_CONVERT: |
5f7bcb48 VS |
49 | case wxID_COPY: |
50 | case wxID_CUT: | |
51 | case wxID_DELETE: | |
6b1eedc1 | 52 | case wxID_DOWN: |
ee0a94cf | 53 | case wxID_EDIT: |
6b1eedc1 VZ |
54 | case wxID_EXECUTE: |
55 | case wxID_EXIT: | |
ee0a94cf | 56 | case wxID_FILE: |
6b1eedc1 VZ |
57 | case wxID_FIND: |
58 | case wxID_FIRST: | |
59 | case wxID_FLOPPY: | |
5f7bcb48 | 60 | case wxID_FORWARD: |
6b1eedc1 | 61 | case wxID_HARDDISK: |
5f7bcb48 VS |
62 | case wxID_HELP: |
63 | case wxID_HOME: | |
64 | case wxID_INDENT: | |
65 | case wxID_INDEX: | |
6b1eedc1 | 66 | case wxID_INFO: |
5f7bcb48 | 67 | case wxID_ITALIC: |
6b1eedc1 | 68 | case wxID_JUMP_TO: |
5f7bcb48 VS |
69 | case wxID_JUSTIFY_CENTER: |
70 | case wxID_JUSTIFY_FILL: | |
71 | case wxID_JUSTIFY_LEFT: | |
72 | case wxID_JUSTIFY_RIGHT: | |
6b1eedc1 VZ |
73 | case wxID_LAST: |
74 | case wxID_NETWORK: | |
5f7bcb48 VS |
75 | case wxID_NEW: |
76 | case wxID_NO: | |
77 | case wxID_OK: | |
78 | case wxID_OPEN: | |
79 | case wxID_PASTE: | |
80 | case wxID_PREFERENCES: | |
5f7bcb48 | 81 | case wxID_PREVIEW: |
6b1eedc1 | 82 | case wxID_PRINT: |
5f7bcb48 | 83 | case wxID_PROPERTIES: |
5f7bcb48 VS |
84 | case wxID_REDO: |
85 | case wxID_REFRESH: | |
86 | case wxID_REMOVE: | |
6b1eedc1 | 87 | case wxID_REPLACE: |
5f7bcb48 VS |
88 | case wxID_REVERT_TO_SAVED: |
89 | case wxID_SAVE: | |
90 | case wxID_SAVEAS: | |
ee0a94cf | 91 | case wxID_SELECTALL: |
6b1eedc1 VZ |
92 | case wxID_SELECT_COLOR: |
93 | case wxID_SELECT_FONT: | |
94 | case wxID_SORT_ASCENDING: | |
95 | case wxID_SORT_DESCENDING: | |
96 | case wxID_SPELL_CHECK: | |
5f7bcb48 | 97 | case wxID_STOP: |
6b1eedc1 VZ |
98 | case wxID_STRIKETHROUGH: |
99 | case wxID_TOP: | |
5f7bcb48 VS |
100 | case wxID_UNDELETE: |
101 | case wxID_UNDERLINE: | |
102 | case wxID_UNDO: | |
103 | case wxID_UNINDENT: | |
6b1eedc1 | 104 | case wxID_UP: |
5f7bcb48 VS |
105 | case wxID_YES: |
106 | case wxID_ZOOM_100: | |
107 | case wxID_ZOOM_FIT: | |
108 | case wxID_ZOOM_IN: | |
109 | case wxID_ZOOM_OUT: | |
110 | return true; | |
111 | ||
112 | default: | |
113 | return false; | |
d0ee33f5 | 114 | } |
5f7bcb48 VS |
115 | } |
116 | ||
ee0a94cf | 117 | wxString wxGetStockLabel(wxWindowID id, long flags) |
401e3b6e | 118 | { |
634629fa WS |
119 | wxString stockLabel; |
120 | ||
f8a1c571 VZ |
121 | #ifdef __WXMSW__ |
122 | // special case: the "Cancel" button shouldn't have a mnemonic under MSW | |
123 | // for consistency with the native dialogs (which don't use any mnemonic | |
124 | // for it because it is already bound to Esc implicitly) | |
125 | if ( id == wxID_CANCEL ) | |
126 | flags &= ~wxSTOCK_WITH_MNEMONIC; | |
127 | #endif // __WXMSW__ | |
128 | ||
129 | ||
130 | #define STOCKITEM(stockid, labelWithMnemonic, labelPlain) \ | |
131 | case stockid: \ | |
132 | if(flags & wxSTOCK_WITH_MNEMONIC) \ | |
133 | stockLabel = labelWithMnemonic; \ | |
134 | else \ | |
135 | stockLabel = labelPlain; \ | |
136 | break | |
401e3b6e | 137 | |
5f7bcb48 | 138 | switch (id) |
401e3b6e | 139 | { |
f8a1c571 VZ |
140 | STOCKITEM(wxID_ABOUT, _("&About..."), _("About...")); |
141 | STOCKITEM(wxID_ADD, _("Add"), _("Add")); | |
142 | STOCKITEM(wxID_APPLY, _("&Apply"), _("Apply")); | |
143 | STOCKITEM(wxID_BACKWARD, _("&Back"), _("Back")); | |
144 | STOCKITEM(wxID_BOLD, _("&Bold"), _("Bold")); | |
145 | STOCKITEM(wxID_BOTTOM, _("&Bottom"), _("Bottom")); | |
146 | STOCKITEM(wxID_CANCEL, _("&Cancel"), _("Cancel")); | |
147 | STOCKITEM(wxID_CDROM, _("&CD-Rom"), _("CD-Rom")); | |
148 | STOCKITEM(wxID_CLEAR, _("&Clear"), _("Clear")); | |
149 | STOCKITEM(wxID_CLOSE, _("&Close"), _("Close")); | |
150 | STOCKITEM(wxID_CONVERT, _("&Convert"), _("Convert")); | |
151 | STOCKITEM(wxID_COPY, _("&Copy"), _("Copy")); | |
152 | STOCKITEM(wxID_CUT, _("Cu&t"), _("Cut")); | |
153 | STOCKITEM(wxID_DELETE, _("&Delete"), _("Delete")); | |
154 | STOCKITEM(wxID_DOWN, _("&Down"), _("Down")); | |
155 | STOCKITEM(wxID_EDIT, _("&Edit"), _("Edit")); | |
156 | STOCKITEM(wxID_EXECUTE, _("&Execute"), _("Execute")); | |
157 | STOCKITEM(wxID_EXIT, _("&Quit"), _("Quit")); | |
158 | STOCKITEM(wxID_FILE, _("&File"), _("File")); | |
159 | STOCKITEM(wxID_FIND, _("&Find"), _("Find")); | |
160 | STOCKITEM(wxID_FIRST, _("&First"), _("First")); | |
161 | STOCKITEM(wxID_FLOPPY, _("&Floppy"), _("Floppy")); | |
162 | STOCKITEM(wxID_FORWARD, _("&Forward"), _("Forward")); | |
163 | STOCKITEM(wxID_HARDDISK, _("&Harddisk"), _("Harddisk")); | |
164 | STOCKITEM(wxID_HELP, _("&Help"), _("Help")); | |
165 | STOCKITEM(wxID_HOME, _("&Home"), _("Home")); | |
166 | STOCKITEM(wxID_INDENT, _("Indent"), _("Indent")); | |
167 | STOCKITEM(wxID_INDEX, _("&Index"), _("Index")); | |
168 | STOCKITEM(wxID_INFO, _("&Info"), _("Info")); | |
169 | STOCKITEM(wxID_ITALIC, _("&Italic"), _("Italic")); | |
2032371b | 170 | STOCKITEM(wxID_JUMP_TO, _("&Jump to"), _("Jump to")); |
f8a1c571 VZ |
171 | STOCKITEM(wxID_JUSTIFY_CENTER, _("Centered"), _("Centered")); |
172 | STOCKITEM(wxID_JUSTIFY_FILL, _("Justified"), _("Justified")); | |
2032371b VZ |
173 | STOCKITEM(wxID_JUSTIFY_LEFT, _("Align Left"), _("Align Left")); |
174 | STOCKITEM(wxID_JUSTIFY_RIGHT, _("Align Right"), _("Align Right")); | |
f8a1c571 VZ |
175 | STOCKITEM(wxID_LAST, _("&Last"), _("Last")); |
176 | STOCKITEM(wxID_NETWORK, _("&Network"), _("Network")); | |
177 | STOCKITEM(wxID_NEW, _("&New"), _("New")); | |
178 | STOCKITEM(wxID_NO, _("&No"), _("No")); | |
179 | STOCKITEM(wxID_OK, _("&OK"), _("OK")); | |
180 | STOCKITEM(wxID_OPEN, _("&Open..."), _("Open...")); | |
181 | STOCKITEM(wxID_PASTE, _("&Paste"), _("Paste")); | |
182 | STOCKITEM(wxID_PREFERENCES, _("&Preferences"), _("Preferences")); | |
73d1308b | 183 | STOCKITEM(wxID_PREVIEW, _("&Preview..."), _("Preview...")); |
f8a1c571 VZ |
184 | STOCKITEM(wxID_PRINT, _("&Print..."), _("Print...")); |
185 | STOCKITEM(wxID_PROPERTIES, _("&Properties"), _("Properties")); | |
186 | STOCKITEM(wxID_REDO, _("&Redo"), _("Redo")); | |
187 | STOCKITEM(wxID_REFRESH, _("Refresh"), _("Refresh")); | |
188 | STOCKITEM(wxID_REMOVE, _("Remove"), _("Remove")); | |
189 | STOCKITEM(wxID_REPLACE, _("Rep&lace"), _("Replace")); | |
2032371b | 190 | STOCKITEM(wxID_REVERT_TO_SAVED, _("Revert to Saved"), _("Revert to Saved")); |
f8a1c571 | 191 | STOCKITEM(wxID_SAVE, _("&Save"), _("Save")); |
73d1308b | 192 | STOCKITEM(wxID_SAVEAS, _("&Save as"), _("Save as")); |
2032371b | 193 | STOCKITEM(wxID_SELECTALL, _("Select &All"), _("Select All")); |
f8a1c571 VZ |
194 | STOCKITEM(wxID_SELECT_COLOR, _("&Color"), _("Color")); |
195 | STOCKITEM(wxID_SELECT_FONT, _("&Font"), _("Font")); | |
196 | STOCKITEM(wxID_SORT_ASCENDING, _("&Ascending"), _("Ascending")); | |
197 | STOCKITEM(wxID_SORT_DESCENDING, _("&Descending"), _("Descending")); | |
2032371b | 198 | STOCKITEM(wxID_SPELL_CHECK, _("&Spell Check"), _("Spell Check")); |
f8a1c571 VZ |
199 | STOCKITEM(wxID_STOP, _("&Stop"), _("Stop")); |
200 | STOCKITEM(wxID_STRIKETHROUGH, _("&Strikethrough"), _("Strikethrough")); | |
201 | STOCKITEM(wxID_TOP, _("&Top"), _("Top")); | |
202 | STOCKITEM(wxID_UNDELETE, _("Undelete"), _("Undelete")); | |
203 | STOCKITEM(wxID_UNDERLINE, _("&Underline"), _("Underline")); | |
204 | STOCKITEM(wxID_UNDO, _("&Undo"), _("Undo")); | |
205 | STOCKITEM(wxID_UNINDENT, _("&Unindent"), _("Unindent")); | |
206 | STOCKITEM(wxID_UP, _("&Up"), _("Up")); | |
207 | STOCKITEM(wxID_YES, _("&Yes"), _("Yes")); | |
2032371b VZ |
208 | STOCKITEM(wxID_ZOOM_100, _("&Actual Size"), _("Actual Size")); |
209 | STOCKITEM(wxID_ZOOM_FIT, _("Zoom to &Fit"), _("Zoom to Fit")); | |
210 | STOCKITEM(wxID_ZOOM_IN, _("Zoom &In"), _("Zoom In")); | |
211 | STOCKITEM(wxID_ZOOM_OUT, _("Zoom &Out"), _("Zoom Out")); | |
5f7bcb48 | 212 | |
401e3b6e | 213 | default: |
9a83f860 | 214 | wxFAIL_MSG( wxT("invalid stock item ID") ); |
401e3b6e VS |
215 | break; |
216 | }; | |
217 | ||
218 | #undef STOCKITEM | |
d775fa82 | 219 | |
95ad763a | 220 | if ( flags & wxSTOCK_WITHOUT_ELLIPSIS ) |
e94ee791 VZ |
221 | { |
222 | wxString baseLabel; | |
223 | if ( stockLabel.EndsWith("...", &baseLabel) ) | |
224 | stockLabel = baseLabel; | |
225 | ||
95ad763a VZ |
226 | // accelerators only make sense for the menu items which should have |
227 | // ellipsis too while wxSTOCK_WITHOUT_ELLIPSIS is mostly useful for | |
228 | // buttons which shouldn't have accelerators in their labels | |
e94ee791 | 229 | wxASSERT_MSG( !(flags & wxSTOCK_WITH_ACCELERATOR), |
95ad763a | 230 | "labels without ellipsis shouldn't use accelerators" ); |
e94ee791 VZ |
231 | } |
232 | ||
b137e493 | 233 | #if wxUSE_ACCEL |
9b3c3047 | 234 | if ( !stockLabel.empty() && (flags & wxSTOCK_WITH_ACCELERATOR) ) |
634629fa | 235 | { |
ee0a94cf RR |
236 | wxAcceleratorEntry accel = wxGetStockAccelerator(id); |
237 | if (accel.IsOk()) | |
9a83f860 | 238 | stockLabel << wxT('\t') << accel.ToString(); |
634629fa | 239 | } |
b137e493 WS |
240 | #endif // wxUSE_ACCEL |
241 | ||
634629fa | 242 | return stockLabel; |
401e3b6e VS |
243 | } |
244 | ||
345319d6 VZ |
245 | wxString wxGetStockHelpString(wxWindowID id, wxStockHelpStringClient client) |
246 | { | |
247 | wxString stockHelp; | |
248 | ||
249 | #define STOCKITEM(stockid, ctx, helpstr) \ | |
250 | case stockid: \ | |
251 | if (client==ctx) stockHelp = helpstr; \ | |
252 | break; | |
253 | ||
254 | switch (id) | |
255 | { | |
256 | // NB: these help string should be not too specific as they could be used | |
257 | // in completely different programs! | |
258 | STOCKITEM(wxID_ABOUT, wxSTOCK_MENU, _("Show about dialog")) | |
259 | STOCKITEM(wxID_COPY, wxSTOCK_MENU, _("Copy selection")) | |
260 | STOCKITEM(wxID_CUT, wxSTOCK_MENU, _("Cut selection")) | |
261 | STOCKITEM(wxID_DELETE, wxSTOCK_MENU, _("Delete selection")) | |
262 | STOCKITEM(wxID_REPLACE, wxSTOCK_MENU, _("Replace selection")) | |
263 | STOCKITEM(wxID_PASTE, wxSTOCK_MENU, _("Paste selection")) | |
264 | STOCKITEM(wxID_EXIT, wxSTOCK_MENU, _("Quit this program")) | |
265 | STOCKITEM(wxID_REDO, wxSTOCK_MENU, _("Redo last action")) | |
266 | STOCKITEM(wxID_UNDO, wxSTOCK_MENU, _("Undo last action")) | |
267 | STOCKITEM(wxID_CLOSE, wxSTOCK_MENU, _("Close current document")) | |
268 | STOCKITEM(wxID_SAVE, wxSTOCK_MENU, _("Save current document")) | |
269 | STOCKITEM(wxID_SAVEAS, wxSTOCK_MENU, _("Save current document with a different filename")) | |
270 | ||
271 | default: | |
272 | // there's no stock help string for this ID / client | |
273 | return wxEmptyString; | |
274 | } | |
275 | ||
276 | #undef STOCKITEM | |
277 | ||
278 | return stockHelp; | |
279 | } | |
280 | ||
b137e493 WS |
281 | #if wxUSE_ACCEL |
282 | ||
ee0a94cf RR |
283 | wxAcceleratorEntry wxGetStockAccelerator(wxWindowID id) |
284 | { | |
285 | wxAcceleratorEntry ret; | |
286 | ||
287 | #define STOCKITEM(stockid, flags, keycode) \ | |
288 | case stockid: \ | |
289 | ret.Set(flags, keycode, stockid); \ | |
290 | break; | |
291 | ||
292 | switch (id) | |
293 | { | |
675ec665 SC |
294 | STOCKITEM(wxID_COPY, wxACCEL_CTRL,'C') |
295 | STOCKITEM(wxID_CUT, wxACCEL_CTRL,'X') | |
296 | STOCKITEM(wxID_FIND, wxACCEL_CTRL,'F') | |
297 | STOCKITEM(wxID_HELP, wxACCEL_CTRL,'H') | |
298 | STOCKITEM(wxID_NEW, wxACCEL_CTRL,'N') | |
299 | STOCKITEM(wxID_OPEN, wxACCEL_CTRL,'O') | |
300 | STOCKITEM(wxID_PASTE, wxACCEL_CTRL,'V') | |
d94df7c9 | 301 | STOCKITEM(wxID_PRINT, wxACCEL_CTRL,'P') |
675ec665 SC |
302 | STOCKITEM(wxID_REDO, wxACCEL_CTRL | wxACCEL_SHIFT,'Z') |
303 | STOCKITEM(wxID_REPLACE, wxACCEL_CTRL,'R') | |
304 | STOCKITEM(wxID_SAVE, wxACCEL_CTRL,'S') | |
305 | STOCKITEM(wxID_UNDO, wxACCEL_CTRL,'Z') | |
eb3cb492 SC |
306 | #ifdef __WXOSX__ |
307 | STOCKITEM(wxID_PREFERENCES, wxACCEL_CTRL,',') | |
308 | #endif | |
ee0a94cf RR |
309 | |
310 | default: | |
311 | // set the wxAcceleratorEntry to return into an invalid state: | |
312 | // there's no stock accelerator for that. | |
313 | ret.Set(0, 0, id); | |
314 | break; | |
315 | }; | |
316 | ||
317 | #undef STOCKITEM | |
318 | ||
319 | // always use wxAcceleratorEntry::IsOk on returned value ! | |
320 | return ret; | |
321 | } | |
322 | ||
b137e493 WS |
323 | #endif // wxUSE_ACCEL |
324 | ||
5f7bcb48 VS |
325 | bool wxIsStockLabel(wxWindowID id, const wxString& label) |
326 | { | |
327 | if (label.empty()) | |
328 | return true; | |
329 | ||
330 | wxString stock = wxGetStockLabel(id); | |
331 | ||
332 | if (label == stock) | |
333 | return true; | |
d775fa82 | 334 | |
9a83f860 | 335 | stock.Replace(wxT("&"), wxEmptyString); |
5f7bcb48 VS |
336 | if (label == stock) |
337 | return true; | |
d775fa82 | 338 | |
5f7bcb48 VS |
339 | return false; |
340 | } |