/////////////////////////////////////////////////////////////////////////////
-// Name: common/framecmn.cpp
+// Name: src/common/framecmn.cpp
// Purpose: common (for all platforms) wxFrame functions
// Author: Julian Smart, Vadim Zeitlin
// Created: 01/02/97
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "framebase.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#pragma hdrstop
#endif
+#include "wx/frame.h"
+
#ifndef WX_PRECOMP
- #include "wx/frame.h"
#include "wx/menu.h"
#include "wx/menuitem.h"
#include "wx/dcclient.h"
-#endif // WX_PRECOMP
-
-#if wxUSE_TOOLBAR
#include "wx/toolbar.h"
-#endif
-#if wxUSE_STATUSBAR
#include "wx/statusbr.h"
-#endif
+#endif // WX_PRECOMP
// ----------------------------------------------------------------------------
// event table
// ----------------------------------------------------------------------------
+#if wxUSE_MENUS && wxUSE_STATUSBAR
+
BEGIN_EVENT_TABLE(wxFrameBase, wxTopLevelWindow)
-#if wxUSE_MENUS && !wxUSE_IDLEMENUUPDATES
EVT_MENU_OPEN(wxFrameBase::OnMenuOpen)
-#endif
+ EVT_MENU_CLOSE(wxFrameBase::OnMenuClose)
+
EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight)
END_EVENT_TABLE()
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+
// ============================================================================
// implementation
// ============================================================================
if ( m_frameMenuBar )
{
delete m_frameMenuBar;
- m_frameMenuBar = (wxMenuBar *) NULL;
+ m_frameMenuBar = NULL;
}
#endif // wxUSE_MENUS
if ( m_frameStatusBar )
{
delete m_frameStatusBar;
- m_frameStatusBar = (wxStatusBar *) NULL;
+ m_frameStatusBar = NULL;
}
#endif // wxUSE_STATUSBAR
if ( m_frameToolBar )
{
delete m_frameToolBar;
- m_frameToolBar = (wxToolBar *) NULL;
+ m_frameToolBar = NULL;
}
#endif // wxUSE_TOOLBAR
}
{
#if wxUSE_MENUS
if ( win == GetMenuBar() )
- return TRUE;
+ return true;
#endif // wxUSE_MENUS
#if wxUSE_STATUSBAR
if ( win == GetStatusBar() )
- return TRUE;
+ return true;
#endif // wxUSE_STATUSBAR
#if wxUSE_TOOLBAR
if ( win == GetToolBar() )
- return TRUE;
+ return true;
#endif // wxUSE_TOOLBAR
- return FALSE;
+ wxUnusedVar(win);
+
+ return false;
}
// ----------------------------------------------------------------------------
// misc
// ----------------------------------------------------------------------------
+#if wxUSE_MENUS
+
bool wxFrameBase::ProcessCommand(int id)
{
-#if wxUSE_MENUS
wxMenuBar *bar = GetMenuBar();
if ( !bar )
- return FALSE;
+ return false;
- wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
+ wxMenuItem *item = bar->FindItem(id);
+ if ( !item )
+ return false;
+
+ return ProcessCommand(item);
+}
+
+bool wxFrameBase::ProcessCommand(wxMenuItem *item)
+{
+ wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, item->GetId());
commandEvent.SetEventObject(this);
- wxMenuItem *item = bar->FindItem(id);
- if (item)
- {
- if (!item->IsEnabled())
- return TRUE;
+ if (!item->IsEnabled())
+ return true;
- if (item->IsCheckable())
- {
- item->Toggle();
+ if ((item->GetKind() == wxITEM_RADIO) && item->IsChecked() )
+ return true;
- // use the new value
- commandEvent.SetInt(item->IsChecked());
- }
+ if (item->IsCheckable())
+ {
+ item->Toggle();
+
+ // use the new value
+ commandEvent.SetInt(item->IsChecked());
}
- GetEventHandler()->ProcessEvent(commandEvent);
- return TRUE;
-#else // !wxUSE_MENUS
- return FALSE;
-#endif // wxUSE_MENUS/!wxUSE_MENUS
+ return HandleWindowEvent(commandEvent);
}
+#endif // wxUSE_MENUS
+
// Do the UI update processing for this window. This is
// provided for the application to call if it wants to
// force a UI update, particularly for the menus and toolbar.
void wxFrameBase::UpdateWindowUI(long flags)
{
wxWindowBase::UpdateWindowUI(flags);
-
+
#if wxUSE_TOOLBAR
if (GetToolBar())
GetToolBar()->UpdateWindowUI(flags);
#if wxUSE_MENUS
if (GetMenuBar())
{
- if ((flags & wxUPDATE_UI_FROMIDLE) && !wxUSE_IDLEMENUUPDATES)
- {
- // If coming from an idle event, we only
- // want to update the menus if we're
- // in the wxUSE_IDLEMENUUPDATES configuration:
- // so if we're not, do nothing
- }
- else
+ // If coming from an idle event, we only want to update the menus if
+ // we're in the wxUSE_IDLEMENUUPDATES configuration, otherwise they
+ // will be update when the menu is opened later
+#if !wxUSE_IDLEMENUUPDATES
+ if ( !(flags & wxUPDATE_UI_FROMIDLE) )
+#endif // wxUSE_IDLEMENUUPDATES
DoMenuUpdates();
}
-#endif
+#endif // wxUSE_MENUS
}
// ----------------------------------------------------------------------------
-// event handlers
+// event handlers for status bar updates from menus
// ----------------------------------------------------------------------------
+#if wxUSE_MENUS && wxUSE_STATUSBAR
+
void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
{
#if wxUSE_STATUSBAR
- (void)ShowMenuHelp(GetStatusBar(), event.GetMenuId());
+ (void)ShowMenuHelp(event.GetMenuId());
#endif // wxUSE_STATUSBAR
}
+void wxFrameBase::OnMenuOpen(wxMenuEvent& event)
+{
+#if wxUSE_IDLEMENUUPDATES
+ wxUnusedVar(event);
+#else // !wxUSE_IDLEMENUUPDATES
+ // as we didn't update the menus from idle time, do it now
+ DoMenuUpdates(event.GetMenu());
+#endif // wxUSE_IDLEMENUUPDATES/!wxUSE_IDLEMENUUPDATES
+}
+
+void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event))
+{
+ DoGiveHelp(wxEmptyString, false);
+}
+
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+
// Implement internal behaviour (menu updating on some platforms)
void wxFrameBase::OnInternalIdle()
{
+ wxTopLevelWindow::OnInternalIdle();
+
#if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
if (wxUpdateUIEvent::CanUpdate(this))
DoMenuUpdates();
#endif
}
-void wxFrameBase::OnMenuOpen(wxMenuEvent& event)
-{
-#if wxUSE_MENUS && !wxUSE_IDLEMENUUPDATES
- DoMenuUpdates(event.GetMenu());
-#endif
-}
-
// ----------------------------------------------------------------------------
// status bar stuff
// ----------------------------------------------------------------------------
{
// the main status bar can only be created once (or else it should be
// deleted before calling CreateStatusBar() again)
- wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)NULL,
+ wxCHECK_MSG( !m_frameStatusBar, NULL,
wxT("recreating status bar in wxFrame") );
- m_frameStatusBar = OnCreateStatusBar( number, style, id, name );
- if ( m_frameStatusBar )
- PositionStatusBar();
+ SetStatusBar(OnCreateStatusBar(number, style, id, name));
return m_frameStatusBar;
}
m_frameStatusBar->PopStatusText(number);
}
-bool wxFrameBase::ShowMenuHelp(wxStatusBar *WXUNUSED(statbar), int menuId)
+bool wxFrameBase::ShowMenuHelp(int menuId)
{
#if wxUSE_MENUS
// if no help string found, we will clear the status bar text
wxString helpString;
- bool show = menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */;
-
- if ( show )
+ if ( menuId != wxID_SEPARATOR && menuId != -3 /* wxID_TITLE */ )
{
- wxMenuBar *menuBar = GetMenuBar();
- if ( menuBar )
- {
- // it's ok if we don't find the item because it might belong
- // to the popup menu
- wxMenuItem *item = menuBar->FindItem(menuId);
- if ( item )
- helpString = item->GetHelp();
- }
+ const wxMenuItem * const item = FindItemInMenuBar(menuId);
+ if ( item && !item->IsSeparator() )
+ helpString = item->GetHelp();
+
+ // notice that it's ok if we don't find the item because it might
+ // belong to the popup menu, so don't assert here
}
- DoGiveHelp(helpString, show);
+ DoGiveHelp(helpString, true);
- return !helpString.IsEmpty();
+ return !helpString.empty();
#else // !wxUSE_MENUS
- return FALSE;
+ return false;
#endif // wxUSE_MENUS/!wxUSE_MENUS
}
+void wxFrameBase::SetStatusBar(wxStatusBar *statBar)
+{
+ bool hadBar = m_frameStatusBar != NULL;
+ m_frameStatusBar = statBar;
+
+ if ( (m_frameStatusBar != NULL) != hadBar )
+ {
+ PositionStatusBar();
+
+ DoLayout();
+ }
+}
+
#endif // wxUSE_STATUSBAR
-void wxFrameBase::DoGiveHelp(const wxString& text, bool show)
+#if wxUSE_MENUS || wxUSE_TOOLBAR
+void wxFrameBase::DoGiveHelp(const wxString& help, bool show)
{
#if wxUSE_STATUSBAR
- if ( m_statusBarPane < 0 ) return;
- wxStatusBar* statbar = GetStatusBar();
- if ( !statbar ) return;
+ if ( m_statusBarPane < 0 )
+ {
+ // status bar messages disabled
+ return;
+ }
+
+ wxStatusBar *statbar = GetStatusBar();
+ if ( !statbar )
+ return;
+
+ wxString text;
+ if ( show )
+ {
+ // remember the old status bar text if this is the first time we're
+ // called since the menu has been opened as we're going to overwrite it
+ // in our DoGiveHelp() and we want to restore it when the menu is
+ // closed
+ //
+ // note that it would be logical to do this in OnMenuOpen() but under
+ // MSW we get an EVT_MENU_HIGHLIGHT before EVT_MENU_OPEN, strangely
+ // enough, and so this doesn't work and instead we use the ugly trick
+ // with using special m_oldStatusText value as "menu opened" (but it is
+ // arguably better than adding yet another member variable to wxFrame
+ // on all platforms)
+ if ( m_oldStatusText.empty() )
+ {
+ m_oldStatusText = statbar->GetStatusText(m_statusBarPane);
+ if ( m_oldStatusText.empty() )
+ {
+ // use special value to prevent us from doing this the next time
+ m_oldStatusText += _T('\0');
+ }
+ }
- wxString help = show ? text : wxString();
- statbar->SetStatusText( help, m_statusBarPane );
+ text = help;
+ }
+ else // hide help, restore the original text
+ {
+ text = m_oldStatusText;
+ m_oldStatusText.clear();
+ }
+
+ statbar->SetStatusText(text, m_statusBarPane);
+#else
+ wxUnusedVar(help);
+ wxUnusedVar(show);
#endif // wxUSE_STATUSBAR
}
+#endif // wxUSE_MENUS || wxUSE_TOOLBAR
// ----------------------------------------------------------------------------
wxWindowID id,
const wxString& name)
{
- // the main toolbar can't be recreated (unless it was explicitly deeleted
+ // the main toolbar can't be recreated (unless it was explicitly deleted
// before)
- wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL,
+ wxCHECK_MSG( !m_frameToolBar, NULL,
wxT("recreating toolbar in wxFrame") );
if ( style == -1 )
style = wxBORDER_NONE | wxTB_HORIZONTAL | wxTB_FLAT;
}
- m_frameToolBar = OnCreateToolBar(style, id, name);
+ SetToolBar(OnCreateToolBar(style, id, name));
return m_frameToolBar;
}
wxWindowID id,
const wxString& name)
{
+#if defined(__WXWINCE__) && defined(__POCKETPC__)
+ return new wxToolMenuBar(this, id,
+ wxDefaultPosition, wxDefaultSize,
+ style, name);
+#else
return new wxToolBar(this, id,
wxDefaultPosition, wxDefaultSize,
style, name);
+#endif
+}
+
+void wxFrameBase::SetToolBar(wxToolBar *toolbar)
+{
+ bool hadBar = m_frameToolBar != NULL;
+ m_frameToolBar = toolbar;
+
+ if ( (m_frameToolBar != NULL) != hadBar )
+ {
+ PositionToolBar();
+
+ DoLayout();
+ }
}
#endif // wxUSE_TOOLBAR
// update all menus
void wxFrameBase::DoMenuUpdates(wxMenu* menu)
{
- wxEvtHandler* source = GetEventHandler();
- wxMenuBar* bar = GetMenuBar();
-
if (menu)
+ {
+ wxEvtHandler* source = GetEventHandler();
menu->UpdateUI(source);
- else if ( bar != NULL )
+ }
+ else
{
- int nCount = bar->GetMenuCount();
- for (int n = 0; n < nCount; n++)
- bar->GetMenu(n)->UpdateUI(source);
+ wxMenuBar* bar = GetMenuBar();
+ if (bar != NULL)
+ bar->UpdateMenus();
}
}
DetachMenuBar();
- AttachMenuBar(menubar);
+ this->AttachMenuBar(menubar);
+}
+
+const wxMenuItem *wxFrameBase::FindItemInMenuBar(int menuId) const
+{
+ const wxMenuBar * const menuBar = GetMenuBar();
+
+ return menuBar ? menuBar->FindItem(menuId) : NULL;
}
#endif // wxUSE_MENUS