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(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     DoGiveHelp(wxEmptyString, false);
 274 }
 275
 276 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
 277
 278 // Implement internal behaviour (menu updating on some platforms)
 279 void wxFrameBase::OnInternalIdle()
 280 {
 281     wxTopLevelWindow::OnInternalIdle();
 282
 283 #if wxUSE_MENUS && wxUSE_IDLEMENUUPDATES
 284     if (wxUpdateUIEvent::CanUpdate(this))
 285         DoMenuUpdates();
 286 #endif
 287 }
 288
 289 // ----------------------------------------------------------------------------
 290 // status bar stuff
 291 // ----------------------------------------------------------------------------
 292
 293 #if wxUSE_STATUSBAR
 294
 295 wxStatusBar* wxFrameBase::CreateStatusBar(int number,
 296                                           long style,
 297                                           wxWindowID id,
 298                                           const wxString& name)
 299 {
 300     // the main status bar can only be created once (or else it should be
 301     // deleted before calling CreateStatusBar() again)
 302     wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)NULL,
 303                  wxT("recreating status bar in wxFrame") );
 304
 305     SetStatusBar(OnCreateStatusBar(number, style, id, name));
 306
 307     return m_frameStatusBar;
 308 }
 309
 310 wxStatusBar *wxFrameBase::OnCreateStatusBar(int number,
 311                                             long style,
 312                                             wxWindowID id,
 313                                             const wxString& name)
 314 {
 315     wxStatusBar *statusBar = new wxStatusBar(this, id, style, name);
 316
 317     statusBar->SetFieldsCount(number);
 318
 319     return statusBar;
 320 }
 321
 322 void wxFrameBase::SetStatusText(const wxString& text, int number)
 323 {
 324     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 325
 326     m_frameStatusBar->SetStatusText(text, number);
 327 }
 328
 329 void wxFrameBase::SetStatusWidths(int n, const int widths_field[] )
 330 {
 331     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set widths for") );
 332
 333     m_frameStatusBar->SetStatusWidths(n, widths_field);
 334
 335     PositionStatusBar();
 336 }
 337
 338 void wxFrameBase::PushStatusText(const wxString& text, int number)
 339 {
 340     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 341
 342     m_frameStatusBar->PushStatusText(text, number);
 343 }
 344
 345 void wxFrameBase::PopStatusText(int number)
 346 {
 347     wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") );
 348
 349     m_frameStatusBar->PopStatusText(number);
 350 }
 351
 352 bool wxFrameBase::ShowMenuHelp(int menuId)
 353 {
 354 #if wxUSE_MENUS
 355     // if no help string found, we will clear the status bar text
 356     wxString helpString;
 357     if ( menuId != wxID_SEPARATOR && menuId != -3 /* wxID_TITLE */ )
 358     {
 359         const wxMenuItem * const item = FindItemInMenuBar(menuId);
 360         if ( item )
 361             helpString = item->GetHelp();
 362
 363         // notice that it's ok if we don't find the item because it might
 364         // belong to the popup menu, so don't assert here
 365     }
 366
 367     DoGiveHelp(helpString, true);
 368
 369     return !helpString.empty();
 370 #else // !wxUSE_MENUS
 371     return false;
 372 #endif // wxUSE_MENUS/!wxUSE_MENUS
 373 }
 374
 375 void wxFrameBase::SetStatusBar(wxStatusBar *statBar)
 376 {
 377     bool hadBar = m_frameStatusBar != NULL;
 378     m_frameStatusBar = statBar;
 379
 380     if ( (m_frameStatusBar != NULL) != hadBar )
 381     {
 382         PositionStatusBar();
 383
 384         DoLayout();
 385     }
 386 }
 387
 388 #endif // wxUSE_STATUSBAR
 389
 390 #if wxUSE_MENUS || wxUSE_TOOLBAR
 391 void wxFrameBase::DoGiveHelp(const wxString& help, bool show)
 392 {
 393 #if wxUSE_STATUSBAR
 394     if ( m_statusBarPane < 0 )
 395     {
 396         // status bar messages disabled
 397         return;
 398     }
 399
 400     wxStatusBar *statbar = GetStatusBar();
 401     if ( !statbar )
 402         return;
 403
 404     wxString text;
 405     if ( show )
 406     {
 407         // remember the old status bar text if this is the first time we're
 408         // called since the menu has been opened as we're going to overwrite it
 409         // in our DoGiveHelp() and we want to restore it when the menu is
 410         // closed
 411         //
 412         // note that it would be logical to do this in OnMenuOpen() but under
 413         // MSW we get an EVT_MENU_HIGHLIGHT before EVT_MENU_OPEN, strangely
 414         // enough, and so this doesn't work and instead we use the ugly trick
 415         // with using special m_oldStatusText value as "menu opened" (but it is
 416         // arguably better than adding yet another member variable to wxFrame
 417         // on all platforms)
 418         if ( m_oldStatusText.empty() )
 419         {
 420             m_oldStatusText = statbar->GetStatusText(m_statusBarPane);
 421             if ( m_oldStatusText.empty() )
 422             {
 423                 // use special value to prevent us from doing this the next time
 424                 m_oldStatusText += _T('\0');
 425             }
 426         }
 427
 428         text = help;
 429     }
 430     else // hide help, restore the original text
 431     {
 432         text = m_oldStatusText;
 433         m_oldStatusText.clear();
 434     }
 435
 436     statbar->SetStatusText(text, m_statusBarPane);
 437 #else
 438     wxUnusedVar(text);
 439     wxUnusedVar(show);
 440 #endif // wxUSE_STATUSBAR
 441 }
 442 #endif // wxUSE_MENUS || wxUSE_TOOLBAR
 443
 444
 445 // ----------------------------------------------------------------------------
 446 // toolbar stuff
 447 // ----------------------------------------------------------------------------
 448
 449 #if wxUSE_TOOLBAR
 450
 451 wxToolBar* wxFrameBase::CreateToolBar(long style,
 452                                       wxWindowID id,
 453                                       const wxString& name)
 454 {
 455     // the main toolbar can't be recreated (unless it was explicitly deleted
 456     // before)
 457     wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL,
 458                  wxT("recreating toolbar in wxFrame") );
 459
 460     if ( style == -1 )
 461     {
 462         // use default style
 463         //
 464         // NB: we don't specify the default value in the method declaration
 465         //     because
 466         //      a) this allows us to have different defaults for different
 467         //         platforms (even if we don't have them right now)
 468         //      b) we don't need to include wx/toolbar.h in the header then
 469         style = wxBORDER_NONE | wxTB_HORIZONTAL | wxTB_FLAT;
 470     }
 471
 472     SetToolBar(OnCreateToolBar(style, id, name));
 473
 474     return m_frameToolBar;
 475 }
 476
 477 wxToolBar* wxFrameBase::OnCreateToolBar(long style,
 478                                         wxWindowID id,
 479                                         const wxString& name)
 480 {
 481 #if defined(__WXWINCE__) && defined(__POCKETPC__)
 482     return new wxToolMenuBar(this, id,
 483                          wxDefaultPosition, wxDefaultSize,
 484                          style, name);
 485 #else
 486     return new wxToolBar(this, id,
 487                          wxDefaultPosition, wxDefaultSize,
 488                          style, name);
 489 #endif
 490 }
 491
 492 void wxFrameBase::SetToolBar(wxToolBar *toolbar)
 493 {
 494     bool hadBar = m_frameToolBar != NULL;
 495     m_frameToolBar = toolbar;
 496
 497     if ( (m_frameToolBar != NULL) != hadBar )
 498     {
 499         PositionToolBar();
 500
 501         DoLayout();
 502     }
 503 }
 504
 505 #endif // wxUSE_TOOLBAR
 506
 507 // ----------------------------------------------------------------------------
 508 // menus
 509 // ----------------------------------------------------------------------------
 510
 511 #if wxUSE_MENUS
 512
 513 // update all menus
 514 void wxFrameBase::DoMenuUpdates(wxMenu* menu)
 515 {
 516     if (menu)
 517     {
 518         wxEvtHandler* source = GetEventHandler();
 519         menu->UpdateUI(source);
 520     }
 521     else
 522     {
 523         wxMenuBar* bar = GetMenuBar();
 524         if (bar != NULL)
 525             bar->UpdateMenus();
 526     }
 527 }
 528
 529 void wxFrameBase::DetachMenuBar()
 530 {
 531     if ( m_frameMenuBar )
 532     {
 533         m_frameMenuBar->Detach();
 534         m_frameMenuBar = NULL;
 535     }
 536 }
 537
 538 void wxFrameBase::AttachMenuBar(wxMenuBar *menubar)
 539 {
 540     if ( menubar )
 541     {
 542         menubar->Attach((wxFrame *)this);
 543         m_frameMenuBar = menubar;
 544     }
 545 }
 546
 547 void wxFrameBase::SetMenuBar(wxMenuBar *menubar)
 548 {
 549     if ( menubar == GetMenuBar() )
 550     {
 551         // nothing to do
 552         return;
 553     }
 554
 555     DetachMenuBar();
 556
 557     this->AttachMenuBar(menubar);
 558 }
 559
 560 const wxMenuItem *wxFrameBase::FindItemInMenuBar(int menuId) const
 561 {
 562     const wxMenuBar * const menuBar = GetMenuBar();
 563
 564     return menuBar ? menuBar->FindItem(menuId) : NULL;
 565 }
 566
 567 #endif // wxUSE_MENUS