Implemented wxMenuBar::Insert and wxMenu::Insert.
[wxWidgets.git] / src / motif / menu.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: menu.cpp
3 // Purpose: wxMenu, wxMenuBar, wxMenuItem
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 17/09/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #include "wx/defs.h"
24
25 #include "wx/menu.h"
26 #include "wx/menuitem.h"
27 #include "wx/log.h"
28 #include "wx/utils.h"
29 #include "wx/app.h"
30 #include "wx/frame.h"
31 #include "wx/settings.h"
32
33 #ifdef __VMS__
34 #pragma message disable nosimpint
35 #define XtDisplay XTDISPLAY
36 #define XtWindow XTWINDOW
37 #endif
38 #include <Xm/Label.h>
39 #include <Xm/LabelG.h>
40 #include <Xm/CascadeBG.h>
41 #include <Xm/CascadeB.h>
42 #include <Xm/SeparatoG.h>
43 #include <Xm/PushBG.h>
44 #include <Xm/ToggleB.h>
45 #include <Xm/ToggleBG.h>
46 #include <Xm/RowColumn.h>
47 #ifdef __VMS__
48 #pragma message enable nosimpint
49 #endif
50
51 #include "wx/motif/private.h"
52
53 // other standard headers
54 #include <string.h>
55
56 IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler)
57 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxEvtHandler)
58
59 // ============================================================================
60 // implementation
61 // ============================================================================
62
63 // ----------------------------------------------------------------------------
64 // Menus
65 // ----------------------------------------------------------------------------
66
67 // Construct a menu with optional title (then use append)
68 void wxMenu::Init()
69 {
70 // Motif-specific members
71 m_numColumns = 1;
72 m_menuWidget = (WXWidget) NULL;
73 m_popupShell = (WXWidget) NULL;
74 m_buttonWidget = (WXWidget) NULL;
75 m_menuId = 0;
76 m_topLevelMenu = (wxMenu*) NULL;
77 m_ownedByMenuBar = false;
78
79 if ( !m_title.empty() )
80 {
81 Append(-3, m_title) ;
82 AppendSeparator() ;
83 }
84
85 m_backgroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_MENU);
86 m_foregroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_MENUTEXT);
87 m_font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
88 }
89
90 // The wxWindow destructor will take care of deleting the submenus.
91 wxMenu::~wxMenu()
92 {
93 if (m_menuWidget)
94 {
95 if (m_menuParent)
96 DestroyMenu(true);
97 else
98 DestroyMenu(false);
99 }
100
101 // Not sure if this is right
102 if (m_menuParent && m_menuBar)
103 {
104 m_menuParent = NULL;
105 // m_menuBar = NULL;
106 }
107 }
108
109 void wxMenu::Break()
110 {
111 m_numColumns++;
112 }
113
114 // function appends a new item or submenu to the menu
115 wxMenuItem* wxMenu::DoAppend(wxMenuItem *pItem)
116 {
117 return DoInsert(GetMenuItemCount(), pItem);
118 }
119
120 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
121 {
122 item->DestroyItem(true);
123
124 return wxMenuBase::DoRemove(item);
125 }
126
127 wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
128 {
129 if (m_menuWidget)
130 {
131 // this is a dynamic Append
132 #ifndef XmNpositionIndex
133 wxCHECK_MSG( pos == GetMenuItemCount(), -1, wxT("insert not implemented"));
134 #endif
135 item->CreateItem(m_menuWidget, GetMenuBar(), m_topLevelMenu, pos);
136 }
137
138 if ( item->IsSubMenu() )
139 {
140 item->GetSubMenu()->m_topLevelMenu = m_topLevelMenu;
141 }
142
143 return pos == GetMenuItemCount() ? wxMenuBase::DoAppend(item) :
144 wxMenuBase::DoInsert(pos, item);
145 }
146
147 void wxMenu::SetTitle(const wxString& label)
148 {
149 m_title = label;
150
151 wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
152 if ( !node )
153 return;
154
155 wxMenuItem *item = node->GetData ();
156 Widget widget = (Widget) item->GetButtonWidget();
157 if ( !widget )
158 return;
159
160 wxXmString title_str(label);
161 XtVaSetValues(widget,
162 XmNlabelString, title_str(),
163 NULL);
164 }
165
166 bool wxMenu::ProcessCommand(wxCommandEvent & event)
167 {
168 bool processed = false;
169
170 // Try the menu's event handler
171 if ( !processed && GetEventHandler())
172 {
173 processed = GetEventHandler()->ProcessEvent(event);
174 }
175 // Try the window the menu was popped up from (and up
176 // through the hierarchy)
177 if ( !processed && GetInvokingWindow())
178 processed = GetInvokingWindow()->ProcessEvent(event);
179
180 return processed;
181 }
182
183 // ----------------------------------------------------------------------------
184 // Menu Bar
185 // ----------------------------------------------------------------------------
186
187 void wxMenuBar::Init()
188 {
189 m_eventHandler = this;
190 m_menuBarFrame = NULL;
191 m_mainWidget = (WXWidget) NULL;
192 m_backgroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_MENU);
193 m_foregroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_MENUTEXT);
194 m_font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
195 }
196
197 wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxArrayString& titles, long WXUNUSED(style))
198 {
199 wxASSERT( n == titles.GetCount() );
200
201 Init();
202
203 m_titles = titles;
204 for ( size_t i = 0; i < n; i++ )
205 m_menus.Append(menus[i]);
206 }
207
208 wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long WXUNUSED(style))
209 {
210 Init();
211
212 for ( size_t i = 0; i < n; i++ )
213 {
214 m_menus.Append(menus[i]);
215 m_titles.Add(titles[i]);
216 }
217 }
218
219 wxMenuBar::~wxMenuBar()
220 {
221 // nothing to do: wxMenuBarBase will delete the menus
222 }
223
224 void wxMenuBar::EnableTop(size_t WXUNUSED(pos), bool WXUNUSED(flag))
225 {
226 // wxFAIL_MSG("TODO");
227 // wxLogWarning("wxMenuBar::EnableTop not yet implemented.");
228 }
229
230 void wxMenuBar::SetLabelTop(size_t pos, const wxString& label)
231 {
232 wxMenu *menu = GetMenu(pos);
233 if ( !menu )
234 return;
235
236 Widget w = (Widget)menu->GetButtonWidget();
237 if (w)
238 {
239 wxXmString label_str(label);
240
241 XtVaSetValues(w,
242 XmNlabelString, label_str(),
243 NULL);
244 }
245 }
246
247 wxString wxMenuBar::GetLabelTop(size_t pos) const
248 {
249 wxMenu *menu = GetMenu(pos);
250 if ( menu )
251 {
252 Widget w = (Widget)menu->GetButtonWidget();
253 if (w)
254 {
255 XmString text;
256 XtVaGetValues(w,
257 XmNlabelString, &text,
258 NULL);
259
260 return wxXmStringToString( text );
261 }
262 }
263
264 return wxEmptyString;
265 }
266
267 bool wxMenuBar::Append(wxMenu * menu, const wxString& title)
268 {
269 return Insert(GetMenuCount(), menu, title);
270 }
271
272 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
273 {
274 wxCHECK_MSG( pos <= GetMenuCount(), false, wxT("invalid position") );
275 wxCHECK_MSG( menu, false, wxT("invalid menu") );
276 wxCHECK_MSG( !menu->GetParent() && !menu->GetButtonWidget(), false,
277 wxT("menu already appended") );
278
279 if ( m_menuBarFrame )
280 {
281 WXWidget w = menu->CreateMenu(this, GetMainWidget(), menu,
282 pos, title, true);
283 wxCHECK_MSG( w, false, wxT("failed to create menu") );
284 menu->SetButtonWidget(w);
285 }
286
287 m_titles.Insert(title, pos);
288
289 return wxMenuBarBase::Insert(pos, menu, title);
290 }
291
292 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
293 {
294 if ( !wxMenuBarBase::Replace(pos, menu, title) )
295 return NULL;
296
297 wxFAIL_MSG(wxT("TODO"));
298
299 return NULL;
300 }
301
302 wxMenu *wxMenuBar::Remove(size_t pos)
303 {
304 wxMenu *menu = wxMenuBarBase::Remove(pos);
305 if ( !menu )
306 return NULL;
307
308 if ( m_menuBarFrame )
309 menu->DestroyMenu(true);
310
311 menu->SetMenuBar(NULL);
312
313 m_titles.RemoveAt(pos);
314
315 return menu;
316 }
317
318 // Find the menu menuString, item itemString, and return the item id.
319 // Returns -1 if none found.
320 int wxMenuBar::FindMenuItem (const wxString& menuString, const wxString& itemString) const
321 {
322 char buf1[200];
323 char buf2[200];
324 wxStripMenuCodes (wxConstCast(menuString.c_str(), char), buf1);
325
326 size_t menuCount = GetMenuCount();
327 for (size_t i = 0; i < menuCount; i++)
328 {
329 wxStripMenuCodes (wxConstCast(m_titles[i].c_str(), char), buf2);
330 if (strcmp (buf1, buf2) == 0)
331 return m_menus.Item(i)->GetData()->FindItem (itemString);
332 }
333 return -1;
334 }
335
336 wxMenuItem *wxMenuBar::FindItem(int id, wxMenu ** itemMenu) const
337 {
338 if (itemMenu)
339 *itemMenu = NULL;
340
341 wxMenuItem *item = NULL;
342 size_t menuCount = GetMenuCount();
343 for (size_t i = 0; i < menuCount; i++)
344 if ((item = m_menus.Item(i)->GetData()->FindItem(id, itemMenu)))
345 return item;
346 return NULL;
347 }
348
349 // Create menubar
350 bool wxMenuBar::CreateMenuBar(wxFrame* parent)
351 {
352 if (m_mainWidget)
353 {
354 XtVaSetValues((Widget) parent->GetMainWidget(), XmNmenuBar, (Widget) m_mainWidget, NULL);
355 /*
356 if (!XtIsManaged((Widget) m_mainWidget))
357 XtManageChild((Widget) m_mainWidget);
358 */
359 XtMapWidget((Widget) m_mainWidget);
360 return true;
361 }
362
363 Widget menuBarW = XmCreateMenuBar ((Widget) parent->GetMainWidget(),
364 wxMOTIF_STR("MenuBar"), NULL, 0);
365 m_mainWidget = (WXWidget) menuBarW;
366
367 size_t menuCount = GetMenuCount();
368 for (size_t i = 0; i < menuCount; i++)
369 {
370 wxMenu *menu = GetMenu(i);
371 wxString title(m_titles[i]);
372 menu->SetButtonWidget(menu->CreateMenu (this, menuBarW, menu, i, title, true));
373
374 if (strcmp (wxStripMenuCodes(title), "Help") == 0)
375 XtVaSetValues ((Widget) menuBarW, XmNmenuHelpWidget, (Widget) menu->GetButtonWidget(), NULL);
376
377 // tear off menu support
378 #if (XmVersion >= 1002)
379 if ( menu->IsTearOff() )
380 {
381 XtVaSetValues(GetWidget(menu),
382 XmNtearOffModel, XmTEAR_OFF_ENABLED,
383 NULL);
384 Widget tearOff = XmGetTearOffControl(GetWidget(menu));
385 wxDoChangeForegroundColour((Widget) tearOff, m_foregroundColour);
386 wxDoChangeBackgroundColour((Widget) tearOff, m_backgroundColour, true);
387 #endif
388 }
389 }
390
391 SetBackgroundColour(m_backgroundColour);
392 SetForegroundColour(m_foregroundColour);
393 SetFont(m_font);
394
395 XtVaSetValues((Widget) parent->GetMainWidget(), XmNmenuBar, (Widget) m_mainWidget, NULL);
396 XtRealizeWidget ((Widget) menuBarW);
397 XtManageChild ((Widget) menuBarW);
398 SetMenuBarFrame(parent);
399
400 return true;
401 }
402
403 // Destroy menubar, but keep data structures intact so we can recreate it.
404 bool wxMenuBar::DestroyMenuBar()
405 {
406 if (!m_mainWidget)
407 {
408 SetMenuBarFrame((wxFrame*) NULL);
409 return false;
410 }
411
412 XtUnmanageChild ((Widget) m_mainWidget);
413 XtUnrealizeWidget ((Widget) m_mainWidget);
414
415 size_t menuCount = GetMenuCount();
416 for (size_t i = 0; i < menuCount; i++)
417 {
418 wxMenu *menu = GetMenu(i);
419 menu->DestroyMenu(true);
420
421 }
422 XtDestroyWidget((Widget) m_mainWidget);
423 m_mainWidget = (WXWidget) 0;
424
425 SetMenuBarFrame((wxFrame*) NULL);
426
427 return true;
428 }
429
430 // Since PopupMenu under Motif stills grab right mouse button events
431 // after it was closed, we need to delete the associated widgets to
432 // allow next PopUpMenu to appear...
433 void wxMenu::DestroyWidgetAndDetach()
434 {
435 if (GetMainWidget())
436 {
437 wxMenu *menuParent = GetParent();
438 if ( menuParent )
439 {
440 wxMenuItemList::compatibility_iterator node = menuParent->GetMenuItems().GetFirst();
441 while ( node )
442 {
443 if ( node->GetData()->GetSubMenu() == this )
444 {
445 delete node->GetData();
446 menuParent->GetMenuItems().Erase(node);
447
448 break;
449 }
450
451 node = node->GetNext();
452 }
453 }
454
455 DestroyMenu(true);
456 }
457
458 // Mark as no longer popped up
459 m_menuId = -1;
460 }
461
462 /*
463 * Create a popup or pulldown menu.
464 * Submenus of a popup will be pulldown.
465 *
466 */
467
468 WXWidget wxMenu::CreateMenu (wxMenuBar * menuBar, WXWidget parent, wxMenu * topMenu, size_t index, const wxString& title, bool pullDown)
469 {
470 Widget menu = (Widget) 0;
471 Widget buttonWidget = (Widget) 0;
472 Arg args[5];
473 XtSetArg (args[0], XmNnumColumns, m_numColumns);
474 XtSetArg (args[1], XmNpacking, (m_numColumns > 1) ? XmPACK_COLUMN : XmPACK_TIGHT);
475
476 if (!pullDown)
477 {
478 menu = XmCreatePopupMenu ((Widget) parent, wxMOTIF_STR("popup"), args, 2);
479 #if 0
480 XtAddCallback(menu,
481 XmNunmapCallback,
482 (XtCallbackProc)wxMenuPopdownCallback,
483 (XtPointer)this);
484 #endif
485 }
486 else
487 {
488 char mnem = wxFindMnemonic (title);
489 menu = XmCreatePulldownMenu ((Widget) parent, wxMOTIF_STR("pulldown"), args, 2);
490
491 wxString title2(wxStripMenuCodes(title));
492 wxXmString label_str(title2);
493 buttonWidget = XtVaCreateManagedWidget(title2,
494 #if wxUSE_GADGETS
495 xmCascadeButtonGadgetClass, (Widget) parent,
496 #else
497 xmCascadeButtonWidgetClass, (Widget) parent,
498 #endif
499 XmNlabelString, label_str(),
500 XmNsubMenuId, menu,
501 NULL);
502
503 if (mnem != 0)
504 XtVaSetValues (buttonWidget, XmNmnemonic, mnem, NULL);
505 }
506
507 m_menuWidget = (WXWidget) menu;
508
509 m_topLevelMenu = topMenu;
510
511 size_t i = 0;
512 for ( wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
513 node;
514 node = node->GetNext(), ++i )
515 {
516 wxMenuItem *item = node->GetData();
517
518 item->CreateItem(menu, menuBar, topMenu, i);
519 }
520
521 SetBackgroundColour(m_backgroundColour);
522 SetForegroundColour(m_foregroundColour);
523 SetFont(m_font);
524
525 return buttonWidget;
526 }
527
528 // Destroys the Motif implementation of the menu,
529 // but maintains the wxWidgets data structures so we can
530 // do a CreateMenu again.
531 void wxMenu::DestroyMenu (bool full)
532 {
533 for ( wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
534 node;
535 node = node->GetNext() )
536 {
537 wxMenuItem *item = node->GetData();
538 item->SetMenuBar((wxMenuBar*) NULL);
539
540 item->DestroyItem(full);
541 }
542
543 if (m_buttonWidget)
544 {
545 if (full)
546 {
547 XtVaSetValues((Widget) m_buttonWidget, XmNsubMenuId, NULL, NULL);
548 XtDestroyWidget ((Widget) m_buttonWidget);
549 m_buttonWidget = (WXWidget) 0;
550 }
551 }
552 if (m_menuWidget && full)
553 {
554 XtDestroyWidget((Widget) m_menuWidget);
555 m_menuWidget = (WXWidget) NULL;
556 }
557 }
558
559 WXWidget wxMenu::FindMenuItem (int id, wxMenuItem ** it) const
560 {
561 if (id == m_menuId)
562 {
563 if (it)
564 *it = (wxMenuItem*) NULL;
565 return m_buttonWidget;
566 }
567
568 for ( wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
569 node;
570 node = node->GetNext() )
571 {
572 wxMenuItem *item = node->GetData ();
573 if (item->GetId() == id)
574 {
575 if (it)
576 *it = item;
577 return item->GetButtonWidget();
578 }
579
580 if (item->GetSubMenu())
581 {
582 WXWidget w = item->GetSubMenu()->FindMenuItem (id, it);
583 if (w)
584 {
585 return w;
586 }
587 }
588 }
589
590 if (it)
591 *it = (wxMenuItem*) NULL;
592 return (WXWidget) NULL;
593 }
594
595 void wxMenu::SetBackgroundColour(const wxColour& col)
596 {
597 m_backgroundColour = col;
598 if (m_menuWidget)
599 wxDoChangeBackgroundColour(m_menuWidget, (wxColour&) col);
600 if (m_buttonWidget)
601 wxDoChangeBackgroundColour(m_buttonWidget, (wxColour&) col, true);
602
603 for ( wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
604 node;
605 node = node->GetNext() )
606 {
607 wxMenuItem* item = node->GetData();
608 if (item->GetButtonWidget())
609 {
610 // This crashes because it uses gadgets
611 // wxDoChangeBackgroundColour(item->GetButtonWidget(), (wxColour&) col, true);
612 }
613 if (item->GetSubMenu())
614 item->GetSubMenu()->SetBackgroundColour((wxColour&) col);
615 }
616 }
617
618 void wxMenu::SetForegroundColour(const wxColour& col)
619 {
620 m_foregroundColour = col;
621 if (m_menuWidget)
622 wxDoChangeForegroundColour(m_menuWidget, (wxColour&) col);
623 if (m_buttonWidget)
624 wxDoChangeForegroundColour(m_buttonWidget, (wxColour&) col);
625
626 for ( wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
627 node;
628 node = node->GetNext() )
629 {
630 wxMenuItem* item = node->GetData();
631 if (item->GetButtonWidget())
632 {
633 // This crashes because it uses gadgets
634 // wxDoChangeForegroundColour(item->GetButtonWidget(), (wxColour&) col);
635 }
636 if (item->GetSubMenu())
637 item->GetSubMenu()->SetForegroundColour((wxColour&) col);
638 }
639 }
640
641 void wxMenu::ChangeFont(bool keepOriginalSize)
642 {
643 // Lesstif 0.87 hangs here, but 0.93 does not; MBN: sometimes it does
644 #if !wxCHECK_LESSTIF() // || wxCHECK_LESSTIF_VERSION( 0, 93 )
645 if (!m_font.Ok() || !m_menuWidget)
646 return;
647
648 Display* dpy = XtDisplay((Widget) m_menuWidget);
649
650 XtVaSetValues ((Widget) m_menuWidget,
651 wxFont::GetFontTag(), m_font.GetFontTypeC(dpy),
652 NULL);
653 if (m_buttonWidget)
654 {
655 XtVaSetValues ((Widget) m_buttonWidget,
656 wxFont::GetFontTag(), m_font.GetFontTypeC(dpy),
657 NULL);
658 }
659
660 for ( wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
661 node;
662 node = node->GetNext() )
663 {
664 wxMenuItem* item = node->GetData();
665 if (m_menuWidget && item->GetButtonWidget() && m_font.Ok())
666 {
667 XtVaSetValues ((Widget) item->GetButtonWidget(),
668 wxFont::GetFontTag(), m_font.GetFontTypeC(dpy),
669 NULL);
670 }
671 if (item->GetSubMenu())
672 item->GetSubMenu()->ChangeFont(keepOriginalSize);
673 }
674 #endif
675 }
676
677 void wxMenu::SetFont(const wxFont& font)
678 {
679 m_font = font;
680 ChangeFont();
681 }
682
683 bool wxMenuBar::SetBackgroundColour(const wxColour& col)
684 {
685 m_backgroundColour = col;
686 if (m_mainWidget)
687 wxDoChangeBackgroundColour(m_mainWidget, (wxColour&) col);
688
689 size_t menuCount = GetMenuCount();
690 for (size_t i = 0; i < menuCount; i++)
691 m_menus.Item(i)->GetData()->SetBackgroundColour((wxColour&) col);
692
693 return true;
694 }
695
696 bool wxMenuBar::SetForegroundColour(const wxColour& col)
697 {
698 m_foregroundColour = col;
699 if (m_mainWidget)
700 wxDoChangeForegroundColour(m_mainWidget, (wxColour&) col);
701
702 size_t menuCount = GetMenuCount();
703 for (size_t i = 0; i < menuCount; i++)
704 m_menus.Item(i)->GetData()->SetForegroundColour((wxColour&) col);
705
706 return true;
707 }
708
709 void wxMenuBar::ChangeFont(bool WXUNUSED(keepOriginalSize))
710 {
711 // Nothing to do for menubar, fonts are kept in wxMenus
712 }
713
714 bool wxMenuBar::SetFont(const wxFont& font)
715 {
716 m_font = font;
717 ChangeFont();
718
719 size_t menuCount = GetMenuCount();
720 for (size_t i = 0; i < menuCount; i++)
721 m_menus.Item(i)->GetData()->SetFont(font);
722
723 return true;
724 }
725