]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: _menu.i | |
3 | // Purpose: SWIG interface defs for wxMenuBar, wxMenu and wxMenuItem | |
4 | // | |
5 | // Author: Robin Dunn | |
6 | // | |
7 | // Created: 24-June-1997 | |
8 | // RCS-ID: $Id$ | |
9 | // Copyright: (c) 2003 by Total Control Software | |
10 | // Licence: wxWindows license | |
11 | ///////////////////////////////////////////////////////////////////////////// | |
12 | ||
13 | // Not a %module | |
14 | ||
15 | ||
16 | //--------------------------------------------------------------------------- | |
17 | %newgroup | |
18 | ||
19 | ||
20 | MustHaveApp(wxMenu); | |
21 | ||
22 | class wxMenu : public wxEvtHandler | |
23 | { | |
24 | public: | |
25 | %pythonAppend wxMenu "self._setOORInfo(self)" | |
26 | %typemap(out) wxMenu*; // turn off this typemap | |
27 | ||
28 | wxMenu(const wxString& title = wxPyEmptyString, long style = 0); | |
29 | ||
30 | // Turn it back on again | |
31 | %typemap(out) wxMenu* { $result = wxPyMake_wxObject($1, $owner); } | |
32 | ||
33 | ||
34 | // append any kind of item (normal/check/radio/separator) | |
35 | wxMenuItem* Append(int id, | |
36 | const wxString& text, | |
37 | const wxString& help = wxPyEmptyString, | |
38 | wxItemKind kind = wxITEM_NORMAL); | |
39 | ||
40 | // append a separator to the menu | |
41 | wxMenuItem* AppendSeparator(); | |
42 | ||
43 | // append a check item | |
44 | wxMenuItem* AppendCheckItem(int id, | |
45 | const wxString& text, | |
46 | const wxString& help = wxPyEmptyString); | |
47 | ||
48 | // append a radio item | |
49 | wxMenuItem* AppendRadioItem(int id, | |
50 | const wxString& text, | |
51 | const wxString& help = wxPyEmptyString); | |
52 | // append a submenu | |
53 | %Rename(AppendMenu, wxMenuItem*, Append(int id, | |
54 | const wxString& text, | |
55 | wxMenu *submenu, | |
56 | const wxString& help = wxPyEmptyString)); | |
57 | ||
58 | wxMenuItem* AppendSubMenu(wxMenu *submenu, | |
59 | const wxString& text, | |
60 | const wxString& help = wxPyEmptyString); | |
61 | ||
62 | %disownarg(wxMenuItem*); | |
63 | // the most generic form of Append() - append anything | |
64 | %Rename(AppendItem, wxMenuItem*, Append(wxMenuItem *item)); | |
65 | // insert an item before given position | |
66 | %Rename(InsertItem, wxMenuItem*, Insert(size_t pos, wxMenuItem *item)); | |
67 | // prepend an item to the menu | |
68 | %Rename(PrependItem, wxMenuItem*, Prepend(wxMenuItem *item)); | |
69 | %cleardisown(wxMenuItem*); | |
70 | ||
71 | ||
72 | // insert a break in the menu (only works when appending the items, not | |
73 | // inserting them) | |
74 | virtual void Break(); | |
75 | ||
76 | // insert an item before given position | |
77 | wxMenuItem* Insert(size_t pos, | |
78 | int id, | |
79 | const wxString& text, | |
80 | const wxString& help = wxPyEmptyString, | |
81 | wxItemKind kind = wxITEM_NORMAL); | |
82 | ||
83 | // insert a separator | |
84 | wxMenuItem* InsertSeparator(size_t pos); | |
85 | ||
86 | // insert a check item | |
87 | wxMenuItem* InsertCheckItem(size_t pos, | |
88 | int id, | |
89 | const wxString& text, | |
90 | const wxString& help = wxPyEmptyString); | |
91 | ||
92 | // insert a radio item | |
93 | wxMenuItem* InsertRadioItem(size_t pos, | |
94 | int id, | |
95 | const wxString& text, | |
96 | const wxString& help = wxPyEmptyString); | |
97 | ||
98 | // insert a submenu | |
99 | %Rename(InsertMenu, wxMenuItem*, Insert(size_t pos, | |
100 | int id, | |
101 | const wxString& text, | |
102 | wxMenu *submenu, | |
103 | const wxString& help = wxPyEmptyString)); | |
104 | ||
105 | // prepend any item to the menu | |
106 | wxMenuItem* Prepend(int id, | |
107 | const wxString& text, | |
108 | const wxString& help = wxPyEmptyString, | |
109 | wxItemKind kind = wxITEM_NORMAL); | |
110 | ||
111 | // prepend a separator | |
112 | wxMenuItem* PrependSeparator(); | |
113 | ||
114 | // prepend a check item | |
115 | wxMenuItem* PrependCheckItem(int id, | |
116 | const wxString& text, | |
117 | const wxString& help = wxPyEmptyString); | |
118 | ||
119 | // prepend a radio item | |
120 | wxMenuItem* PrependRadioItem(int id, | |
121 | const wxString& text, | |
122 | const wxString& help = wxPyEmptyString); | |
123 | ||
124 | // prepend a submenu | |
125 | %Rename(PrependMenu, wxMenuItem*, Prepend(int id, | |
126 | const wxString& text, | |
127 | wxMenu *submenu, | |
128 | const wxString& help = wxPyEmptyString)); | |
129 | ||
130 | ||
131 | // detach an item from the menu, but don't delete it so that it can be | |
132 | // added back later (but if it's not, the caller is responsible for | |
133 | // deleting it!) | |
134 | %newobject Remove; | |
135 | wxMenuItem *Remove(int id); | |
136 | %Rename(RemoveItem, wxMenuItem*, Remove(wxMenuItem *item)); | |
137 | ||
138 | // delete an item from the menu (submenus are not destroyed by this | |
139 | // function, see Destroy) | |
140 | bool Delete(int id); | |
141 | %Rename(DeleteItem, bool, Delete(wxMenuItem *item)); | |
142 | ||
143 | %pythonAppend Destroy "args[0].thisown = 0" | |
144 | %extend { void Destroy() { delete self; } } | |
145 | ||
146 | // delete the item from menu and destroy it (if it's a submenu) | |
147 | %Rename(DestroyId, bool, Destroy(int id)); | |
148 | %Rename(DestroyItem, bool, Destroy(wxMenuItem *item)); | |
149 | ||
150 | ||
151 | // get the items | |
152 | size_t GetMenuItemCount() const; | |
153 | %extend { | |
154 | PyObject* GetMenuItems() { | |
155 | wxMenuItemList& list = self->GetMenuItems(); | |
156 | return wxPy_ConvertList(&list); | |
157 | } | |
158 | } | |
159 | ||
160 | // search | |
161 | int FindItem(const wxString& item) const; | |
162 | %Rename(FindItemById, wxMenuItem*, FindItem(int id /*, wxMenu **menu = NULL*/) const); | |
163 | ||
164 | // find by position | |
165 | wxMenuItem* FindItemByPosition(size_t position) const; | |
166 | ||
167 | // get/set items attributes | |
168 | void Enable(int id, bool enable); | |
169 | bool IsEnabled(int id) const; | |
170 | ||
171 | void Check(int id, bool check); | |
172 | bool IsChecked(int id) const; | |
173 | ||
174 | void SetLabel(int id, const wxString& label); | |
175 | wxString GetLabel(int id) const; | |
176 | ||
177 | virtual void SetHelpString(int id, const wxString& helpString); | |
178 | virtual wxString GetHelpString(int id) const; | |
179 | ||
180 | ||
181 | // the title | |
182 | virtual void SetTitle(const wxString& title); | |
183 | const wxString GetTitle() const; | |
184 | ||
185 | // event handler | |
186 | void SetEventHandler(wxEvtHandler *handler); | |
187 | wxEvtHandler *GetEventHandler() const; | |
188 | ||
189 | // invoking window | |
190 | void SetInvokingWindow(wxWindow *win); | |
191 | wxWindow *GetInvokingWindow() const; | |
192 | ||
193 | // style | |
194 | long GetStyle() const { return m_style; } | |
195 | ||
196 | ||
197 | // Updates the UI for a menu and all submenus recursively. source is the | |
198 | // object that has the update event handlers defined for it. If NULL, the | |
199 | // menu or associated window will be used. | |
200 | void UpdateUI(wxEvtHandler* source = NULL); | |
201 | ||
202 | // get the menu bar this menu is attached to (may be NULL, always NULL for | |
203 | // popup menus) | |
204 | wxMenuBar *GetMenuBar() const; | |
205 | ||
206 | // TODO: Should these be exposed? | |
207 | // called when the menu is attached/detached to/from a menu bar | |
208 | virtual void Attach(wxMenuBarBase *menubar); | |
209 | virtual void Detach(); | |
210 | ||
211 | // is the menu attached to a menu bar (or is it a popup one)? | |
212 | bool IsAttached() const; | |
213 | ||
214 | // set/get the parent of this menu | |
215 | void SetParent(wxMenu *parent); | |
216 | wxMenu *GetParent() const; | |
217 | }; | |
218 | ||
219 | //--------------------------------------------------------------------------- | |
220 | %newgroup | |
221 | ||
222 | MustHaveApp(wxMenuBar); | |
223 | ||
224 | class wxMenuBar : public wxWindow | |
225 | { | |
226 | public: | |
227 | %pythonAppend wxMenuBar "self._setOORInfo(self)" | |
228 | %typemap(out) wxMenuBar*; // turn off this typemap | |
229 | ||
230 | wxMenuBar(long style = 0); | |
231 | ||
232 | // Turn it back on again | |
233 | %typemap(out) wxMenuBar* { $result = wxPyMake_wxObject($1, $owner); } | |
234 | ||
235 | // append a menu to the end of menubar, return True if ok | |
236 | virtual bool Append(wxMenu *menu, const wxString& title); | |
237 | ||
238 | // insert a menu before the given position into the menubar, return True | |
239 | // if inserted ok | |
240 | virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title); | |
241 | ||
242 | ||
243 | // get the number of menus in the menu bar | |
244 | size_t GetMenuCount() const; | |
245 | ||
246 | // get the menu at given position | |
247 | wxMenu *GetMenu(size_t pos) const; | |
248 | ||
249 | // replace the menu at given position with another one, returns the | |
250 | // previous menu (which should be deleted by the caller) | |
251 | virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title); | |
252 | ||
253 | // delete the menu at given position from the menu bar, return the pointer | |
254 | // to the menu (which should be deleted by the caller) | |
255 | virtual wxMenu *Remove(size_t pos); | |
256 | ||
257 | // enable or disable a submenu | |
258 | virtual void EnableTop(size_t pos, bool enable); | |
259 | ||
260 | // is the menu enabled? | |
261 | virtual bool IsEnabledTop(size_t pos) const; | |
262 | ||
263 | // get or change the label of the menu at given position | |
264 | virtual void SetLabelTop(size_t pos, const wxString& label); | |
265 | virtual wxString GetLabelTop(size_t pos) const; | |
266 | ||
267 | ||
268 | // by menu and item names, returns wxNOT_FOUND if not found or id of the | |
269 | // found item | |
270 | virtual int FindMenuItem(const wxString& menu, const wxString& item) const; | |
271 | ||
272 | // find item by id (in any menu), returns NULL if not found | |
273 | // | |
274 | // if menu is !NULL, it will be filled with wxMenu this item belongs to | |
275 | %Rename(FindItemById, virtual wxMenuItem*, FindItem(int id /*, wxMenu **menu = NULL*/) const); | |
276 | ||
277 | // find menu by its caption, return wxNOT_FOUND on failure | |
278 | int FindMenu(const wxString& title); | |
279 | ||
280 | ||
281 | // all these functions just use FindItem() and then call an appropriate | |
282 | // method on it | |
283 | // | |
284 | // NB: under MSW, these methods can only be used after the menubar had | |
285 | // been attached to the frame | |
286 | ||
287 | void Enable(int id, bool enable); | |
288 | void Check(int id, bool check); | |
289 | bool IsChecked(int id) const; | |
290 | bool IsEnabled(int id) const; | |
291 | // TODO: bool IsEnabled() const; | |
292 | ||
293 | void SetLabel(int id, const wxString &label); | |
294 | wxString GetLabel(int id) const; | |
295 | ||
296 | void SetHelpString(int id, const wxString& helpString); | |
297 | wxString GetHelpString(int id) const; | |
298 | ||
299 | ||
300 | // get the frame we are attached to (may return NULL) | |
301 | wxFrame *GetFrame() const; | |
302 | ||
303 | // returns True if we're attached to a frame | |
304 | bool IsAttached() const; | |
305 | ||
306 | // associate the menubar with the frame | |
307 | virtual void Attach(wxFrame *frame); | |
308 | ||
309 | // called before deleting the menubar normally | |
310 | virtual void Detach(); | |
311 | ||
312 | // update all menu item states in all menus | |
313 | virtual void UpdateMenus(); | |
314 | ||
315 | #ifdef __WXMAC__ | |
316 | static void SetAutoWindowMenu( bool enable ); | |
317 | static bool GetAutoWindowMenu(); | |
318 | #else | |
319 | %extend { | |
320 | static void SetAutoWindowMenu( bool enable ) {} | |
321 | static bool GetAutoWindowMenu() { return false; } | |
322 | } | |
323 | #endif | |
324 | }; | |
325 | ||
326 | //--------------------------------------------------------------------------- | |
327 | %newgroup | |
328 | ||
329 | class wxMenuItem : public wxObject { | |
330 | public: | |
331 | wxMenuItem(wxMenu* parentMenu=NULL, int id=wxID_ANY, | |
332 | const wxString& text = wxPyEmptyString, | |
333 | const wxString& help = wxPyEmptyString, | |
334 | wxItemKind kind = wxITEM_NORMAL, | |
335 | wxMenu* subMenu = NULL); | |
336 | ~wxMenuItem(); | |
337 | ||
338 | // the menu we're in | |
339 | wxMenu *GetMenu() const; | |
340 | void SetMenu(wxMenu* menu); | |
341 | ||
342 | // get/set id | |
343 | void SetId(int id); | |
344 | int GetId() const; | |
345 | bool IsSeparator() const; | |
346 | ||
347 | // the item's text (or name) | |
348 | // | |
349 | // NB: the item's text includes the accelerators and mnemonics info (if | |
350 | // any), i.e. it may contain '&' or '_' or "\t..." and thus is | |
351 | // different from the item's label which only contains the text shown | |
352 | // in the menu | |
353 | virtual void SetText(const wxString& str); | |
354 | wxString GetLabel() const; | |
355 | const wxString& GetText() const; | |
356 | ||
357 | // get the label from text | |
358 | static wxString GetLabelFromText(const wxString& text); | |
359 | ||
360 | // what kind of menu item we are | |
361 | wxItemKind GetKind() const; | |
362 | void SetKind(wxItemKind kind); | |
363 | ||
364 | virtual void SetCheckable(bool checkable); | |
365 | bool IsCheckable() const; | |
366 | ||
367 | bool IsSubMenu() const; | |
368 | void SetSubMenu(wxMenu *menu); | |
369 | wxMenu *GetSubMenu() const; | |
370 | ||
371 | // state | |
372 | virtual void Enable(bool enable = true); | |
373 | virtual bool IsEnabled() const; | |
374 | ||
375 | virtual void Check(bool check = true); | |
376 | virtual bool IsChecked() const; | |
377 | void Toggle(); | |
378 | ||
379 | // help string (displayed in the status bar by default) | |
380 | void SetHelp(const wxString& str); | |
381 | const wxString& GetHelp() const; | |
382 | ||
383 | // get our accelerator or NULL (caller must delete the pointer) | |
384 | virtual wxAcceleratorEntry *GetAccel() const; | |
385 | ||
386 | // set the accel for this item - this may also be done indirectly with | |
387 | // SetText() | |
388 | virtual void SetAccel(wxAcceleratorEntry *accel); | |
389 | ||
390 | void SetBitmap(const wxBitmap& bitmap); | |
391 | const wxBitmap& GetBitmap(); | |
392 | ||
393 | // wxOwnerDrawn methods | |
394 | #ifdef __WXMSW__ | |
395 | void SetFont(const wxFont& font); | |
396 | wxFont GetFont(); | |
397 | void SetTextColour(const wxColour& colText); | |
398 | wxColour GetTextColour(); | |
399 | void SetBackgroundColour(const wxColour& colBack); | |
400 | wxColour GetBackgroundColour(); | |
401 | void SetBitmaps(const wxBitmap& bmpChecked, | |
402 | const wxBitmap& bmpUnchecked = wxNullBitmap); | |
403 | ||
404 | void SetDisabledBitmap( const wxBitmap& bmpDisabled ); | |
405 | const wxBitmap& GetDisabledBitmap() const; | |
406 | ||
407 | void SetMarginWidth(int nWidth); | |
408 | int GetMarginWidth(); | |
409 | static int GetDefaultMarginWidth(); | |
410 | bool IsOwnerDrawn(); | |
411 | ||
412 | // switch on/off owner-drawing the item | |
413 | void SetOwnerDrawn(bool ownerDrawn = true); | |
414 | void ResetOwnerDrawn(); | |
415 | #else | |
416 | %extend { | |
417 | void SetFont(const wxFont& font) {} | |
418 | wxFont GetFont() { return wxNullFont; } | |
419 | void SetTextColour(const wxColour& colText) {} | |
420 | wxColour GetTextColour() { return wxNullColour; } | |
421 | void SetBackgroundColour(const wxColour& colBack) {} | |
422 | wxColour GetBackgroundColour() { return wxNullColour; } | |
423 | ||
424 | void SetBitmaps(const wxBitmap& bmpChecked, | |
425 | const wxBitmap& bmpUnchecked = wxNullBitmap) | |
426 | { self->SetBitmap( bmpChecked ); } | |
427 | ||
428 | void SetDisabledBitmap( const wxBitmap& bmpDisabled ) {} | |
429 | const wxBitmap& GetDisabledBitmap() const { return wxNullBitmap; } | |
430 | ||
431 | void SetMarginWidth(int nWidth) {} | |
432 | int GetMarginWidth() { return 0; } | |
433 | static int GetDefaultMarginWidth() { return 0; } | |
434 | bool IsOwnerDrawn() { return false; } | |
435 | void SetOwnerDrawn(bool ownerDrawn = true) {} | |
436 | void ResetOwnerDrawn() {} | |
437 | } | |
438 | #endif | |
439 | }; | |
440 | ||
441 | //--------------------------------------------------------------------------- | |
442 | //--------------------------------------------------------------------------- |