| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: 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, Julian Smart and Markus Holzem |
| 8 | // Licence: wxWindows licence |
| 9 | ///////////////////////////////////////////////////////////////////////////// |
| 10 | |
| 11 | // ============================================================================ |
| 12 | // declarations |
| 13 | // ============================================================================ |
| 14 | |
| 15 | // ---------------------------------------------------------------------------- |
| 16 | // headers |
| 17 | // ---------------------------------------------------------------------------- |
| 18 | |
| 19 | #ifdef __GNUG__ |
| 20 | #pragma implementation "framebase.h" |
| 21 | #endif |
| 22 | |
| 23 | // For compilers that support precompilation, includes "wx.h". |
| 24 | #include "wx/wxprec.h" |
| 25 | |
| 26 | #ifdef __BORLANDC__ |
| 27 | #pragma hdrstop |
| 28 | #endif |
| 29 | |
| 30 | #include "wx/frame.h" |
| 31 | #include "wx/menu.h" |
| 32 | #include "wx/menuitem.h" |
| 33 | #include "wx/dcclient.h" |
| 34 | |
| 35 | #if wxUSE_TOOLBAR |
| 36 | #include "wx/toolbar.h" |
| 37 | #endif |
| 38 | #if wxUSE_STATUSBAR |
| 39 | #include "wx/statusbr.h" |
| 40 | #endif |
| 41 | |
| 42 | // ---------------------------------------------------------------------------- |
| 43 | // event table |
| 44 | // ---------------------------------------------------------------------------- |
| 45 | |
| 46 | BEGIN_EVENT_TABLE(wxFrameBase, wxWindow) |
| 47 | EVT_IDLE(wxFrameBase::OnIdle) |
| 48 | EVT_CLOSE(wxFrameBase::OnCloseWindow) |
| 49 | EVT_MENU_HIGHLIGHT_ALL(wxFrameBase::OnMenuHighlight) |
| 50 | EVT_SIZE(wxFrameBase::OnSize) |
| 51 | END_EVENT_TABLE() |
| 52 | |
| 53 | // ============================================================================ |
| 54 | // implementation |
| 55 | // ============================================================================ |
| 56 | |
| 57 | // ---------------------------------------------------------------------------- |
| 58 | // construction/destruction |
| 59 | // ---------------------------------------------------------------------------- |
| 60 | |
| 61 | wxFrameBase::wxFrameBase() |
| 62 | { |
| 63 | m_frameMenuBar = NULL; |
| 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 | |
| 74 | bool wxFrameBase::Destroy() |
| 75 | { |
| 76 | // delayed destruction: the frame will be deleted during the next idle |
| 77 | // loop iteration |
| 78 | if ( !wxPendingDelete.Member(this) ) |
| 79 | wxPendingDelete.Append(this); |
| 80 | |
| 81 | return TRUE; |
| 82 | } |
| 83 | |
| 84 | wxFrame *wxFrameBase::New(wxWindow *parent, |
| 85 | wxWindowID id, |
| 86 | const wxString& title, |
| 87 | const wxPoint& pos, |
| 88 | const wxSize& size, |
| 89 | long style, |
| 90 | const wxString& name) |
| 91 | { |
| 92 | return new wxFrame(parent, id, title, pos, size, style, name); |
| 93 | } |
| 94 | |
| 95 | void wxFrameBase::DeleteAllBars() |
| 96 | { |
| 97 | if ( m_frameMenuBar ) |
| 98 | { |
| 99 | delete m_frameMenuBar; |
| 100 | m_frameMenuBar = (wxMenuBar *) NULL; |
| 101 | } |
| 102 | |
| 103 | #if wxUSE_STATUSBAR |
| 104 | if ( m_frameStatusBar ) |
| 105 | { |
| 106 | delete m_frameStatusBar; |
| 107 | m_frameStatusBar = (wxStatusBar *) NULL; |
| 108 | } |
| 109 | #endif // wxUSE_STATUSBAR |
| 110 | |
| 111 | #if wxUSE_TOOLBAR |
| 112 | if ( m_frameToolBar ) |
| 113 | { |
| 114 | delete m_frameToolBar; |
| 115 | m_frameToolBar = (wxToolBar *) NULL; |
| 116 | } |
| 117 | #endif // wxUSE_TOOLBAR |
| 118 | } |
| 119 | |
| 120 | // ---------------------------------------------------------------------------- |
| 121 | // wxFrame size management: we exclude the areas taken by menu/status/toolbars |
| 122 | // from the client area, so the client area is what's really available for the |
| 123 | // frame contents |
| 124 | // ---------------------------------------------------------------------------- |
| 125 | |
| 126 | // get the origin of the client area in the client coordinates |
| 127 | wxPoint wxFrameBase::GetClientAreaOrigin() const |
| 128 | { |
| 129 | wxPoint pt(0, 0); |
| 130 | |
| 131 | #if wxUSE_TOOLBAR |
| 132 | if ( GetToolBar() ) |
| 133 | { |
| 134 | int w, h; |
| 135 | GetToolBar()->GetSize(& w, & h); |
| 136 | |
| 137 | if ( GetToolBar()->GetWindowStyleFlag() & wxTB_VERTICAL ) |
| 138 | { |
| 139 | pt.x += w; |
| 140 | } |
| 141 | else |
| 142 | { |
| 143 | pt.y += h; |
| 144 | } |
| 145 | } |
| 146 | #endif // wxUSE_TOOLBAR |
| 147 | |
| 148 | return pt; |
| 149 | } |
| 150 | |
| 151 | void wxFrameBase::DoScreenToClient(int *x, int *y) const |
| 152 | { |
| 153 | wxWindow::DoScreenToClient(x, y); |
| 154 | |
| 155 | // We may be faking the client origin. |
| 156 | // So a window that's really at (0, 30) may appear |
| 157 | // (to wxWin apps) to be at (0, 0). |
| 158 | wxPoint pt(GetClientAreaOrigin()); |
| 159 | *x -= pt.x; |
| 160 | *y -= pt.y; |
| 161 | } |
| 162 | |
| 163 | void wxFrameBase::DoClientToScreen(int *x, int *y) const |
| 164 | { |
| 165 | // We may be faking the client origin. |
| 166 | // So a window that's really at (0, 30) may appear |
| 167 | // (to wxWin apps) to be at (0, 0). |
| 168 | wxPoint pt1(GetClientAreaOrigin()); |
| 169 | *x += pt1.x; |
| 170 | *y += pt1.y; |
| 171 | |
| 172 | wxWindow::DoClientToScreen(x, y); |
| 173 | } |
| 174 | |
| 175 | // ---------------------------------------------------------------------------- |
| 176 | // misc |
| 177 | // ---------------------------------------------------------------------------- |
| 178 | |
| 179 | // make the window modal (all other windows unresponsive) |
| 180 | void wxFrameBase::MakeModal(bool modal) |
| 181 | { |
| 182 | if ( modal ) |
| 183 | { |
| 184 | wxEnableTopLevelWindows(FALSE); |
| 185 | Enable(TRUE); // keep this window enabled |
| 186 | } |
| 187 | else |
| 188 | { |
| 189 | wxEnableTopLevelWindows(TRUE); |
| 190 | } |
| 191 | } |
| 192 | |
| 193 | bool wxFrameBase::ProcessCommand(int id) |
| 194 | { |
| 195 | wxMenuBar *bar = GetMenuBar(); |
| 196 | if ( !bar ) |
| 197 | return FALSE; |
| 198 | |
| 199 | wxMenuItem *item = bar->FindItem(id); |
| 200 | if ( item && item->IsCheckable() ) |
| 201 | { |
| 202 | item->Toggle(); |
| 203 | } |
| 204 | |
| 205 | wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id); |
| 206 | commandEvent.SetInt(id); |
| 207 | commandEvent.SetEventObject(this); |
| 208 | |
| 209 | return GetEventHandler()->ProcessEvent(commandEvent); |
| 210 | } |
| 211 | |
| 212 | // ---------------------------------------------------------------------------- |
| 213 | // event handlers |
| 214 | // ---------------------------------------------------------------------------- |
| 215 | |
| 216 | // default resizing behaviour - if only ONE subwindow, resize to fill the |
| 217 | // whole client area |
| 218 | void wxFrameBase::OnSize(wxSizeEvent& WXUNUSED(event)) |
| 219 | { |
| 220 | // if we're using constraints - do use them |
| 221 | #if wxUSE_CONSTRAINTS |
| 222 | if ( GetAutoLayout() ) |
| 223 | { |
| 224 | Layout(); |
| 225 | } |
| 226 | else |
| 227 | #endif |
| 228 | { |
| 229 | // do we have _exactly_ one child? |
| 230 | wxWindow *child = (wxWindow *)NULL; |
| 231 | for ( wxWindowList::Node *node = GetChildren().GetFirst(); |
| 232 | node; |
| 233 | node = node->GetNext() ) |
| 234 | { |
| 235 | wxWindow *win = node->GetData(); |
| 236 | |
| 237 | // exclude top level and managed windows (status bar isn't |
| 238 | // currently in the children list except under wxMac anyhow, but |
| 239 | // it makes no harm to test for it) |
| 240 | if ( !win->IsTopLevel() |
| 241 | #if wxUSE_STATUSBAR |
| 242 | && (win != GetStatusBar()) |
| 243 | #endif // wxUSE_STATUSBAR |
| 244 | #if wxUSE_TOOLBAR |
| 245 | && (win != GetToolBar()) |
| 246 | #endif // wxUSE_TOOLBAR |
| 247 | ) |
| 248 | { |
| 249 | if ( child ) |
| 250 | { |
| 251 | return; // it's our second subwindow - nothing to do |
| 252 | } |
| 253 | |
| 254 | child = win; |
| 255 | } |
| 256 | } |
| 257 | |
| 258 | // do we have any children at all? |
| 259 | if ( child ) |
| 260 | { |
| 261 | // exactly one child - set it's size to fill the whole frame |
| 262 | int clientW, clientH; |
| 263 | DoGetClientSize(&clientW, &clientH); |
| 264 | |
| 265 | // for whatever reasons, wxGTK wants to have a small offset - it |
| 266 | // probably looks better with it? |
| 267 | #ifdef __WXGTK__ |
| 268 | static const int ofs = 1; |
| 269 | #else |
| 270 | static const int ofs = 0; |
| 271 | #endif |
| 272 | |
| 273 | child->SetSize(ofs, ofs, clientW - 2*ofs, clientH - 2*ofs); |
| 274 | } |
| 275 | } |
| 276 | } |
| 277 | |
| 278 | // The default implementation for the close window event. |
| 279 | void wxFrameBase::OnCloseWindow(wxCloseEvent& WXUNUSED(event)) |
| 280 | { |
| 281 | Destroy(); |
| 282 | } |
| 283 | |
| 284 | void wxFrameBase::OnMenuHighlight(wxMenuEvent& event) |
| 285 | { |
| 286 | #if wxUSE_STATUSBAR |
| 287 | if ( GetStatusBar() ) |
| 288 | { |
| 289 | // if no help string found, we will clear the status bar text |
| 290 | wxString helpString; |
| 291 | |
| 292 | int menuId = event.GetMenuId(); |
| 293 | if ( menuId != wxID_SEPARATOR && menuId != -2 /* wxID_TITLE */ ) |
| 294 | { |
| 295 | wxMenuBar *menuBar = GetMenuBar(); |
| 296 | if ( menuBar ) |
| 297 | { |
| 298 | // it's ok if we don't find the item because it might belong |
| 299 | // to the popup menu |
| 300 | wxMenuItem *item = menuBar->FindItem(menuId); |
| 301 | if ( item ) |
| 302 | helpString = item->GetHelp(); |
| 303 | } |
| 304 | } |
| 305 | |
| 306 | // set status text even if the string is empty - this will at least |
| 307 | // remove the string from the item which was previously selected |
| 308 | SetStatusText(helpString); |
| 309 | } |
| 310 | #endif // wxUSE_STATUSBAR |
| 311 | } |
| 312 | |
| 313 | // ---------------------------------------------------------------------------- |
| 314 | // status bar stuff |
| 315 | // ---------------------------------------------------------------------------- |
| 316 | |
| 317 | #if wxUSE_STATUSBAR |
| 318 | |
| 319 | wxStatusBar* wxFrameBase::CreateStatusBar(int number, |
| 320 | long style, |
| 321 | wxWindowID id, |
| 322 | const wxString& name) |
| 323 | { |
| 324 | // the main status bar can only be created once (or else it should be |
| 325 | // deleted before calling CreateStatusBar() again) |
| 326 | wxCHECK_MSG( !m_frameStatusBar, (wxStatusBar *)NULL, |
| 327 | wxT("recreating status bar in wxFrame") ); |
| 328 | |
| 329 | m_frameStatusBar = OnCreateStatusBar( number, style, id, name ); |
| 330 | if ( m_frameStatusBar ) |
| 331 | PositionStatusBar(); |
| 332 | |
| 333 | return m_frameStatusBar; |
| 334 | } |
| 335 | |
| 336 | wxStatusBar *wxFrameBase::OnCreateStatusBar(int number, |
| 337 | long style, |
| 338 | wxWindowID id, |
| 339 | const wxString& name) |
| 340 | { |
| 341 | wxStatusBar *statusBar = new wxStatusBar(this, id, |
| 342 | wxPoint(0, 0), wxSize(100, 20), |
| 343 | style, name); |
| 344 | |
| 345 | // Set the height according to the font and the border size |
| 346 | wxClientDC dc(statusBar); |
| 347 | dc.SetFont(statusBar->GetFont()); |
| 348 | |
| 349 | long y; |
| 350 | dc.GetTextExtent( "X", NULL, &y ); |
| 351 | |
| 352 | int height = (int)( (11*y)/10 + 2*statusBar->GetBorderY()); |
| 353 | |
| 354 | statusBar->SetSize( -1, -1, 100, height ); |
| 355 | |
| 356 | statusBar->SetFieldsCount(number); |
| 357 | |
| 358 | return statusBar; |
| 359 | } |
| 360 | |
| 361 | void wxFrameBase::SetStatusText(const wxString& text, int number) |
| 362 | { |
| 363 | wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set text for") ); |
| 364 | |
| 365 | m_frameStatusBar->SetStatusText(text, number); |
| 366 | } |
| 367 | |
| 368 | void wxFrameBase::SetStatusWidths(int n, const int widths_field[] ) |
| 369 | { |
| 370 | wxCHECK_RET( m_frameStatusBar != NULL, wxT("no statusbar to set widths for") ); |
| 371 | |
| 372 | m_frameStatusBar->SetStatusWidths(n, widths_field); |
| 373 | |
| 374 | PositionStatusBar(); |
| 375 | } |
| 376 | |
| 377 | #endif // wxUSE_STATUSBAR |
| 378 | |
| 379 | // ---------------------------------------------------------------------------- |
| 380 | // toolbar stuff |
| 381 | // ---------------------------------------------------------------------------- |
| 382 | |
| 383 | #if wxUSE_TOOLBAR |
| 384 | |
| 385 | wxToolBar* wxFrameBase::CreateToolBar(long style, |
| 386 | wxWindowID id, |
| 387 | const wxString& name) |
| 388 | { |
| 389 | // the main toolbar can't be recreated (unless it was explicitly deeleted |
| 390 | // before) |
| 391 | wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL, |
| 392 | wxT("recreating toolbar in wxFrame") ); |
| 393 | |
| 394 | m_frameToolBar = OnCreateToolBar(style, id, name); |
| 395 | |
| 396 | return m_frameToolBar; |
| 397 | } |
| 398 | |
| 399 | wxToolBar* wxFrameBase::OnCreateToolBar(long style, |
| 400 | wxWindowID id, |
| 401 | const wxString& name) |
| 402 | { |
| 403 | return new wxToolBar(this, id, |
| 404 | wxDefaultPosition, wxDefaultSize, |
| 405 | style, name); |
| 406 | } |
| 407 | |
| 408 | #endif // wxUSE_TOOLBAR |
| 409 | |
| 410 | // ---------------------------------------------------------------------------- |
| 411 | // Menu UI updating |
| 412 | // ---------------------------------------------------------------------------- |
| 413 | |
| 414 | void wxFrameBase::OnIdle(wxIdleEvent& WXUNUSED(event) ) |
| 415 | { |
| 416 | DoMenuUpdates(); |
| 417 | } |
| 418 | |
| 419 | // update all menus |
| 420 | void wxFrameBase::DoMenuUpdates() |
| 421 | { |
| 422 | wxMenuBar* bar = GetMenuBar(); |
| 423 | |
| 424 | if ( bar != NULL ) |
| 425 | { |
| 426 | int nCount = bar->GetMenuCount(); |
| 427 | for (int n = 0; n < nCount; n++) |
| 428 | DoMenuUpdates(bar->GetMenu(n), (wxWindow*) NULL); |
| 429 | } |
| 430 | } |
| 431 | |
| 432 | // update a menu and all submenus recursively |
| 433 | void wxFrameBase::DoMenuUpdates(wxMenu* menu, wxWindow* WXUNUSED(focusWin)) |
| 434 | { |
| 435 | wxEvtHandler* evtHandler = GetEventHandler(); |
| 436 | wxMenuItemList::Node* node = menu->GetMenuItems().GetFirst(); |
| 437 | while (node) |
| 438 | { |
| 439 | wxMenuItem* item = node->GetData(); |
| 440 | if ( !item->IsSeparator() ) |
| 441 | { |
| 442 | wxWindowID id = item->GetId(); |
| 443 | wxUpdateUIEvent event(id); |
| 444 | event.SetEventObject( this ); |
| 445 | |
| 446 | if (evtHandler->ProcessEvent(event)) |
| 447 | { |
| 448 | if (event.GetSetText()) |
| 449 | menu->SetLabel(id, event.GetText()); |
| 450 | if (event.GetSetChecked()) |
| 451 | menu->Check(id, event.GetChecked()); |
| 452 | if (event.GetSetEnabled()) |
| 453 | menu->Enable(id, event.GetEnabled()); |
| 454 | } |
| 455 | |
| 456 | if (item->GetSubMenu()) |
| 457 | DoMenuUpdates(item->GetSubMenu(), (wxWindow*) NULL); |
| 458 | } |
| 459 | node = node->GetNext(); |
| 460 | } |
| 461 | } |