src/common/framecmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/framecmn.cpp
   3 // Purpose:     common (for all platforms) wxFrame functions
   4 // Author:      Julian Smart, Vadim Zeitlin
   5 // Created:     01/02/97
   6 // Id:          $Id$
   7 // Copyright:   (c) 1998 Robert Roebling and Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // ============================================================================
  12 // declarations
  13 // ============================================================================
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 // For compilers that support precompilation, includes "wx.h".
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #include "wx/frame.h"
  27
  28 #ifndef WX_PRECOMP
  29     #include "wx/menu.h"
  30     #include "wx/menuitem.h"
  31     #include "wx/dcclient.h"
  32     #include "wx/toolbar.h"
  33     #include "wx/statusbr.h"
  34 #endif // WX_PRECOMP
  35
  36 // ----------------------------------------------------------------------------
  37 // event table
  38 // ----------------------------------------------------------------------------
  39
  40 #if wxUSE_MENUS && wxUSE_STATUSBAR
  41
  42 BEGIN_EVENT_TABLE(wxFrameBase, wxTopLevelWindow)
  43     EVT_MENU_OPEN(wxFrameBase::OnMenuOpen)
  44     EVT_MENU_CLOSE(wxFrameBase::OnMenuClose)
  45
  46     EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight)
  47 END_EVENT_TABLE()
  48
  49 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
  50
  51 // ============================================================================
  52 // implementation
  53 // ============================================================================
  54
  55 // ----------------------------------------------------------------------------
  56 // construction/destruction
  57 // ----------------------------------------------------------------------------
  58
  59 wxFrameBase::wxFrameBase()
  60 {
  61 #if wxUSE_MENUS
  62     m_frameMenuBar = NULL;
  63 #endif // wxUSE_MENUS
  64
  65 #if wxUSE_TOOLBAR
  66     m_frameToolBar = NULL;
  67 #endif // wxUSE_TOOLBAR
  68
  69 #if wxUSE_STATUSBAR
  70     m_frameStatusBar = NULL;
  71 #endif // wxUSE_STATUSBAR
  72
  73     m_statusBarPane = 0;
  74 }
  75
  76 wxFrameBase::~wxFrameBase()
  77 {
  78     // this destructor is required for Darwin
  79 }
  80
  81 wxFrame *wxFrameBase::New(wxWindow *parent,
  82                           wxWindowID id,
  83                           const wxString& title,
  84                           const wxPoint& pos,
  85                           const wxSize& size,
  86                           long style,
  87                           const wxString& name)
  88 {
  89     return new wxFrame(parent, id, title, pos, size, style, name);
  90 }
  91
  92 void wxFrameBase::DeleteAllBars()
  93 {
  94 #if wxUSE_MENUS
  95     if ( m_frameMenuBar )
  96     {
  97         delete m_frameMenuBar;
  98         m_frameMenuBar = (wxMenuBar *) NULL;
  99     }
 100 #endif // wxUSE_MENUS
 101
 102 #if wxUSE_STATUSBAR
 103     if ( m_frameStatusBar )
 104     {
 105         delete m_frameStatusBar;
 106         m_frameStatusBar = (wxStatusBar *) NULL;
 107     }
 108 #endif // wxUSE_STATUSBAR
 109
 110 #if wxUSE_TOOLBAR
 111     if ( m_frameToolBar )
 112     {
 113         delete m_frameToolBar;
 114         m_frameToolBar = (wxToolBar *) NULL;
 115     }
 116 #endif // wxUSE_TOOLBAR
 117 }
 118
 119 bool wxFrameBase::IsOneOfBars(const wxWindow *win) const
 120 {
 121 #if wxUSE_MENUS
 122     if ( win == GetMenuBar() )
 123         return true;
 124 #endif // wxUSE_MENUS
 125
 126 #if wxUSE_STATUSBAR
 127     if ( win == GetStatusBar() )
 128         return true;
 129 #endif // wxUSE_STATUSBAR
 130
 131 #if wxUSE_TOOLBAR
 132     if ( win == GetToolBar() )
 133         return true;
 134 #endif // wxUSE_TOOLBAR
 135
 136     return false;
 137 }
 138
 139 // ----------------------------------------------------------------------------
 140 // wxFrame size management: we exclude the areas taken by menu/status/toolbars
 141 // from the client area, so the client area is what's really available for the
 142 // frame contents
 143 // ----------------------------------------------------------------------------
 144
 145 // get the origin of the client area in the client coordinates
 146 wxPoint wxFrameBase::GetClientAreaOrigin() const
 147 {
 148     wxPoint pt = wxTopLevelWindow::GetClientAreaOrigin();
 149
 150 #if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__)
 151     wxToolBar *toolbar = GetToolBar();
 152     if ( toolbar && toolbar->IsShown() )
 153     {
 154         int w, h;
 155         toolbar->GetSize(&w, &h);
 156
 157         if ( toolbar->GetWindowStyleFlag() & wxTB_VERTICAL )
 158         {
 159             pt.x += w;
 160         }
 161         else
 162         {
 163             pt.y += h;
 164         }
 165     }
 166 #endif // wxUSE_TOOLBAR
 167
 168     return pt;
 169 }
 170
 171
 172 void wxFrameBase::SendSizeEvent()
 173 {
 174     wxSizeEvent event( GetSize(), GetId() );
 175     event.SetEventObject( this );
 176     GetEventHandler()->AddPendingEvent( event );
 177 }
 178
 179
 180 // ----------------------------------------------------------------------------
 181 // misc
 182 // ----------------------------------------------------------------------------
 183
 184 bool wxFrameBase::ProcessCommand(int id)
 185 {
 186 #if wxUSE_MENUS
 187     wxMenuBar *bar = GetMenuBar();
 188     if ( !bar )
 189         return false;
 190
 191     wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
 192     commandEvent.SetEventObject(this);
 193
 194     wxMenuItem *item = bar->FindItem(id);
 195     if (item)
 196     {
 197         if (!item->IsEnabled())
 198             return true;
 199
 200         if ((item->GetKind() == wxITEM_RADIO) && item->IsChecked() )
 201             return true;
 202
 203         if (item->IsCheckable())
 204         {
 205             item->Toggle();
 206
 207             // use the new value
 208             commandEvent.SetInt(item->IsChecked());
 209         }
 210     }
 211
 212     GetEventHandler()->ProcessEvent(commandEvent);
 213     return true;
 214 #else // !wxUSE_MENUS
 215     return false;
 216 #endif // wxUSE_MENUS/!wxUSE_MENUS
 217 }
 218
 219 // Do the UI update processing for this window. This is
 220 // provided for the application to call if it wants to
 221 // force a UI update, particularly for the menus and toolbar.
 222 void wxFrameBase::UpdateWindowUI(long flags)
 223 {
 224     wxWindowBase::UpdateWindowUI(flags);
 225
 226 #if wxUSE_TOOLBAR
 227     if (GetToolBar())
 228         GetToolBar()->UpdateWindowUI(flags);
 229 #endif
 230
 231 #if wxUSE_MENUS
 232     if (GetMenuBar())
 233     {
 234         if ((flags & wxUPDATE_UI_FROMIDLE) && !wxUSE_IDLEMENUUPDATES)
 235         {
 236             // If coming from an idle event, we only
 237             // want to update the menus if we're
 238             // in the wxUSE_IDLEMENUUPDATES configuration:
 239             // so if we're not, do nothing
 240         }
 241         else
 242             DoMenuUpdates();
 243     }
 244 #endif // wxUSE_MENUS
 245 }
 246
 247 // ----------------------------------------------------------------------------
 248 // event handlers for status bar updates from menus
 249 // ----------------------------------------------------------------------------
 250
 251 #if wxUSE_MENUS && wxUSE_STATUSBAR
 252
 253 void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
 254 {
 255 #if wxUSE_STATUSBAR
 256     (void)ShowMenuHelp(GetStatusBar(), event.GetMenuId());
 257 #endif // wxUSE_STATUSBAR
 258 }
 259
 260 #if !wxUSE_IDLEMENUUPDATES
 261 void wxFrameBase::OnMenuOpen(wxMenuEvent& event)
 262 #else
 263 void wxFrameBase::OnMenuOpen(wxMenuEvent& WXUNUSED(event))
 264 #endif
 265 {
 266 #if !wxUSE_IDLEMENUUPDATES
 267     DoMenuUpdates(event.GetMenu());
 268 #endif // !wxUSE_IDLEMENUUPDATES
 269 }
 270
 271 void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event))
 272 {
 273     // do we have real status text to restore?
 274     if ( !m_oldStatusText.empty() )
 275     {
 276         if ( m_statusBarPane >= 0 )
 277         {
 278             wxStatusBar *statbar = GetStatusBar();
 279             if ( statbar )
 280                 statbar->SetStatusText(m_oldStatusText, m_statusBarPane);
 281         }
 282
 283         m_oldStatusText.clear();
 284     }
 285 }
 286
 287 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
 288
 289 // Implement internal behaviour (menu updating on some platforms)
 290 void wxFrameBase::OnInternalIdle()
 291 {
 292     wxTopLevelWindow::OnInternalIdle();
 293
 294 #if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
 295     if (wxUpdateUIEvent::CanUpdate(this))
 296         DoMenuUpdates();
 297 #endif
 298 }
 299
 300 // ----------------------------------------------------------------------------
 301 // status bar stuff
 302 // ----------------------------------------------------------------------------
 303
 304 #if wxUSE_STATUSBAR
 305
 306 wxStatusBar* wxFrameBase::CreateStatusBar(int number,
 307                                           long style,
 308                                           wxWindowID id,
 309                                           const wxString& name)
 310 {
 311     // the main status bar can only be created once (or else it should be
 312     // deleted before calling CreateStatusBar() again)
 313     wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)NULL,
 314                  wxT("recreating status bar in wxFrame") );
 315
 316     SetStatusBar(OnCreateStatusBar(number, style, id, name));
 317
 318     return m_frameStatusBar;
 319 }
 320
 321 wxStatusBar *wxFrameBase::OnCreateStatusBar(int number,
 322                                             long style,
 323                                             wxWindowID id,
 324                                             const wxString& name)
 325 {
 326     wxStatusBar *statusBar = new wxStatusBar(this, id, style, name);
 327
 328     statusBar->SetFieldsCount(number);
 329
 330     return statusBar;
 331 }
 332
 333 void wxFrameBase::SetStatusText(const wxString& text, int number)
 334 {
 335     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 336
 337     m_frameStatusBar->SetStatusText(text, number);
 338 }
 339
 340 void wxFrameBase::SetStatusWidths(int n, const int widths_field[] )
 341 {
 342     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set widths for") );
 343
 344     m_frameStatusBar->SetStatusWidths(n, widths_field);
 345
 346     PositionStatusBar();
 347 }
 348
 349 void wxFrameBase::PushStatusText(const wxString& text, int number)
 350 {
 351     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 352
 353     m_frameStatusBar->PushStatusText(text, number);
 354 }
 355
 356 void wxFrameBase::PopStatusText(int number)
 357 {
 358     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 359
 360     m_frameStatusBar->PopStatusText(number);
 361 }
 362
 363 bool wxFrameBase::ShowMenuHelp(wxStatusBar *WXUNUSED(statbar), int menuId)
 364 {
 365 #if wxUSE_MENUS
 366     // if no help string found, we will clear the status bar text
 367     wxString helpString;
 368     bool show = menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */;
 369
 370     if ( show )
 371     {
 372         wxMenuBar *menuBar = GetMenuBar();
 373         if ( menuBar )
 374         {
 375             // it's ok if we don't find the item because it might belong
 376             // to the popup menu
 377             wxMenuItem *item = menuBar->FindItem(menuId);
 378             if ( item )
 379                 helpString = item->GetHelp();
 380         }
 381     }
 382
 383     DoGiveHelp(helpString, show);
 384
 385     return !helpString.empty();
 386 #else // !wxUSE_MENUS
 387     return false;
 388 #endif // wxUSE_MENUS/!wxUSE_MENUS
 389 }
 390
 391 void wxFrameBase::SetStatusBar(wxStatusBar *statBar)
 392 {
 393     bool hadBar = m_frameStatusBar != NULL;
 394     m_frameStatusBar = statBar;
 395
 396     if ( (m_frameStatusBar != NULL) != hadBar )
 397     {
 398         PositionStatusBar();
 399
 400         DoLayout();
 401     }
 402 }
 403
 404 #endif // wxUSE_STATUSBAR
 405
 406 void wxFrameBase::DoGiveHelp(const wxString& text, bool show)
 407 {
 408 #if wxUSE_STATUSBAR
 409     if ( m_statusBarPane < 0 )
 410     {
 411         // status bar messages disabled
 412         return;
 413     }
 414
 415     wxStatusBar *statbar = GetStatusBar();
 416     if ( !statbar )
 417         return;
 418
 419     wxString help;
 420     if ( show )
 421         help = text;
 422
 423     // remember the old status bar text if this is the first time we're called
 424     // since the menu has been opened as we're going to overwrite it in our
 425     // DoGiveHelp() and we want to restore it when the menu is closed
 426     //
 427     // note that it would be logical to do this in OnMenuOpen() but under MSW
 428     // we get an EVT_MENU_HIGHLIGHT before EVT_MENU_OPEN, strangely enough, and
 429     // so this doesn't work and instead we use the ugly trick with using
 430     // special m_oldStatusText value as "menu opened" (but it is arguably
 431     // better than adding yet another member variable to wxFrame on all
 432     // platforms)
 433     if ( m_oldStatusText.empty() )
 434     {
 435         m_oldStatusText = statbar->GetStatusText(m_statusBarPane);
 436         if ( m_oldStatusText.empty() )
 437         {
 438             // use special value to prevent us from doing this the next time
 439             m_oldStatusText += _T('\0');
 440         }
 441     }
 442
 443     statbar->SetStatusText(help, m_statusBarPane);
 444 #else
 445     wxUnusedVar(text);
 446     wxUnusedVar(show);
 447 #endif // wxUSE_STATUSBAR
 448 }
 449
 450
 451 // ----------------------------------------------------------------------------
 452 // toolbar stuff
 453 // ----------------------------------------------------------------------------
 454
 455 #if wxUSE_TOOLBAR
 456
 457 wxToolBar* wxFrameBase::CreateToolBar(long style,
 458                                       wxWindowID id,
 459                                       const wxString& name)
 460 {
 461     // the main toolbar can't be recreated (unless it was explicitly deleted
 462     // before)
 463     wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL,
 464                  wxT("recreating toolbar in wxFrame") );
 465
 466     if ( style == -1 )
 467     {
 468         // use default style
 469         //
 470         // NB: we don't specify the default value in the method declaration
 471         //     because
 472         //      a) this allows us to have different defaults for different
 473         //         platforms (even if we don't have them right now)
 474         //      b) we don't need to include wx/toolbar.h in the header then
 475         style = wxBORDER_NONE | wxTB_HORIZONTAL | wxTB_FLAT;
 476     }
 477
 478     SetToolBar(OnCreateToolBar(style, id, name));
 479
 480     return m_frameToolBar;
 481 }
 482
 483 wxToolBar* wxFrameBase::OnCreateToolBar(long style,
 484                                         wxWindowID id,
 485                                         const wxString& name)
 486 {
 487 #if defined(__WXWINCE__) && defined(__POCKETPC__)
 488     return new wxToolMenuBar(this, id,
 489                          wxDefaultPosition, wxDefaultSize,
 490                          style, name);
 491 #else
 492     return new wxToolBar(this, id,
 493                          wxDefaultPosition, wxDefaultSize,
 494                          style, name);
 495 #endif
 496 }
 497
 498 void wxFrameBase::SetToolBar(wxToolBar *toolbar)
 499 {
 500     bool hadBar = m_frameToolBar != NULL;
 501     m_frameToolBar = toolbar;
 502
 503     if ( (m_frameToolBar != NULL) != hadBar )
 504     {
 505         PositionToolBar();
 506
 507         DoLayout();
 508     }
 509 }
 510
 511 #endif // wxUSE_TOOLBAR
 512
 513 // ----------------------------------------------------------------------------
 514 // menus
 515 // ----------------------------------------------------------------------------
 516
 517 #if wxUSE_MENUS
 518
 519 // update all menus
 520 void wxFrameBase::DoMenuUpdates(wxMenu* menu)
 521 {
 522     if (menu)
 523     {
 524         wxEvtHandler* source = GetEventHandler();
 525         menu->UpdateUI(source);
 526     }
 527     else
 528     {
 529         wxMenuBar* bar = GetMenuBar();
 530         if (bar != NULL)
 531             bar->UpdateMenus();
 532     }
 533 }
 534
 535 void wxFrameBase::DetachMenuBar()
 536 {
 537     if ( m_frameMenuBar )
 538     {
 539         m_frameMenuBar->Detach();
 540         m_frameMenuBar = NULL;
 541     }
 542 }
 543
 544 void wxFrameBase::AttachMenuBar(wxMenuBar *menubar)
 545 {
 546     if ( menubar )
 547     {
 548         menubar->Attach((wxFrame *)this);
 549         m_frameMenuBar = menubar;
 550     }
 551 }
 552
 553 void wxFrameBase::SetMenuBar(wxMenuBar *menubar)
 554 {
 555     if ( menubar == GetMenuBar() )
 556     {
 557         // nothing to do
 558         return;
 559     }
 560
 561     DetachMenuBar();
 562
 563     this->AttachMenuBar(menubar);
 564 }
 565
 566 #endif // wxUSE_MENUS