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