/////////////////////////////////////////////////////////////////////////////
-// 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
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #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
void wxFrameBase::DeleteAllBars()
{
#if wxUSE_MENUS
- if ( m_frameMenuBar )
- {
- delete m_frameMenuBar;
- m_frameMenuBar = (wxMenuBar *) NULL;
- }
+ wxDELETE(m_frameMenuBar);
#endif // wxUSE_MENUS
#if wxUSE_STATUSBAR
- if ( m_frameStatusBar )
- {
- delete m_frameStatusBar;
- m_frameStatusBar = (wxStatusBar *) NULL;
- }
+ wxDELETE(m_frameStatusBar);
#endif // wxUSE_STATUSBAR
#if wxUSE_TOOLBAR
- if ( m_frameToolBar )
- {
- delete m_frameToolBar;
- m_frameToolBar = (wxToolBar *) NULL;
- }
+ wxDELETE(m_frameToolBar);
#endif // wxUSE_TOOLBAR
}
return true;
#endif // wxUSE_TOOLBAR
+ wxUnusedVar(win);
+
return false;
}
return pt;
}
-
-void wxFrameBase::SendSizeEvent()
-{
- wxSizeEvent event( GetSize(), GetId() );
- event.SetEventObject( this );
- GetEventHandler()->AddPendingEvent( event );
-}
-
-
// ----------------------------------------------------------------------------
// misc
// ----------------------------------------------------------------------------
+#if wxUSE_MENUS
+
bool wxFrameBase::ProcessCommand(int id)
{
-#if wxUSE_MENUS
wxMenuBar *bar = GetMenuBar();
if ( !bar )
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.
#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 // wxUSE_MENUS
void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
{
#if wxUSE_STATUSBAR
- (void)ShowMenuHelp(GetStatusBar(), event.GetMenuId());
+ (void)ShowMenuHelp(event.GetMenuId());
#endif // wxUSE_STATUSBAR
}
-#if !wxUSE_IDLEMENUUPDATES
void wxFrameBase::OnMenuOpen(wxMenuEvent& event)
-#else
-void wxFrameBase::OnMenuOpen(wxMenuEvent& WXUNUSED(event))
-#endif
{
-#if !wxUSE_IDLEMENUUPDATES
+#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
+#endif // wxUSE_IDLEMENUUPDATES/!wxUSE_IDLEMENUUPDATES
}
void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event))
{
- // do we have real status text to restore?
- if ( m_oldStatusText.length() > 1 || m_oldStatusText[0u] )
- {
- if ( m_statusBarPane >= 0 )
- {
- wxStatusBar *statbar = GetStatusBar();
- if ( statbar )
- statbar->SetStatusText(m_oldStatusText, m_statusBarPane);
- }
-
- m_oldStatusText.clear();
- }
+ DoGiveHelp(wxEmptyString, false);
}
#endif // wxUSE_MENUS && wxUSE_STATUSBAR
{
// 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") );
SetStatusBar(OnCreateStatusBar(number, style, id, name));
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
+ //
+ // NB: wxID_NONE is used for (sub)menus themselves by wxMSW
wxString helpString;
- bool show = menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */;
-
- if ( show )
+ if ( menuId != wxID_SEPARATOR && menuId != wxID_NONE )
{
- 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;
#endif // wxUSE_MENUS/!wxUSE_MENUS
#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 )
if ( !statbar )
return;
- wxString help;
+ wxString text;
if ( show )
- help = text;
-
- // 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);
+ // 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() )
{
- // use special value to prevent us from doing this the next time
- m_oldStatusText += _T('\0');
+ m_oldStatusText = statbar->GetStatusText(m_statusBarPane);
+ if ( m_oldStatusText.empty() )
+ {
+ // use special value to prevent us from doing this the next time
+ m_oldStatusText += wxT('\0');
+ }
}
+
+ m_lastHelpShown =
+ text = help;
}
+ else // hide help, restore the original text
+ {
+ // clear the last shown help string but remember its value
+ wxString lastHelpShown;
+ lastHelpShown.swap(m_lastHelpShown);
- statbar->SetStatusText(help, m_statusBarPane);
+ // also clear the old status text but remember it too to restore it
+ // below
+ text.swap(m_oldStatusText);
+
+ if ( statbar->GetStatusText(m_statusBarPane) != lastHelpShown )
+ {
+ // if the text was changed with an explicit SetStatusText() call
+ // from the user code in the meanwhile, do not overwrite it with
+ // the old status bar contents -- this is almost certainly not what
+ // the user expects and would be very hard to avoid from user code
+ return;
+ }
+ }
+
+ statbar->SetStatusText(text, m_statusBarPane);
#else
- wxUnusedVar(text);
+ 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 )
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 )
+ if ( (toolbar != NULL) != (m_frameToolBar != NULL) )
{
- PositionToolBar();
+ // the toolbar visibility must have changed so we need to both position
+ // the toolbar itself (if it appeared) and to relayout the frame
+ // contents in any case
+
+ if ( toolbar )
+ {
+ // we need to assign it to m_frameToolBar for PositionToolBar() to
+ // do anything
+ m_frameToolBar = toolbar;
+ PositionToolBar();
+ }
+ //else: tricky: do not reset m_frameToolBar yet as otherwise DoLayout()
+ // wouldn't recognize the (still existing) toolbar as one of our
+ // bars and wouldn't layout the single child of the frame correctly
+
+
+ // and this is even more tricky: we want DoLayout() to recognize the
+ // old toolbar for the purpose of not counting it among our non-bar
+ // children but we don't want to reserve any more space for it so we
+ // temporarily hide it
+ if ( m_frameToolBar )
+ m_frameToolBar->Hide();
DoLayout();
+
+ if ( m_frameToolBar )
+ m_frameToolBar->Show();
}
+
+ // this might have been already done above but it's simpler to just always
+ // do it unconditionally instead of testing for whether we already did it
+ m_frameToolBar = toolbar;
}
#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();
}
}
this->AttachMenuBar(menubar);
}
+wxMenuItem *wxFrameBase::FindItemInMenuBar(int menuId) const
+{
+ const wxMenuBar * const menuBar = GetMenuBar();
+
+ return menuBar ? menuBar->FindItem(menuId) : NULL;
+}
+
#endif // wxUSE_MENUS