]> git.saurik.com Git - wxWidgets.git/blob - src/common/stockitem.cpp
final sweep over docs - replace & with \&
[wxWidgets.git] / src / common / stockitem.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: common/stockitem.cpp
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
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "stockitem.h"
22 #endif
23
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
26
27 #ifdef __BORLANDC__
28 #pragma hdrstop
29 #endif
30
31 #include "wx/stockitem.h"
32 #include "wx/intl.h"
33
34
35 bool wxIsStockID(wxWindowID id)
36 {
37 switch (id)
38 {
39 case wxID_ADD:
40 case wxID_APPLY:
41 case wxID_BOLD:
42 case wxID_CANCEL:
43 case wxID_CLEAR:
44 case wxID_CLOSE:
45 case wxID_COPY:
46 case wxID_CUT:
47 case wxID_DELETE:
48 case wxID_FIND:
49 case wxID_REPLACE:
50 case wxID_BACKWARD:
51 case wxID_DOWN:
52 case wxID_FORWARD:
53 case wxID_UP:
54 case wxID_HELP:
55 case wxID_HOME:
56 case wxID_INDENT:
57 case wxID_INDEX:
58 case wxID_ITALIC:
59 case wxID_JUSTIFY_CENTER:
60 case wxID_JUSTIFY_FILL:
61 case wxID_JUSTIFY_LEFT:
62 case wxID_JUSTIFY_RIGHT:
63 case wxID_NEW:
64 case wxID_NO:
65 case wxID_OK:
66 case wxID_OPEN:
67 case wxID_PASTE:
68 case wxID_PREFERENCES:
69 case wxID_PRINT:
70 case wxID_PREVIEW:
71 case wxID_PROPERTIES:
72 case wxID_EXIT:
73 case wxID_REDO:
74 case wxID_REFRESH:
75 case wxID_REMOVE:
76 case wxID_REVERT_TO_SAVED:
77 case wxID_SAVE:
78 case wxID_SAVEAS:
79 case wxID_STOP:
80 case wxID_UNDELETE:
81 case wxID_UNDERLINE:
82 case wxID_UNDO:
83 case wxID_UNINDENT:
84 case wxID_YES:
85 case wxID_ZOOM_100:
86 case wxID_ZOOM_FIT:
87 case wxID_ZOOM_IN:
88 case wxID_ZOOM_OUT:
89 return true;
90
91 default:
92 return false;
93 };
94 }
95
96 wxString wxGetStockLabel(wxWindowID id)
97 {
98 #define STOCKITEM(stockid, label) \
99 case stockid: \
100 return label;
101
102 switch (id)
103 {
104 STOCKITEM(wxID_ADD, _("Add"))
105 STOCKITEM(wxID_APPLY, _("&Apply"))
106 STOCKITEM(wxID_BOLD, _("&Bold"))
107 STOCKITEM(wxID_CANCEL, _("&Cancel"))
108 STOCKITEM(wxID_CLEAR, _("&Clear"))
109 STOCKITEM(wxID_CLOSE, _("&Close"))
110 STOCKITEM(wxID_COPY, _("&Copy"))
111 STOCKITEM(wxID_CUT, _("Cu&t"))
112 STOCKITEM(wxID_DELETE, _("&Delete"))
113 STOCKITEM(wxID_FIND, _("&Find"))
114 STOCKITEM(wxID_REPLACE, _("Rep&lace"))
115 STOCKITEM(wxID_BACKWARD, _("&Back"))
116 STOCKITEM(wxID_DOWN, _("&Down"))
117 STOCKITEM(wxID_FORWARD, _("&Forward"))
118 STOCKITEM(wxID_UP, _("&Up"))
119 STOCKITEM(wxID_HELP, _("&Help"))
120 STOCKITEM(wxID_HOME, _("&Home"))
121 STOCKITEM(wxID_INDENT, _("Indent"))
122 STOCKITEM(wxID_INDEX, _("&Index"))
123 STOCKITEM(wxID_ITALIC, _("&Italic"))
124 STOCKITEM(wxID_JUSTIFY_CENTER, _("Centered"))
125 STOCKITEM(wxID_JUSTIFY_FILL, _("Justified"))
126 STOCKITEM(wxID_JUSTIFY_LEFT, _("Align Left"))
127 STOCKITEM(wxID_JUSTIFY_RIGHT, _("Align Right"))
128 STOCKITEM(wxID_NEW, _("&New"))
129 STOCKITEM(wxID_NO, _("&No"))
130 STOCKITEM(wxID_OK, _("&OK"))
131 STOCKITEM(wxID_OPEN, _("&Open"))
132 STOCKITEM(wxID_PASTE, _("&Paste"))
133 STOCKITEM(wxID_PREFERENCES, _("&Preferences"))
134 STOCKITEM(wxID_PRINT, _("&Print"))
135 STOCKITEM(wxID_PREVIEW, _("Print previe&w"))
136 STOCKITEM(wxID_PROPERTIES, _("&Properties"))
137 STOCKITEM(wxID_EXIT, _("&Quit"))
138 STOCKITEM(wxID_REDO, _("&Redo"))
139 STOCKITEM(wxID_REFRESH, _("Refresh"))
140 STOCKITEM(wxID_REMOVE, _("Remove"))
141 STOCKITEM(wxID_REVERT_TO_SAVED, _("Revert to Saved"))
142 STOCKITEM(wxID_SAVE, _("&Save"))
143 STOCKITEM(wxID_SAVEAS, _("Save &As..."))
144 STOCKITEM(wxID_STOP, _("&Stop"))
145 STOCKITEM(wxID_UNDELETE, _("Undelete"))
146 STOCKITEM(wxID_UNDERLINE, _("&Underline"))
147 STOCKITEM(wxID_UNDO, _("&Undo"))
148 STOCKITEM(wxID_UNINDENT, _("&Unindent"))
149 STOCKITEM(wxID_YES, _("&Yes"))
150 STOCKITEM(wxID_ZOOM_100, _("&Actual Size"))
151 STOCKITEM(wxID_ZOOM_FIT, _("Zoom to &Fit"))
152 STOCKITEM(wxID_ZOOM_IN, _("Zoom &In"))
153 STOCKITEM(wxID_ZOOM_OUT, _("Zoom &Out"))
154
155 default:
156 wxFAIL_MSG( _T("invalid stock item ID") );
157 break;
158 };
159
160 #undef STOCKITEM
161
162 return wxEmptyString;
163 }
164
165 bool wxIsStockLabel(wxWindowID id, const wxString& label)
166 {
167 if (label.empty())
168 return true;
169
170 wxString stock = wxGetStockLabel(id);
171
172 if (label == stock)
173 return true;
174
175 stock.Replace(_T("&"), wxEmptyString);
176 if (label == stock)
177 return true;
178
179 return false;
180 }
181
182
183 #ifdef __WXGTK20__
184
185 #include <gtk/gtk.h>
186
187 const char *wxGetStockGtkID(wxWindowID id)
188 {
189 #define STOCKITEM(wx,gtk) \
190 case wx: \
191 return gtk;
192
193 #define STOCKITEM_MISSING(wx) \
194 case wx: \
195 return NULL;
196
197 #if GTK_CHECK_VERSION(2,4,0)
198 #define STOCKITEM_24(wx,gtk) STOCKITEM(wx,gtk)
199 #else
200 #define STOCKITEM_24(wx,gtk) STOCKITEM_MISSING(wx)
201 #endif
202
203 switch (id)
204 {
205 STOCKITEM(wxID_ADD, GTK_STOCK_ADD)
206 STOCKITEM(wxID_APPLY, GTK_STOCK_APPLY)
207 STOCKITEM(wxID_BOLD, GTK_STOCK_BOLD)
208 STOCKITEM(wxID_CANCEL, GTK_STOCK_CANCEL)
209 STOCKITEM(wxID_CLEAR, GTK_STOCK_CLEAR)
210 STOCKITEM(wxID_CLOSE, GTK_STOCK_CLOSE)
211 STOCKITEM(wxID_COPY, GTK_STOCK_COPY)
212 STOCKITEM(wxID_CUT, GTK_STOCK_CUT)
213 STOCKITEM(wxID_DELETE, GTK_STOCK_DELETE)
214 STOCKITEM(wxID_FIND, GTK_STOCK_FIND)
215 STOCKITEM(wxID_REPLACE, GTK_STOCK_FIND_AND_REPLACE)
216 STOCKITEM(wxID_BACKWARD, GTK_STOCK_GO_BACK)
217 STOCKITEM(wxID_DOWN, GTK_STOCK_GO_DOWN)
218 STOCKITEM(wxID_FORWARD, GTK_STOCK_GO_FORWARD)
219 STOCKITEM(wxID_UP, GTK_STOCK_GO_UP)
220 STOCKITEM(wxID_HELP, GTK_STOCK_HELP)
221 STOCKITEM(wxID_HOME, GTK_STOCK_HOME)
222 STOCKITEM_24(wxID_INDENT, GTK_STOCK_INDENT)
223 STOCKITEM(wxID_INDEX, GTK_STOCK_INDEX)
224 STOCKITEM(wxID_ITALIC, GTK_STOCK_ITALIC)
225 STOCKITEM(wxID_JUSTIFY_CENTER, GTK_STOCK_JUSTIFY_CENTER)
226 STOCKITEM(wxID_JUSTIFY_FILL, GTK_STOCK_JUSTIFY_FILL)
227 STOCKITEM(wxID_JUSTIFY_LEFT, GTK_STOCK_JUSTIFY_LEFT)
228 STOCKITEM(wxID_JUSTIFY_RIGHT, GTK_STOCK_JUSTIFY_RIGHT)
229 STOCKITEM(wxID_NEW, GTK_STOCK_NEW)
230 STOCKITEM(wxID_NO, GTK_STOCK_NO)
231 STOCKITEM(wxID_OK, GTK_STOCK_OK)
232 STOCKITEM(wxID_OPEN, GTK_STOCK_OPEN)
233 STOCKITEM(wxID_PASTE, GTK_STOCK_PASTE)
234 STOCKITEM(wxID_PREFERENCES, GTK_STOCK_PREFERENCES)
235 STOCKITEM(wxID_PRINT, GTK_STOCK_PRINT)
236 STOCKITEM(wxID_PREVIEW, GTK_STOCK_PRINT_PREVIEW)
237 STOCKITEM(wxID_PROPERTIES, GTK_STOCK_PROPERTIES)
238 STOCKITEM(wxID_EXIT, GTK_STOCK_QUIT)
239 STOCKITEM(wxID_REDO, GTK_STOCK_REDO)
240 STOCKITEM(wxID_REFRESH, GTK_STOCK_REFRESH)
241 STOCKITEM(wxID_REMOVE, GTK_STOCK_REMOVE)
242 STOCKITEM(wxID_REVERT_TO_SAVED, GTK_STOCK_REVERT_TO_SAVED)
243 STOCKITEM(wxID_SAVE, GTK_STOCK_SAVE)
244 STOCKITEM(wxID_SAVEAS, GTK_STOCK_SAVE_AS)
245 STOCKITEM(wxID_STOP, GTK_STOCK_STOP)
246 STOCKITEM(wxID_UNDELETE, GTK_STOCK_UNDELETE)
247 STOCKITEM(wxID_UNDERLINE, GTK_STOCK_UNDERLINE)
248 STOCKITEM(wxID_UNDO, GTK_STOCK_UNDO)
249 STOCKITEM_24(wxID_UNINDENT, GTK_STOCK_UNINDENT)
250 STOCKITEM(wxID_YES, GTK_STOCK_YES)
251 STOCKITEM(wxID_ZOOM_100, GTK_STOCK_ZOOM_100)
252 STOCKITEM(wxID_ZOOM_FIT, GTK_STOCK_ZOOM_FIT)
253 STOCKITEM(wxID_ZOOM_IN, GTK_STOCK_ZOOM_IN)
254 STOCKITEM(wxID_ZOOM_OUT, GTK_STOCK_ZOOM_OUT)
255
256 default:
257 wxFAIL_MSG( _T("invalid stock item ID") );
258 break;
259 };
260
261 #undef STOCKITEM
262
263 return NULL;
264 }
265
266 #endif // __WXGTK20__