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     wxUnusedVar(win);
 137
 138     return false;
 139 }
 140
 141 // ----------------------------------------------------------------------------
 142 // wxFrame size management: we exclude the areas taken by menu/status/toolbars
 143 // from the client area, so the client area is what's really available for the
 144 // frame contents
 145 // ----------------------------------------------------------------------------
 146
 147 // get the origin of the client area in the client coordinates
 148 wxPoint wxFrameBase::GetClientAreaOrigin() const
 149 {
 150     wxPoint pt = wxTopLevelWindow::GetClientAreaOrigin();
 151
 152 #if wxUSE_TOOLBAR && !defined(__WXUNIVERSAL__)
 153     wxToolBar *toolbar = GetToolBar();
 154     if ( toolbar && toolbar->IsShown() )
 155     {
 156         int w, h;
 157         toolbar->GetSize(&w, &h);
 158
 159         if ( toolbar->GetWindowStyleFlag() & wxTB_VERTICAL )
 160         {
 161             pt.x += w;
 162         }
 163         else
 164         {
 165             pt.y += h;
 166         }
 167     }
 168 #endif // wxUSE_TOOLBAR
 169
 170     return pt;
 171 }
 172
 173
 174 void wxFrameBase::SendSizeEvent()
 175 {
 176     wxSizeEvent event( GetSize(), GetId() );
 177     event.SetEventObject( this );
 178     GetEventHandler()->AddPendingEvent( event );
 179 }
 180
 181
 182 // ----------------------------------------------------------------------------
 183 // misc
 184 // ----------------------------------------------------------------------------
 185
 186 #if wxUSE_MENUS
 187
 188 bool wxFrameBase::ProcessCommand(int id)
 189 {
 190     wxMenuBar *bar = GetMenuBar();
 191     if ( !bar )
 192         return false;
 193
 194     wxMenuItem *item = bar->FindItem(id);
 195     if ( !item )
 196         return false;
 197
 198     return ProcessCommand(item);
 199 }
 200
 201 bool wxFrameBase::ProcessCommand(wxMenuItem *item)
 202 {
 203     wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, item->GetId());
 204     commandEvent.SetEventObject(this);
 205
 206     if (!item->IsEnabled())
 207         return true;
 208
 209     if ((item->GetKind() == wxITEM_RADIO) && item->IsChecked() )
 210         return true;
 211
 212     if (item->IsCheckable())
 213     {
 214         item->Toggle();
 215
 216         // use the new value
 217         commandEvent.SetInt(item->IsChecked());
 218     }
 219
 220     return HandleWindowEvent(commandEvent);
 221 }
 222
 223 #endif // wxUSE_MENUS
 224
 225 // Do the UI update processing for this window. This is
 226 // provided for the application to call if it wants to
 227 // force a UI update, particularly for the menus and toolbar.
 228 void wxFrameBase::UpdateWindowUI(long flags)
 229 {
 230     wxWindowBase::UpdateWindowUI(flags);
 231
 232 #if wxUSE_TOOLBAR
 233     if (GetToolBar())
 234         GetToolBar()->UpdateWindowUI(flags);
 235 #endif
 236
 237 #if wxUSE_MENUS
 238     if (GetMenuBar())
 239     {
 240         if ((flags & wxUPDATE_UI_FROMIDLE) && !wxUSE_IDLEMENUUPDATES)
 241         {
 242             // If coming from an idle event, we only
 243             // want to update the menus if we're
 244             // in the wxUSE_IDLEMENUUPDATES configuration:
 245             // so if we're not, do nothing
 246         }
 247         else
 248             DoMenuUpdates();
 249     }
 250 #endif // wxUSE_MENUS
 251 }
 252
 253 // ----------------------------------------------------------------------------
 254 // event handlers for status bar updates from menus
 255 // ----------------------------------------------------------------------------
 256
 257 #if wxUSE_MENUS && wxUSE_STATUSBAR
 258
 259 void wxFrameBase::OnMenuHighlight(wxMenuEvent& event)
 260 {
 261 #if wxUSE_STATUSBAR
 262     (void)ShowMenuHelp(event.GetMenuId());
 263 #endif // wxUSE_STATUSBAR
 264 }
 265
 266 #if !wxUSE_IDLEMENUUPDATES
 267 void wxFrameBase::OnMenuOpen(wxMenuEvent& event)
 268 #else
 269 void wxFrameBase::OnMenuOpen(wxMenuEvent& WXUNUSED(event))
 270 #endif
 271 {
 272 #if !wxUSE_IDLEMENUUPDATES
 273     DoMenuUpdates(event.GetMenu());
 274 #endif // !wxUSE_IDLEMENUUPDATES
 275 }
 276
 277 void wxFrameBase::OnMenuClose(wxMenuEvent& WXUNUSED(event))
 278 {
 279     DoGiveHelp(wxEmptyString, false);
 280 }
 281
 282 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
 283
 284 // Implement internal behaviour (menu updating on some platforms)
 285 void wxFrameBase::OnInternalIdle()
 286 {
 287     wxTopLevelWindow::OnInternalIdle();
 288
 289 #if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
 290     if (wxUpdateUIEvent::CanUpdate(this))
 291         DoMenuUpdates();
 292 #endif
 293 }
 294
 295 // ----------------------------------------------------------------------------
 296 // status bar stuff
 297 // ----------------------------------------------------------------------------
 298
 299 #if wxUSE_STATUSBAR
 300
 301 wxStatusBar* wxFrameBase::CreateStatusBar(int number,
 302                                           long style,
 303                                           wxWindowID id,
 304                                           const wxString& name)
 305 {
 306     // the main status bar can only be created once (or else it should be
 307     // deleted before calling CreateStatusBar() again)
 308     wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)NULL,
 309                  wxT("recreating status bar in wxFrame") );
 310
 311     SetStatusBar(OnCreateStatusBar(number, style, id, name));
 312
 313     return m_frameStatusBar;
 314 }
 315
 316 wxStatusBar *wxFrameBase::OnCreateStatusBar(int number,
 317                                             long style,
 318                                             wxWindowID id,
 319                                             const wxString& name)
 320 {
 321     wxStatusBar *statusBar = new wxStatusBar(this, id, style, name);
 322
 323     statusBar->SetFieldsCount(number);
 324
 325     return statusBar;
 326 }
 327
 328 void wxFrameBase::SetStatusText(const wxString& text, int number)
 329 {
 330     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 331
 332     m_frameStatusBar->SetStatusText(text, number);
 333 }
 334
 335 void wxFrameBase::SetStatusWidths(int n, const int widths_field[] )
 336 {
 337     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set widths for") );
 338
 339     m_frameStatusBar->SetStatusWidths(n, widths_field);
 340
 341     PositionStatusBar();
 342 }
 343
 344 void wxFrameBase::PushStatusText(const wxString& text, int number)
 345 {
 346     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 347
 348     m_frameStatusBar->PushStatusText(text, number);
 349 }
 350
 351 void wxFrameBase::PopStatusText(int number)
 352 {
 353     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 354
 355     m_frameStatusBar->PopStatusText(number);
 356 }
 357
 358 bool wxFrameBase::ShowMenuHelp(int menuId)
 359 {
 360 #if wxUSE_MENUS
 361     // if no help string found, we will clear the status bar text
 362     wxString helpString;
 363     if ( menuId != wxID_SEPARATOR && menuId != -3 /* wxID_TITLE */ )
 364     {
 365         const wxMenuItem * const item = FindItemInMenuBar(menuId);
 366         if ( item && !item->IsSeparator() )
 367             helpString = item->GetHelp();
 368
 369         // notice that it's ok if we don't find the item because it might
 370         // belong to the popup menu, so don't assert here
 371     }
 372
 373     DoGiveHelp(helpString, true);
 374
 375     return !helpString.empty();
 376 #else // !wxUSE_MENUS
 377     return false;
 378 #endif // wxUSE_MENUS/!wxUSE_MENUS
 379 }
 380
 381 void wxFrameBase::SetStatusBar(wxStatusBar *statBar)
 382 {
 383     bool hadBar = m_frameStatusBar != NULL;
 384     m_frameStatusBar = statBar;
 385
 386     if ( (m_frameStatusBar != NULL) != hadBar )
 387     {
 388         PositionStatusBar();
 389
 390         DoLayout();
 391     }
 392 }
 393
 394 #endif // wxUSE_STATUSBAR
 395
 396 #if wxUSE_MENUS || wxUSE_TOOLBAR
 397 void wxFrameBase::DoGiveHelp(const wxString& help, bool show)
 398 {
 399 #if wxUSE_STATUSBAR
 400     if ( m_statusBarPane < 0 )
 401     {
 402         // status bar messages disabled
 403         return;
 404     }
 405
 406     wxStatusBar *statbar = GetStatusBar();
 407     if ( !statbar )
 408         return;
 409
 410     wxString text;
 411     if ( show )
 412     {
 413         // remember the old status bar text if this is the first time we're
 414         // called since the menu has been opened as we're going to overwrite it
 415         // in our DoGiveHelp() and we want to restore it when the menu is
 416         // closed
 417         //
 418         // note that it would be logical to do this in OnMenuOpen() but under
 419         // MSW we get an EVT_MENU_HIGHLIGHT before EVT_MENU_OPEN, strangely
 420         // enough, and so this doesn't work and instead we use the ugly trick
 421         // with using special m_oldStatusText value as "menu opened" (but it is
 422         // arguably better than adding yet another member variable to wxFrame
 423         // on all platforms)
 424         if ( m_oldStatusText.empty() )
 425         {
 426             m_oldStatusText = statbar->GetStatusText(m_statusBarPane);
 427             if ( m_oldStatusText.empty() )
 428             {
 429                 // use special value to prevent us from doing this the next time
 430                 m_oldStatusText += _T('\0');
 431             }
 432         }
 433
 434         text = help;
 435     }
 436     else // hide help, restore the original text
 437     {
 438         text = m_oldStatusText;
 439         m_oldStatusText.clear();
 440     }
 441
 442     statbar->SetStatusText(text, m_statusBarPane);
 443 #else
 444     wxUnusedVar(help);
 445     wxUnusedVar(show);
 446 #endif // wxUSE_STATUSBAR
 447 }
 448 #endif // wxUSE_MENUS || wxUSE_TOOLBAR
 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 const wxMenuItem *wxFrameBase::FindItemInMenuBar(int menuId) const
 567 {
 568     const wxMenuBar * const menuBar = GetMenuBar();
 569
 570     return menuBar ? menuBar->FindItem(menuId) : NULL;
 571 }
 572
 573 #endif // wxUSE_MENUS