src/motif/menuitem.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        menuitem.cpp
   3 // Purpose:     wxMenuItem implementation
   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 #ifdef __GNUG__
  17     #pragma implementation "menuitem.h"
  18 #endif
  19
  20 // ----------------------------------------------------------------------------
  21 // headers
  22 // ----------------------------------------------------------------------------
  23
  24 #include "wx/menu.h"
  25 #include "wx/menuitem.h"
  26 #include "wx/utils.h"
  27 #include "wx/frame.h"
  28
  29 #include <Xm/Label.h>
  30 #include <Xm/LabelG.h>
  31 #include <Xm/CascadeBG.h>
  32 #include <Xm/CascadeB.h>
  33 #include <Xm/SeparatoG.h>
  34 #include <Xm/PushBG.h>
  35 #include <Xm/ToggleB.h>
  36 #include <Xm/ToggleBG.h>
  37 #include <Xm/RowColumn.h>
  38
  39 #include "wx/motif/private.h"
  40
  41 // ----------------------------------------------------------------------------
  42 // functions prototypes
  43 // ----------------------------------------------------------------------------
  44
  45 static void wxMenuItemCallback(Widget w, XtPointer clientData, XtPointer ptr);
  46 static void wxMenuItemArmCallback(Widget w, XtPointer clientData, XtPointer ptr);
  47 static void wxMenuItemDisarmCallback(Widget w, XtPointer clientData, XtPointer ptr);
  48
  49 // ============================================================================
  50 // implementation
  51 // ============================================================================
  52
  53 // ----------------------------------------------------------------------------
  54 // dynamic classes implementation
  55 // ----------------------------------------------------------------------------
  56
  57 #if !USE_SHARED_LIBRARY
  58     IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
  59 #endif  //USE_SHARED_LIBRARY
  60
  61 // ----------------------------------------------------------------------------
  62 // wxMenuItem
  63 // ----------------------------------------------------------------------------
  64
  65 // ctor & dtor
  66 // -----------
  67
  68 wxMenuItem::wxMenuItem(wxMenu *pParentMenu, int id,
  69                        const wxString& strName, const wxString& strHelp,
  70                        bool bCheckable,
  71                        wxMenu *pSubMenu)
  72 {
  73     wxASSERT_MSG( pParentMenu != NULL, wxT("menuitem should have a menu") );
  74
  75     // common init
  76     m_parentMenu  = pParentMenu;
  77     m_subMenu     = pSubMenu;
  78     m_id          = id;
  79     m_isEnabled   = TRUE;
  80     m_isChecked   = FALSE;
  81     m_help        = strHelp;
  82     m_isCheckable = bCheckable;
  83     m_text        = strName;
  84
  85     // Motif-specific
  86     m_menuBar      = NULL;
  87     m_buttonWidget = (WXWidget) NULL;
  88     m_topMenu      = NULL;
  89 }
  90
  91 wxMenuItem::~wxMenuItem()
  92 {
  93 }
  94
  95 // misc
  96 // ----
  97
  98 // delete the sub menu
  99 void wxMenuItem::DeleteSubMenu()
 100 {
 101     wxASSERT( m_subMenu != NULL );
 102
 103     delete m_subMenu;
 104     m_subMenu = NULL;
 105 }
 106
 107 // change item state
 108 // -----------------
 109
 110 void wxMenuItem::Enable(bool bDoEnable)
 111 {
 112     if ( m_isChecked != bDoEnable )
 113     {
 114         if ( !IsSubMenu() )
 115         {
 116             // normal menu item
 117             if (m_buttonWidget)
 118                 XtSetSensitive( (Widget) m_buttonWidget, (Boolean) bDoEnable);
 119         }
 120         else                            // submenu
 121         {
 122             // Maybe we should apply this to all items in the submenu?
 123             // Or perhaps it works anyway.
 124             if (m_buttonWidget)
 125                 XtSetSensitive( (Widget) m_buttonWidget, (Boolean) bDoEnable);
 126         }
 127
 128         wxMenuItemBase::Enable(bDoEnable);
 129     }
 130 }
 131
 132 void wxMenuItem::Check(bool bDoCheck)
 133 {
 134     wxCHECK_RET( IsCheckable(), "only checkable items may be checked" );
 135
 136     if ( m_isChecked != bDoCheck )
 137     {
 138         if ( m_buttonWidget )
 139         {
 140             wxASSERT_MSG( XtIsSubclass((Widget)m_buttonWidget,
 141                                        xmToggleButtonGadgetClass),
 142                           wxT("checkable menu item must be a toggle button") );
 143
 144             XtVaSetValues((Widget)m_buttonWidget,
 145                           XmNset, (Boolean)bDoCheck,
 146                           NULL);
 147         }
 148
 149         wxMenuItemBase::Check(bDoCheck);
 150     }
 151 }
 152
 153 //// Motif-specific
 154
 155 void wxMenuItem::CreateItem (WXWidget menu, wxMenuBar * menuBar, wxMenu * topMenu)
 156 {
 157     m_menuBar = menuBar;
 158     m_topMenu = topMenu;
 159
 160     if (GetId() == -2)
 161     {
 162         // Id=-2 identifies a Title item.
 163         m_buttonWidget = (WXWidget) XtVaCreateManagedWidget
 164             (wxStripMenuCodes(m_text),
 165             xmLabelGadgetClass, (Widget) menu, NULL);
 166     }
 167     else if ((!m_text.IsNull() && m_text != "") && (!m_subMenu))
 168     {
 169         wxString strName = wxStripMenuCodes(m_text);
 170         if (IsCheckable())
 171         {
 172             m_buttonWidget = (WXWidget) XtVaCreateManagedWidget (strName,
 173                 xmToggleButtonGadgetClass, (Widget) menu,
 174                 NULL);
 175             XtVaSetValues ((Widget) m_buttonWidget, XmNset, (Boolean) IsChecked(), NULL);
 176         }
 177         else
 178             m_buttonWidget = (WXWidget) XtVaCreateManagedWidget (strName,
 179             xmPushButtonGadgetClass, (Widget) menu,
 180             NULL);
 181         char mnem = wxFindMnemonic (m_text);
 182         if (mnem != 0)
 183             XtVaSetValues ((Widget) m_buttonWidget, XmNmnemonic, mnem, NULL);
 184
 185         //// TODO: proper accelerator treatment. What does wxFindAccelerator
 186         //// look for?
 187         strName = m_text;
 188         char *accel = wxFindAccelerator (strName);
 189         if (accel)
 190             XtVaSetValues ((Widget) m_buttonWidget, XmNaccelerator, accel, NULL);
 191
 192         // TODO: What does this do?
 193         XmString accel_str = wxFindAcceleratorText (strName);
 194         if (accel_str)
 195         {
 196             XtVaSetValues ((Widget) m_buttonWidget, XmNacceleratorText, accel_str, NULL);
 197             XmStringFree (accel_str);
 198         }
 199
 200         if (IsCheckable())
 201             XtAddCallback ((Widget) m_buttonWidget,
 202             XmNvalueChangedCallback,
 203             (XtCallbackProc) wxMenuItemCallback,
 204             (XtPointer) this);
 205         else
 206             XtAddCallback ((Widget) m_buttonWidget,
 207             XmNactivateCallback,
 208             (XtCallbackProc) wxMenuItemCallback,
 209             (XtPointer) this);
 210         XtAddCallback ((Widget) m_buttonWidget,
 211             XmNarmCallback,
 212             (XtCallbackProc) wxMenuItemArmCallback,
 213             (XtPointer) this);
 214         XtAddCallback ((Widget) m_buttonWidget,
 215             XmNdisarmCallback,
 216             (XtCallbackProc) wxMenuItemDisarmCallback,
 217             (XtPointer) this);
 218     }
 219     else if (GetId() == -1)
 220     {
 221         m_buttonWidget = (WXWidget) XtVaCreateManagedWidget ("separator",
 222             xmSeparatorGadgetClass, (Widget) menu, NULL);
 223     }
 224     else if (m_subMenu)
 225     {
 226         m_buttonWidget = m_subMenu->CreateMenu (menuBar, menu, topMenu, m_text, TRUE);
 227         m_subMenu->SetButtonWidget(m_buttonWidget);
 228         XtAddCallback ((Widget) m_buttonWidget,
 229             XmNcascadingCallback,
 230             (XtCallbackProc) wxMenuItemArmCallback,
 231             (XtPointer) this);
 232     }
 233     if (m_buttonWidget)
 234         XtSetSensitive ((Widget) m_buttonWidget, (Boolean) IsEnabled());
 235 }
 236
 237 void wxMenuItem::DestroyItem(bool full)
 238 {
 239     if (GetId() == -2)
 240     {
 241         ;      // Nothing
 242
 243     }
 244     else if ((!m_text.IsNull() && (m_text != "")) && !m_subMenu)
 245     {
 246         if (m_buttonWidget)
 247         {
 248             if (IsCheckable())
 249                 XtRemoveCallback ((Widget) m_buttonWidget, XmNvalueChangedCallback,
 250                 wxMenuItemCallback, (XtPointer) this);
 251             else
 252                 XtRemoveCallback ((Widget) m_buttonWidget, XmNactivateCallback,
 253                 wxMenuItemCallback, (XtPointer) this);
 254             XtRemoveCallback ((Widget) m_buttonWidget, XmNarmCallback,
 255                 wxMenuItemArmCallback, (XtPointer) this);
 256             XtRemoveCallback ((Widget) m_buttonWidget, XmNdisarmCallback,
 257                 wxMenuItemDisarmCallback, (XtPointer) this);
 258         }
 259     }
 260     else if (GetId() == -1)
 261     {
 262         ;      // Nothing
 263
 264     }
 265     else if (GetSubMenu())
 266     {
 267         if (m_buttonWidget)
 268         {
 269             XtRemoveCallback ((Widget) m_buttonWidget, XmNcascadingCallback,
 270                 wxMenuItemArmCallback, (XtPointer) this);
 271         }
 272         m_subMenu->DestroyMenu(full);
 273         if (full)
 274             m_buttonWidget = NULL;
 275     }
 276
 277     if (m_buttonWidget && full)
 278     {
 279         XtDestroyWidget ((Widget) m_buttonWidget);
 280         m_buttonWidget = (WXWidget) 0;
 281     }
 282 }
 283
 284 void wxMenuItem::SetText(const wxString& label)
 285 {
 286     char mnem = wxFindMnemonic (label);
 287     wxString label2 = wxStripMenuCodes(label);
 288
 289     m_text = label;
 290
 291     if (m_buttonWidget)
 292     {
 293         wxXmString label_str(label2);
 294         XtVaSetValues ((Widget) m_buttonWidget,
 295             XmNlabelString, label_str,
 296             NULL);
 297         if (mnem != 0)
 298             XtVaSetValues ((Widget) m_buttonWidget, XmNmnemonic, mnem, NULL);
 299         char *accel = wxFindAccelerator (label2);
 300         if (accel)
 301             XtVaSetValues ((Widget) m_buttonWidget, XmNaccelerator, accel, NULL);
 302
 303         XmString accel_str = wxFindAcceleratorText (label2);
 304         if (accel_str)
 305         {
 306             XtVaSetValues ((Widget) m_buttonWidget, XmNacceleratorText, accel_str, NULL);
 307             XmStringFree (accel_str);
 308         }
 309     }
 310 }
 311
 312 // ----------------------------------------------------------------------------
 313 // Motif callbacks
 314 // ----------------------------------------------------------------------------
 315
 316 void wxMenuItemCallback (Widget WXUNUSED(w), XtPointer clientData,
 317                          XtPointer WXUNUSED(ptr))
 318 {
 319     wxMenuItem *item = (wxMenuItem *) clientData;
 320     if (item)
 321     {
 322         if (item->IsCheckable())
 323         {
 324             Boolean isChecked = FALSE;
 325             XtVaGetValues ((Widget) item->GetButtonWidget(), XmNset, & isChecked, NULL);
 326
 327             // only set the flag, don't actually check anything
 328             item->wxMenuItemBase::Check(isChecked);
 329         }
 330         if (item->GetMenuBar() && item->GetMenuBar()->GetMenuBarFrame())
 331         {
 332             wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, item->GetId());
 333             commandEvent.SetEventObject(item->GetMenuBar()->GetMenuBarFrame());
 334             commandEvent.SetInt( item->GetId() );
 335
 336             item->GetMenuBar()->GetMenuBarFrame()->GetEventHandler()->ProcessEvent(commandEvent);
 337         }
 338         else if (item->GetTopMenu())
 339         {
 340             wxCommandEvent event (wxEVT_COMMAND_MENU_SELECTED, item->GetId());
 341             event.SetEventObject(item->GetTopMenu());
 342             event.SetInt( item->GetId() );
 343
 344             item->GetTopMenu()->ProcessCommand (event);
 345         }
 346     }
 347 }
 348
 349 void wxMenuItemArmCallback (Widget WXUNUSED(w), XtPointer clientData,
 350                        XtPointer WXUNUSED(ptr))
 351 {
 352     wxMenuItem *item = (wxMenuItem *) clientData;
 353     if (item)
 354     {
 355         if (item->GetMenuBar() && item->GetMenuBar()->GetMenuBarFrame())
 356         {
 357             wxMenuEvent menuEvent(wxEVT_MENU_HIGHLIGHT, item->GetId());
 358             menuEvent.SetEventObject(item->GetMenuBar()->GetMenuBarFrame());
 359
 360             item->GetMenuBar()->GetMenuBarFrame()->GetEventHandler()->ProcessEvent(menuEvent);
 361         }
 362     }
 363 }
 364
 365 void
 366 wxMenuItemDisarmCallback (Widget WXUNUSED(w), XtPointer clientData,
 367                           XtPointer WXUNUSED(ptr))
 368 {
 369     wxMenuItem *item = (wxMenuItem *) clientData;
 370     if (item)
 371     {
 372         if (item->GetMenuBar() && item->GetMenuBar()->GetMenuBarFrame())
 373         {
 374             // TODO: not sure this is correct, since -1 means something
 375             // special to event system
 376             wxMenuEvent menuEvent(wxEVT_MENU_HIGHLIGHT, -1);
 377             menuEvent.SetEventObject(item->GetMenuBar()->GetMenuBarFrame());
 378
 379             item->GetMenuBar()->GetMenuBarFrame()->GetEventHandler()->ProcessEvent(menuEvent);
 380         }
 381     }
 382 }
 383