]> git.saurik.com Git - wxWidgets.git/blobdiff - samples/menu/menu.cpp
Some docstring additions, reformats and epydoc markup.
[wxWidgets.git] / samples / menu / menu.cpp
index ebe58946daf60cff976d38680ff29730f94da4d9..7c48defdbee6786bf3a78e4c35aa5a9cea8dc90e 100644 (file)
     #error "menu sample requires wxUSE_MENUS=1"
 #endif // wxUSE_MENUS
 
+// not all ports have support for EVT_CONTEXT_MENU yet, don't define
+// USE_CONTEXT_MENU for those which don't
+#if defined(__WXMOTIF__) || defined(__WXPM__)
+    #define USE_CONTEXT_MENU 0
+#else
+    #define USE_CONTEXT_MENU 1
+#endif
+
 #include "copy.xpm"
 
 // ----------------------------------------------------------------------------
@@ -94,7 +102,11 @@ protected:
     void OnTestCheck(wxCommandEvent& event);
     void OnTestRadio(wxCommandEvent& event);
 
-#ifdef __WXMSW__
+    void OnUpdateSubMenuNormal(wxUpdateUIEvent& event);
+    void OnUpdateSubMenuCheck(wxUpdateUIEvent& event);
+    void OnUpdateSubMenuRadio(wxUpdateUIEvent& event);
+
+#if USE_CONTEXT_MENU
     void OnContextMenu(wxContextMenuEvent& event)
         { ShowContextMenu(ScreenToClient(event.GetPosition())); }
 #else
@@ -103,9 +115,9 @@ protected:
 #endif
 
     void OnMenuOpen(wxMenuEvent& event)
-        { LogMenuOpenOrClose(event, _T("opened")); }
+        { LogMenuOpenOrClose(event, _T("opened")); event.Skip(); }
     void OnMenuClose(wxMenuEvent& event)
-        { LogMenuOpenOrClose(event, _T("closed")); }
+        { LogMenuOpenOrClose(event, _T("closed")); event.Skip(); }
 
     void OnUpdateCheckMenuItemUI(wxUpdateUIEvent& event);
 
@@ -188,6 +200,13 @@ enum
     Menu_Test_Radio2,
     Menu_Test_Radio3,
 
+    Menu_SubMenu = 450,
+    Menu_SubMenu_Normal,
+    Menu_SubMenu_Check,
+    Menu_SubMenu_Radio1,
+    Menu_SubMenu_Radio2,
+    Menu_SubMenu_Radio3,
+
     Menu_Dummy_First = 500,
     Menu_Dummy_Second,
     Menu_Dummy_Third,
@@ -240,11 +259,17 @@ BEGIN_EVENT_TABLE(MyFrame, wxFrame)
     EVT_MENU(Menu_Test_Radio2,    MyFrame::OnTestRadio)
     EVT_MENU(Menu_Test_Radio3,    MyFrame::OnTestRadio)
 
+    EVT_UPDATE_UI(Menu_SubMenu_Normal,    MyFrame::OnUpdateSubMenuNormal)
+    EVT_UPDATE_UI(Menu_SubMenu_Check,     MyFrame::OnUpdateSubMenuCheck)
+    EVT_UPDATE_UI(Menu_SubMenu_Radio1,    MyFrame::OnUpdateSubMenuRadio)
+    EVT_UPDATE_UI(Menu_SubMenu_Radio2,    MyFrame::OnUpdateSubMenuRadio)
+    EVT_UPDATE_UI(Menu_SubMenu_Radio3,    MyFrame::OnUpdateSubMenuRadio)
+
     EVT_MENU_RANGE(Menu_Dummy_First, Menu_Dummy_Last, MyFrame::OnDummy)
 
     EVT_UPDATE_UI(Menu_Menu_Check, MyFrame::OnUpdateCheckMenuItemUI)
 
-#ifdef __WXMSW__
+#if USE_CONTEXT_MENU
     EVT_CONTEXT_MENU(MyFrame::OnContextMenu)
 #else
     EVT_RIGHT_UP(MyFrame::OnRightUp)
@@ -277,7 +302,7 @@ bool MyApp::OnInit()
     // Create the main frame window
     MyFrame* frame = new MyFrame;
 
-    frame->Show(TRUE);
+    frame->Show(true);
 
 #if wxUSE_STATUSBAR
     frame->SetStatusText(_T("Welcome to wxWindows menu sample"));
@@ -285,7 +310,7 @@ bool MyApp::OnInit()
 
     SetTopWindow(frame);
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -324,10 +349,10 @@ MyFrame::MyFrame()
     menubarMenu->Append(Menu_MenuBar_Delete, _T("&Delete menu\tCtrl-D"),
                         _T("Delete the last menu from the menubar"));
     menubarMenu->Append(Menu_MenuBar_Toggle, _T("&Toggle menu\tCtrl-T"),
-                        _T("Toggle the first menu in the menubar"), TRUE);
+                        _T("Toggle the first menu in the menubar"), true);
     menubarMenu->AppendSeparator();
     menubarMenu->Append(Menu_MenuBar_Enable, _T("&Enable menu\tCtrl-E"),
-                        _T("Enable or disable the last menu"), TRUE);
+                        _T("Enable or disable the last menu"), true);
     menubarMenu->AppendSeparator();
     menubarMenu->Append(Menu_MenuBar_GetLabel, _T("&Get menu label\tCtrl-G"),
                         _T("Get the label of the last menu"));
@@ -337,6 +362,15 @@ MyFrame::MyFrame()
     menubarMenu->Append(Menu_MenuBar_FindMenu, _T("&Find menu from label\tCtrl-F"),
                         _T("Find a menu by searching for its label"));
 
+    wxMenu* subMenu = new wxMenu;
+    subMenu->Append(Menu_SubMenu_Normal, _T("&Normal submenu item"), _T("Disabled submenu item"));
+    subMenu->AppendCheckItem(Menu_SubMenu_Check, _T("&Unchecked submenu item"), _T("Unchecked submenu item"));
+    subMenu->AppendRadioItem(Menu_SubMenu_Radio1, _T("&Radio item 1"), _T("Radio item"));
+    subMenu->AppendRadioItem(Menu_SubMenu_Radio2, _T("&Radio item 2"), _T("Radio item"));
+    subMenu->AppendRadioItem(Menu_SubMenu_Radio3, _T("&Radio item 3"), _T("Radio item"));
+
+    menubarMenu->Append(Menu_SubMenu, _T("Submenu"), subMenu);
+
     wxMenu *menuMenu = new wxMenu;
     menuMenu->Append(Menu_Menu_Append, _T("&Append menu item\tAlt-A"),
                      _T("Append a menu item to the last menu"));
@@ -348,9 +382,9 @@ MyFrame::MyFrame()
                      _T("Delete the last menu item from the last menu"));
     menuMenu->AppendSeparator();
     menuMenu->Append(Menu_Menu_Enable, _T("&Enable menu item\tAlt-E"),
-                     _T("Enable or disable the last menu item"), TRUE);
+                     _T("Enable or disable the last menu item"), true);
     menuMenu->Append(Menu_Menu_Check, _T("&Check menu item\tAlt-C"),
-                     _T("Check or uncheck the last menu item"), TRUE);
+                     _T("Check or uncheck the last menu item"), true);
     menuMenu->AppendSeparator();
     menuMenu->Append(Menu_Menu_GetInfo, _T("Get menu item in&fo\tAlt-F"),
                      _T("Show the state of the last menu item"));
@@ -379,10 +413,10 @@ MyFrame::MyFrame()
     menuBar->Append(helpMenu, _T("&Help"));
 
     // these items should be initially checked
-    menuBar->Check(Menu_MenuBar_Toggle, TRUE);
-    menuBar->Check(Menu_MenuBar_Enable, TRUE);
-    menuBar->Check(Menu_Menu_Enable, TRUE);
-    menuBar->Check(Menu_Menu_Check, FALSE);
+    menuBar->Check(Menu_MenuBar_Toggle, true);
+    menuBar->Check(Menu_MenuBar_Enable, true);
+    menuBar->Check(Menu_Menu_Enable, true);
+    menuBar->Check(Menu_Menu_Check, false);
 
     // associate the menu bar with the frame
     SetMenuBar(menuBar);
@@ -394,7 +428,7 @@ MyFrame::MyFrame()
     m_textctrl = new wxTextCtrl(this, -1, _T(""),
                                 wxDefaultPosition, wxDefaultSize,
                                 wxTE_MULTILINE);
-    m_textctrl->SetEditable(FALSE);
+    m_textctrl->SetEditable(false);
 
     wxLog::SetTimestamp(NULL);
     m_logOld = wxLog::SetActiveTarget(new wxLogTextCtrl(m_textctrl));
@@ -411,7 +445,7 @@ MyFrame::~MyFrame()
     delete m_menu;
 
     // delete the event handler installed in ctor
-    PopEventHandler(TRUE);
+    PopEventHandler(true);
 
     // restore old logger
     delete wxLog::SetActiveTarget(m_logOld);
@@ -422,11 +456,11 @@ wxMenu *MyFrame::CreateDummyMenu(wxString *title)
     wxMenu *menu = new wxMenu;
     menu->Append(Menu_Dummy_First, _T("&First item\tCtrl-F1"));
     menu->AppendSeparator();
-    menu->Append(Menu_Dummy_Second, _T("&Second item\tCtrl-F2"), _T(""), TRUE);
+    menu->Append(Menu_Dummy_Second, _T("&Second item\tCtrl-F2"), _T(""), true);
 
     if ( title )
     {
-        title->Printf(wxT("Dummy menu &%u"), (unsigned)++m_countDummy);
+        title->Printf(_T("Dummy menu &%u"), (unsigned)++m_countDummy);
     }
 
     return menu;
@@ -437,10 +471,10 @@ wxMenuItem *MyFrame::GetLastMenuItem() const
     wxMenuBar *menubar = GetMenuBar();
     wxMenu *menu = menubar->GetMenu(menubar->GetMenuCount() - 1);
 
-    wxMenuItemList::Node *node = menu->GetMenuItems().GetLast();
+    wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetLast();
     if ( !node )
     {
-        wxLogWarning(wxT("No last item in the last menu!"));
+        wxLogWarning(_T("No last item in the last menu!"));
 
         return NULL;
     }
@@ -456,11 +490,11 @@ void MyFrame::LogMenuEvent(const wxCommandEvent& event)
     if ( !GetMenuBar()->FindItem(id) )
         return;
 
-    wxString msg = wxString::Format(wxT("Menu command %d"), id);
+    wxString msg = wxString::Format(_T("Menu command %d"), id);
     if ( GetMenuBar()->FindItem(id)->IsCheckable() )
     {
-        msg += wxString::Format(wxT(" (the item is currently %schecked)"),
-                                event.IsChecked() ? "" : "not ");
+        msg += wxString::Format(_T(" (the item is currently %schecked)"),
+                                event.IsChecked() ? _T("") : _T("not "));
     }
 
     wxLogMessage(msg);
@@ -472,7 +506,7 @@ void MyFrame::LogMenuEvent(const wxCommandEvent& event)
 
 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 {
-    Close(TRUE);
+    Close(true);
 }
 
 void MyFrame::OnClearLog(wxCommandEvent& WXUNUSED(event))
@@ -495,7 +529,7 @@ void MyFrame::OnDeleteMenu(wxCommandEvent& WXUNUSED(event))
     if ( count == 2 )
     {
         // don't let delete the first 2 menus
-        wxLogError(wxT("Can't delete any more menus"));
+        wxLogError(_T("Can't delete any more menus"));
     }
     else
     {
@@ -548,7 +582,7 @@ void MyFrame::OnGetLabelMenu(wxCommandEvent& WXUNUSED(event))
 
     wxCHECK_RET( count, _T("no last menu?") );
 
-    wxLogMessage(wxT("The label of the last menu item is '%s'"),
+    wxLogMessage(_T("The label of the last menu item is '%s'"),
                  mbar->GetLabelTop(count - 1).c_str());
 }
 
@@ -584,7 +618,7 @@ void MyFrame::OnFindMenu(wxCommandEvent& WXUNUSED(event))
                      (
                         _T("Enter label to search for: "),
                         _T("Find menu"),
-                        "",
+                        _T(""),
                         this
                      );
 
@@ -594,18 +628,18 @@ void MyFrame::OnFindMenu(wxCommandEvent& WXUNUSED(event))
 
         if (index == wxNOT_FOUND)
         {
-            wxLogWarning(wxT("No menu with label '%s'"), label.c_str());
+            wxLogWarning(_T("No menu with label '%s'"), label.c_str());
         }
         else
         {
-            wxLogMessage(wxT("Menu %d has label '%s'"), index, label.c_str());
+            wxLogMessage(_T("Menu %d has label '%s'"), index, label.c_str());
         }
     }
 }
 
 void MyFrame::OnDummy(wxCommandEvent& event)
 {
-    wxLogMessage(wxT("Dummy item #%d"), event.GetId() - Menu_Dummy_First + 1);
+    wxLogMessage(_T("Dummy item #%d"), event.GetId() - Menu_Dummy_First + 1);
 }
 
 void MyFrame::OnAppendMenuItem(wxCommandEvent& WXUNUSED(event))
@@ -615,14 +649,14 @@ void MyFrame::OnAppendMenuItem(wxCommandEvent& WXUNUSED(event))
 
     menu->AppendSeparator();
     menu->Append(Menu_Dummy_Third, _T("&Third dummy item\tCtrl-F3"),
-                 _T("Checkable item"), TRUE);
+                 _T("Checkable item"), true);
 }
 
 void MyFrame::OnAppendSubMenu(wxCommandEvent& WXUNUSED(event))
 {
     wxMenuBar *menubar = GetMenuBar();
 
-    wxMenu *menu = menubar->GetMenu(menubar->GetMenuCount() - 1);
+    wxMenu *menu = menubar->GetMenu(menubar->GetMenuCount() - 2);
 
     menu->Append(Menu_Dummy_Last, _T("&Dummy sub menu"),
                  CreateDummyMenu(NULL), _T("Dummy sub menu help"));
@@ -636,7 +670,7 @@ void MyFrame::OnDeleteMenuItem(wxCommandEvent& WXUNUSED(event))
     size_t count = menu->GetMenuItemCount();
     if ( !count )
     {
-        wxLogWarning(wxT("No items to delete!"));
+        wxLogWarning(_T("No items to delete!"));
     }
     else
     {
@@ -686,7 +720,7 @@ void MyFrame::OnGetLabelMenuItem(wxCommandEvent& WXUNUSED(event))
 
     if ( item )
     {
-        wxLogMessage(wxT("The label of the last menu item is '%s'"),
+        wxLogMessage(_T("The label of the last menu item is '%s'"),
                      item->GetLabel().c_str());
     }
 }
@@ -721,7 +755,7 @@ void MyFrame::OnGetMenuItemInfo(wxCommandEvent& WXUNUSED(event))
         wxString msg;
         msg << _T("The item is ") << (item->IsEnabled() ? _T("enabled")
                                                     : _T("disabled"))
-            << '\n';
+            << _T('\n');
 
         if ( item->IsCheckable() )
         {
@@ -737,11 +771,11 @@ void MyFrame::OnGetMenuItemInfo(wxCommandEvent& WXUNUSED(event))
 
             int flags = accel->GetFlags();
             if ( flags & wxACCEL_ALT )
-                msg << wxT("Alt-");
+                msg << _T("Alt-");
             if ( flags & wxACCEL_CTRL )
-                msg << wxT("Ctrl-");
+                msg << _T("Ctrl-");
             if ( flags & wxACCEL_SHIFT )
-                msg << wxT("Shift-");
+                msg << _T("Shift-");
 
             int code = accel->GetKeyCode();
             switch ( code )
@@ -758,7 +792,7 @@ void MyFrame::OnGetMenuItemInfo(wxCommandEvent& WXUNUSED(event))
                 case WXK_F10:
                 case WXK_F11:
                 case WXK_F12:
-                    msg << wxT('F') << code - WXK_F1 + 1;
+                    msg << _T('F') << code - WXK_F1 + 1;
                     break;
 
                 // if there are any other keys wxGetAccelFromString() may return,
@@ -772,7 +806,7 @@ void MyFrame::OnGetMenuItemInfo(wxCommandEvent& WXUNUSED(event))
                         break;
                     }
 
-                    wxFAIL_MSG( wxT("unknown keyboard accel") );
+                    wxFAIL_MSG( _T("unknown keyboard accel") );
             }
 
             delete accel;
@@ -798,27 +832,27 @@ void MyFrame::OnFindMenuItem(wxCommandEvent& WXUNUSED(event))
                      (
                         _T("Enter label to search for: "),
                         _T("Find menu item"),
-                        "",
+                        _T(""),
                         this
                      );
 
     if ( !label.empty() )
     {
-        size_t menuindex = 0;
+        size_t menuindex;
         int index = wxNOT_FOUND;
-        
+
         for (menuindex = 0; (menuindex < count) && (index == wxNOT_FOUND); ++menuindex)
         {
             index = mbar->FindMenuItem(mbar->GetMenu(menuindex)->GetTitle(), label);
         }
         if (index == wxNOT_FOUND)
         {
-            wxLogWarning(wxT("No menu item with label '%s'"), label.c_str());
+            wxLogWarning(_T("No menu item with label '%s'"), label.c_str());
         }
         else
         {
-            wxLogMessage(wxT("Menu item %d in menu %d has label '%s'"),
-                         index, menuindex, label.c_str());
+            wxLogMessage(_T("Menu item %d in menu %lu has label '%s'"),
+                         index, (unsigned long)menuindex, label.c_str());
         }
     }
 }
@@ -830,14 +864,15 @@ void MyFrame::ShowContextMenu(const wxPoint& pos)
     menu.Append(Menu_Help_About, _T("&About"));
     menu.Append(Menu_Popup_Submenu, _T("&Submenu"), CreateDummyMenu(NULL));
     menu.Append(Menu_Popup_ToBeDeleted, _T("To be &deleted"));
-    menu.Append(Menu_Popup_ToBeChecked, _T("To be &checked"), _T(""), TRUE);
-    menu.Append(Menu_Popup_ToBeGreyed, _T("To be &greyed"));
+    menu.Append(Menu_Popup_ToBeChecked, _T("To be &checked"), _T(""), true);
+    menu.Append(Menu_Popup_ToBeGreyed, _T("To be &greyed"),
+                _T("This menu item should be initially greyed out"));
     menu.AppendSeparator();
     menu.Append(Menu_File_Quit, _T("E&xit"));
 
     menu.Delete(Menu_Popup_ToBeDeleted);
-    menu.Check(Menu_Popup_ToBeChecked, TRUE);
-    menu.Enable(Menu_Popup_ToBeGreyed, FALSE);
+    menu.Check(Menu_Popup_ToBeChecked, true);
+    menu.Enable(Menu_Popup_ToBeGreyed, false);
 
     PopupMenu(&menu, pos.x, pos.y);
 
@@ -849,7 +884,7 @@ void MyFrame::ShowContextMenu(const wxPoint& pos)
 #endif // 0
 }
 
-void MyFrame::OnTestNormal(wxCommandEvent& event)
+void MyFrame::OnTestNormal(wxCommandEvent& WXUNUSED(event))
 {
     wxLogMessage(_T("Normal item selected"));
 }
@@ -868,11 +903,37 @@ void MyFrame::OnTestRadio(wxCommandEvent& event)
 
 void MyFrame::LogMenuOpenOrClose(const wxMenuEvent& event, const wxChar *what)
 {
-    wxLogStatus(this, _T("A %smenu has been %s."),
-                event.IsPopup() ? _T("popup ") : _T(""), what);
+    wxString msg;
+    msg << _T("A ")
+        << ( event.IsPopup() ? _T("popup ") : _T("") )
+        << _T("menu has been ")
+        << what
+        << _T(".");
+
+    wxLogStatus(this, msg.c_str());
+}
+
+void MyFrame::OnUpdateSubMenuNormal(wxUpdateUIEvent& event)
+{
+    event.Enable(false);
+}
+
+void MyFrame::OnUpdateSubMenuCheck(wxUpdateUIEvent& event)
+{
+    event.Enable(true);
+    event.Check(true);
+}
+
+void MyFrame::OnUpdateSubMenuRadio(wxUpdateUIEvent& event)
+{
+    int which = (event.GetId() - Menu_SubMenu_Radio1 + 1);
+    if (which == 2)
+        event.Check(true);
+    else
+        event.Check(false);
 }
 
-void MyFrame::OnSize(wxSizeEvent& event)
+void MyFrame::OnSize(wxSizeEvent& WXUNUSED(event))
 {
     if ( !m_textctrl )
         return;