/////////////////////////////////////////////////////////////////////////////
-// 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
// Id: $Id$
-// Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Copyright: (c) 1998 Robert Roebling and Julian Smart
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "framebase.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#endif
#include "wx/frame.h"
-#include "wx/menu.h"
-#include "wx/menuitem.h"
-#include "wx/dcclient.h"
-#if wxUSE_TOOLBAR
+#ifndef WX_PRECOMP
+ #include "wx/menu.h"
+ #include "wx/menuitem.h"
+ #include "wx/dcclient.h"
#include "wx/toolbar.h"
-#endif
-#if wxUSE_STATUSBAR
#include "wx/statusbr.h"
-#endif
+#endif // WX_PRECOMP
// ----------------------------------------------------------------------------
// event table
// ----------------------------------------------------------------------------
-BEGIN_EVENT_TABLE(wxFrameBase, wxWindow)
- EVT_IDLE(wxFrameBase::OnIdle)
- EVT_CLOSE(wxFrameBase::OnCloseWindow)
+#if wxUSE_MENUS && wxUSE_STATUSBAR
+
+BEGIN_EVENT_TABLE(wxFrameBase, wxTopLevelWindow)
+ EVT_MENU_OPEN(wxFrameBase::OnMenuOpen)
+ EVT_MENU_CLOSE(wxFrameBase::OnMenuClose)
+
EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight)
- EVT_SIZE(wxFrameBase::OnSize)
END_EVENT_TABLE()
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+
// ============================================================================
// implementation
// ============================================================================
wxFrameBase::wxFrameBase()
{
+#if wxUSE_MENUS
m_frameMenuBar = NULL;
+#endif // wxUSE_MENUS
#if wxUSE_TOOLBAR
m_frameToolBar = NULL;
#if wxUSE_STATUSBAR
m_frameStatusBar = NULL;
#endif // wxUSE_STATUSBAR
+
+ m_statusBarPane = 0;
}
-bool wxFrameBase::Destroy()
+wxFrameBase::~wxFrameBase()
{
- // delayed destruction: the frame will be deleted during the next idle
- // loop iteration
- if ( !wxPendingDelete.Member(this) )
- wxPendingDelete.Append(this);
-
- return TRUE;
+ // this destructor is required for Darwin
}
wxFrame *wxFrameBase::New(wxWindow *parent,
void wxFrameBase::DeleteAllBars()
{
+#if wxUSE_MENUS
if ( m_frameMenuBar )
{
delete m_frameMenuBar;
m_frameMenuBar = (wxMenuBar *) NULL;
}
+#endif // wxUSE_MENUS
#if wxUSE_STATUSBAR
if ( m_frameStatusBar )
#endif // wxUSE_TOOLBAR
}
+bool wxFrameBase::IsOneOfBars(const wxWindow *win) const
+{
+#if wxUSE_MENUS
+ if ( win == GetMenuBar() )
+ return true;
+#endif // wxUSE_MENUS
+
+#if wxUSE_STATUSBAR
+ if ( win == GetStatusBar() )
+ return true;
+#endif // wxUSE_STATUSBAR
+
+#if wxUSE_TOOLBAR
+ if ( win == GetToolBar() )
+ return true;
+#endif // wxUSE_TOOLBAR
+
+ wxUnusedVar(win);
+
+ return false;
+}
+
// ----------------------------------------------------------------------------
-// misc
+// wxFrame size management: we exclude the areas taken by menu/status/toolbars
+// from the client area, so the client area is what's really available for the
+// frame contents
// ----------------------------------------------------------------------------
-// make the window modal (all other windows unresponsive)
-void wxFrameBase::MakeModal(bool modal)
+// get the origin of the client area in the client coordinates
+wxPoint wxFrameBase::GetClientAreaOrigin() const
{
- if ( modal )
- {
- wxEnableTopLevelWindows(FALSE);
- Enable(TRUE); // keep this window enabled
- }
- else
+ wxPoint pt = wxTopLevelWindow::GetClientAreaOrigin();
+
+#if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__)
+ wxToolBar *toolbar = GetToolBar();
+ if ( toolbar && toolbar->IsShown() )
{
- wxEnableTopLevelWindows(TRUE);
+ int w, h;
+ toolbar->GetSize(&w, &h);
+
+ if ( toolbar->GetWindowStyleFlag() & wxTB_VERTICAL )
+ {
+ pt.x += w;
+ }
+ else
+ {
+ pt.y += h;
+ }
}
+#endif // wxUSE_TOOLBAR
+
+ return pt;
}
+
+void wxFrameBase::SendSizeEvent()
+{
+ wxSizeEvent event( GetSize(), GetId() );
+ event.SetEventObject( this );
+ GetEventHandler()->AddPendingEvent( event );
+}
+
+
+// ----------------------------------------------------------------------------
+// misc
+// ----------------------------------------------------------------------------
+
bool wxFrameBase::ProcessCommand(int id)
{
+#if wxUSE_MENUS
wxMenuBar *bar = GetMenuBar();
if ( !bar )
- return FALSE;
+ return false;
+
+ wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
+ commandEvent.SetEventObject(this);
wxMenuItem *item = bar->FindItem(id);
- if ( item && item->IsCheckable() )
+ if (item)
{
- item->Toggle();
+ if (!item->IsEnabled())
+ return true;
+
+ if ((item->GetKind() == wxITEM_RADIO) && item->IsChecked() )
+ return true;
+
+ if (item->IsCheckable())
+ {
+ item->Toggle();
+
+ // use the new value
+ commandEvent.SetInt(item->IsChecked());
+ }
}
- wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
- commandEvent.SetInt(id);
- commandEvent.SetEventObject(this);
+ return HandleWindowEvent(commandEvent);
+#else // !wxUSE_MENUS
+ wxUnusedVar(id);
- return GetEventHandler()->ProcessEvent(commandEvent);
+ return false;
+#endif // wxUSE_MENUS/!wxUSE_MENUS
}
-// ----------------------------------------------------------------------------
-// event handlers
-// ----------------------------------------------------------------------------
-
-// default resizing behaviour - if only ONE subwindow, resize to fill the
-// whole client area
-void wxFrameBase::OnSize(wxSizeEvent& event)
+// 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)
{
- // if we're using constraints - do use them
-#if wxUSE_CONSTRAINTS
- if ( GetAutoLayout() )
- {
- Layout();
- }
- else
+ wxWindowBase::UpdateWindowUI(flags);
+
+#if wxUSE_TOOLBAR
+ if (GetToolBar())
+ GetToolBar()->UpdateWindowUI(flags);
#endif
+
+#if wxUSE_MENUS
+ if (GetMenuBar())
{
- // do we have _exactly_ one child?
- wxWindow *child = (wxWindow *)NULL;
- for ( wxWindowList::Node *node = GetChildren().GetFirst();
- node;
- node = node->GetNext() )
+ if ((flags & wxUPDATE_UI_FROMIDLE) && !wxUSE_IDLEMENUUPDATES)
{
- wxWindow *win = node->GetData();
+ // 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
+ DoMenuUpdates();
+ }
+#endif // wxUSE_MENUS
+}
- // exclude top level and managed windows (status bar isn't
- // currently in the children list except under wxMac anyhow, but
- // it makes no harm to test for it)
- if ( !win->IsTopLevel()
+// ----------------------------------------------------------------------------
+// event handlers for status bar updates from menus
+// ----------------------------------------------------------------------------
+
+#if wxUSE_MENUS && wxUSE_STATUSBAR
+
+void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
+{
#if wxUSE_STATUSBAR
- && (win != GetStatusBar())
+ (void)ShowMenuHelp(event.GetMenuId());
#endif // wxUSE_STATUSBAR
-#if wxUSE_TOOLBAR
- && (win != GetToolBar())
-#endif // wxUSE_TOOLBAR
- )
- {
- if ( child )
- {
- return; // it's our second subwindow - nothing to do
- }
-
- child = win;
- }
- }
+}
- // do we have any children at all?
- if ( child )
- {
- // exactly one child - set it's size to fill the whole frame
- int clientW, clientH;
- DoGetClientSize(&clientW, &clientH);
-
- // for whatever reasons, wxGTK wants to have a small offset - it
- // probably looks better with it?
-#ifdef __WXGTK__
- static const int ofs = 0;
+#if !wxUSE_IDLEMENUUPDATES
+void wxFrameBase::OnMenuOpen(wxMenuEvent& event)
#else
- static const int ofs = 1;
+void wxFrameBase::OnMenuOpen(wxMenuEvent& WXUNUSED(event))
#endif
-
- child->SetSize(ofs, ofs, clientW - 2*ofs, clientH - 2*ofs);
- }
- }
+{
+#if !wxUSE_IDLEMENUUPDATES
+ DoMenuUpdates(event.GetMenu());
+#endif // !wxUSE_IDLEMENUUPDATES
}
-// The default implementation for the close window event.
-void wxFrameBase::OnCloseWindow(wxCloseEvent& event)
+void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event))
{
- Destroy();
+ DoGiveHelp(wxEmptyString, false);
}
-void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
-{
-#if wxUSE_STATUSBAR
- if ( GetStatusBar() )
- {
- // if no help string found, we will clear the status bar text
- wxString helpString;
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
- int menuId = event.GetMenuId();
- if ( menuId != wxID_SEPARATOR && menuId != -2 /* 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();
- }
- }
+// Implement internal behaviour (menu updating on some platforms)
+void wxFrameBase::OnInternalIdle()
+{
+ wxTopLevelWindow::OnInternalIdle();
- // set status text even if the string is empty - this will at least
- // remove the string from the item which was previously selected
- SetStatusText(helpString);
- }
-#endif // wxUSE_STATUSBAR
+#if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
+ if (wxUpdateUIEvent::CanUpdate(this))
+ DoMenuUpdates();
+#endif
}
// ----------------------------------------------------------------------------
wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)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;
}
wxWindowID id,
const wxString& name)
{
- wxStatusBar *statusBar = new wxStatusBar(this, id,
- wxPoint(0, 0), wxSize(100, 20),
- style, name);
-
- // Set the height according to the font and the border size
- wxClientDC dc(statusBar);
- dc.SetFont(statusBar->GetFont());
-
- long y;
- dc.GetTextExtent( "X", NULL, &y );
-
- int height = (int)( (11*y)/10 + 2*statusBar->GetBorderY());
-
- statusBar->SetSize( -1, -1, 100, height );
+ wxStatusBar *statusBar = new wxStatusBar(this, id, style, name);
statusBar->SetFieldsCount(number);
PositionStatusBar();
}
+void wxFrameBase::PushStatusText(const wxString& text, int number)
+{
+ wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
+
+ m_frameStatusBar->PushStatusText(text, number);
+}
+
+void wxFrameBase::PopStatusText(int number)
+{
+ wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
+
+ m_frameStatusBar->PopStatusText(number);
+}
+
+bool wxFrameBase::ShowMenuHelp(int menuId)
+{
+#if wxUSE_MENUS
+ // if no help string found, we will clear the status bar text
+ wxString helpString;
+ if ( menuId != wxID_SEPARATOR && menuId != -3 /* wxID_TITLE */ )
+ {
+ 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, true);
+
+ return !helpString.empty();
+#else // !wxUSE_MENUS
+ 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
+#if wxUSE_MENUS || wxUSE_TOOLBAR
+void wxFrameBase::DoGiveHelp(const wxString& help, bool show)
+{
+#if wxUSE_STATUSBAR
+ 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');
+ }
+ }
+
+ 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
+
+
// ----------------------------------------------------------------------------
// toolbar stuff
// ----------------------------------------------------------------------------
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,
wxT("recreating toolbar in wxFrame") );
- m_frameToolBar = OnCreateToolBar(style, id, name);
+ if ( style == -1 )
+ {
+ // use default style
+ //
+ // NB: we don't specify the default value in the method declaration
+ // because
+ // a) this allows us to have different defaults for different
+ // platforms (even if we don't have them right now)
+ // b) we don't need to include wx/toolbar.h in the header then
+ style = wxBORDER_NONE | wxTB_HORIZONTAL | wxTB_FLAT;
+ }
+
+ 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
// ----------------------------------------------------------------------------
-// Menu UI updating
+// menus
// ----------------------------------------------------------------------------
-void wxFrameBase::OnIdle(wxIdleEvent& WXUNUSED(event) )
+#if wxUSE_MENUS
+
+// update all menus
+void wxFrameBase::DoMenuUpdates(wxMenu* menu)
{
- DoMenuUpdates();
+ if (menu)
+ {
+ wxEvtHandler* source = GetEventHandler();
+ menu->UpdateUI(source);
+ }
+ else
+ {
+ wxMenuBar* bar = GetMenuBar();
+ if (bar != NULL)
+ bar->UpdateMenus();
+ }
}
-// update all menus
-void wxFrameBase::DoMenuUpdates()
+void wxFrameBase::DetachMenuBar()
{
- wxMenuBar* bar = GetMenuBar();
+ if ( m_frameMenuBar )
+ {
+ m_frameMenuBar->Detach();
+ m_frameMenuBar = NULL;
+ }
+}
- if ( bar != NULL )
+void wxFrameBase::AttachMenuBar(wxMenuBar *menubar)
+{
+ if ( menubar )
{
- int nCount = bar->GetMenuCount();
- for (int n = 0; n < nCount; n++)
- DoMenuUpdates(bar->GetMenu(n), (wxWindow*) NULL);
+ menubar->Attach((wxFrame *)this);
+ m_frameMenuBar = menubar;
}
}
-// update a menu and all submenus recursively
-void wxFrameBase::DoMenuUpdates(wxMenu* menu, wxWindow* WXUNUSED(focusWin))
+void wxFrameBase::SetMenuBar(wxMenuBar *menubar)
{
- wxEvtHandler* evtHandler = GetEventHandler();
- wxMenuItemList::Node* node = menu->GetMenuItems().GetFirst();
- while (node)
+ if ( menubar == GetMenuBar() )
{
- wxMenuItem* item = node->GetData();
- if ( !item->IsSeparator() )
- {
- wxWindowID id = item->GetId();
- wxUpdateUIEvent event(id);
- event.SetEventObject( this );
+ // nothing to do
+ return;
+ }
- if (evtHandler->ProcessEvent(event))
- {
- if (event.GetSetText())
- menu->SetLabel(id, event.GetText());
- if (event.GetSetChecked())
- menu->Check(id, event.GetChecked());
- if (event.GetSetEnabled())
- menu->Enable(id, event.GetEnabled());
- }
+ DetachMenuBar();
- if (item->GetSubMenu())
- DoMenuUpdates(item->GetSubMenu(), (wxWindow*) NULL);
- }
- node = node->GetNext();
- }
+ this->AttachMenuBar(menubar);
}
+
+const wxMenuItem *wxFrameBase::FindItemInMenuBar(int menuId) const
+{
+ const wxMenuBar * const menuBar = GetMenuBar();
+
+ return menuBar ? menuBar->FindItem(menuId) : NULL;
+}
+
+#endif // wxUSE_MENUS
projects / wxWidgets.git / blobdiff