src/msw/dialog.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        dialog.cpp
   3 // Purpose:     wxDialog class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  13 #pragma implementation "dialog.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20 #pragma hdrstop
  21 #endif
  22
  23 #ifndef WX_PRECOMP
  24 #include "wx/dialog.h"
  25 #include "wx/utils.h"
  26 #include "wx/frame.h"
  27 #include "wx/app.h"
  28 #include "wx/settings.h"
  29 #include "wx/intl.h"
  30 #include "wx/log.h"
  31 #endif
  32
  33 #include "wx/msw/private.h"
  34 #include "wx/log.h"
  35
  36 #if wxUSE_COMMON_DIALOGS
  37 #include <commdlg.h>
  38 #endif
  39
  40 #define wxDIALOG_DEFAULT_X 300
  41 #define wxDIALOG_DEFAULT_Y 300
  42
  43 // Lists to keep track of windows, so we can disable/enable them
  44 // for modal dialogs
  45 wxWindowList wxModalDialogs;
  46 wxWindowList wxModelessWindows;  // Frames and modeless dialogs
  47 extern wxList WXDLLEXPORT wxPendingDelete;
  48
  49 #if !USE_SHARED_LIBRARY
  50     IMPLEMENT_DYNAMIC_CLASS(wxDialog, wxPanel)
  51
  52     BEGIN_EVENT_TABLE(wxDialog, wxPanel)
  53         EVT_SIZE(wxDialog::OnSize)
  54         EVT_BUTTON(wxID_OK, wxDialog::OnOK)
  55         EVT_BUTTON(wxID_APPLY, wxDialog::OnApply)
  56         EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)
  57         EVT_CHAR_HOOK(wxDialog::OnCharHook)
  58         EVT_SYS_COLOUR_CHANGED(wxDialog::OnSysColourChanged)
  59         EVT_CLOSE(wxDialog::OnCloseWindow)
  60     END_EVENT_TABLE()
  61 #endif
  62
  63 wxDialog::wxDialog()
  64 {
  65   m_isShown = FALSE;
  66   m_modalShowing = FALSE;
  67
  68   SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
  69 }
  70
  71 bool wxDialog::Create(wxWindow *parent, wxWindowID id,
  72                       const wxString& title,
  73                       const wxPoint& pos,
  74                       const wxSize& size,
  75                       long style,
  76                       const wxString& name)
  77 {
  78 #if wxUSE_TOOLTIPS
  79     m_hwndToolTip = 0;
  80 #endif
  81
  82     SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
  83     SetName(name);
  84
  85     if (!parent)
  86         wxTopLevelWindows.Append(this);
  87
  88     //  windowFont = wxTheFontList->FindOrCreateFont(11, wxSWISS, wxNORMAL, wxNORMAL);
  89
  90     if (parent) parent->AddChild(this);
  91
  92     if ( id == -1 )
  93         m_windowId = (int)NewControlId();
  94     else
  95         m_windowId = id;
  96
  97     int x = pos.x;
  98     int y = pos.y;
  99     int width = size.x;
 100     int height = size.y;
 101
 102     if (x < 0) x = wxDIALOG_DEFAULT_X;
 103     if (y < 0) y = wxDIALOG_DEFAULT_Y;
 104
 105     m_windowStyle = style;
 106
 107     m_isShown = FALSE;
 108     m_modalShowing = FALSE;
 109
 110     if (width < 0)
 111         width = 500;
 112     if (height < 0)
 113         height = 500;
 114
 115     // All dialogs should really have this style
 116     m_windowStyle |= wxTAB_TRAVERSAL;
 117
 118     WXDWORD extendedStyle = MakeExtendedStyle(m_windowStyle);
 119     if (m_windowStyle & wxSTAY_ON_TOP)
 120         extendedStyle |= WS_EX_TOPMOST;
 121
 122     // Allows creation of dialogs with & without captions under MSWindows,
 123     // resizeable or not (but a resizeable dialog always has caption -
 124     // otherwise it would look too strange)
 125     const wxChar *dlg;
 126     if ( style & wxRESIZE_BORDER )
 127         dlg = _T("wxResizeableDialog");
 128     else if ( style & wxCAPTION )
 129         dlg = _T("wxCaptionDialog");
 130     else
 131         dlg = _T("wxNoCaptionDialog");
 132     MSWCreate(m_windowId, parent, NULL, this, NULL,
 133               x, y, width, height,
 134               0, // style is not used if we have dlg template
 135               dlg,
 136               extendedStyle);
 137
 138     HWND hwnd = (HWND)GetHWND();
 139
 140     if ( !hwnd )
 141     {
 142         wxLogError(_("Failed to create dialog."));
 143
 144         return FALSE;
 145     }
 146
 147     SubclassWin(GetHWND());
 148
 149     SetWindowText(hwnd, title);
 150     SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
 151
 152     return TRUE;
 153 }
 154
 155 void wxDialog::SetModal(bool flag)
 156 {
 157   if ( flag )
 158     m_windowStyle |= wxDIALOG_MODAL ;
 159   else
 160     if ( m_windowStyle & wxDIALOG_MODAL )
 161         m_windowStyle -= wxDIALOG_MODAL ;
 162
 163   wxModelessWindows.DeleteObject(this);
 164   if (!flag)
 165     wxModelessWindows.Append(this);
 166 }
 167
 168 wxDialog::~wxDialog()
 169 {
 170   m_isBeingDeleted = TRUE;
 171
 172   wxTopLevelWindows.DeleteObject(this);
 173
 174   Show(FALSE);
 175
 176   if (m_modalShowing)
 177   {
 178     // For some reason, wxWindows can activate another task altogether
 179     // when a frame is destroyed after a modal dialog has been invoked.
 180     // Try to bring the parent to the top.
 181     // dfgg: I moved this following line from end of function -
 182     //       must not call if another window is on top!!
 183     //       This can often happen with Close() and delayed deleting
 184     if (GetParent() && GetParent()->GetHWND())
 185       ::BringWindowToTop((HWND) GetParent()->GetHWND());
 186   }
 187
 188   m_modalShowing = FALSE;
 189
 190   if ( (GetWindowStyleFlag() & wxDIALOG_MODAL) != wxDIALOG_MODAL )
 191     wxModelessWindows.DeleteObject(this);
 192
 193   // If this is the last top-level window, exit.
 194   if (wxTheApp && (wxTopLevelWindows.Number() == 0))
 195   {
 196     wxTheApp->SetTopWindow(NULL);
 197
 198     if (wxTheApp->GetExitOnFrameDelete())
 199     {
 200        PostQuitMessage(0);
 201     }
 202   }
 203 }
 204
 205 // By default, pressing escape cancels the dialog
 206 void wxDialog::OnCharHook(wxKeyEvent& event)
 207 {
 208   if (GetHWND())
 209   {
 210     if (event.m_keyCode == WXK_ESCAPE)
 211     {
 212         // Behaviour changed in 2.0: we'll send a Cancel message
 213         // to the dialog instead of Close.
 214         wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 215         cancelEvent.SetEventObject( this );
 216         GetEventHandler()->ProcessEvent(cancelEvent);
 217
 218         return;
 219     }
 220   }
 221   // We didn't process this event.
 222   event.Skip();
 223 }
 224
 225 void wxDialog::OnPaint(wxPaintEvent& event)
 226 {
 227   // No: if you call the default procedure, it makes
 228   // the following painting code not work.
 229 //  wxWindow::OnPaint(event);
 230 }
 231
 232 void wxDialog::Fit()
 233 {
 234   wxWindow::Fit();
 235 }
 236
 237 void wxDialog::Iconize(bool WXUNUSED(iconize))
 238 {
 239   // Windows dialog boxes can't be iconized
 240 }
 241
 242 bool wxDialog::IsIconized() const
 243 {
 244   return FALSE;
 245 }
 246
 247 void wxDialog::DoSetClientSize(int width, int height)
 248 {
 249   HWND hWnd = (HWND) GetHWND();
 250   RECT rect;
 251   ::GetClientRect(hWnd, &rect);
 252
 253   RECT rect2;
 254   GetWindowRect(hWnd, &rect2);
 255
 256   // Find the difference between the entire window (title bar and all)
 257   // and the client area; add this to the new client size to move the
 258   // window
 259   int actual_width = rect2.right - rect2.left - rect.right + width;
 260   int actual_height = rect2.bottom - rect2.top - rect.bottom + height;
 261
 262   MoveWindow(hWnd, rect2.left, rect2.top, actual_width, actual_height, TRUE);
 263
 264   wxSizeEvent event(wxSize(actual_width, actual_height), m_windowId);
 265   event.SetEventObject( this );
 266   GetEventHandler()->ProcessEvent(event);
 267 }
 268
 269 void wxDialog::GetPosition(int *x, int *y) const
 270 {
 271   HWND hWnd = (HWND) GetHWND();
 272   RECT rect;
 273   GetWindowRect(hWnd, &rect);
 274
 275   *x = rect.left;
 276   *y = rect.top;
 277 }
 278
 279 bool wxDialog::IsShown() const
 280 {
 281   return m_isShown;
 282 }
 283
 284 bool wxDialog::IsModal() const
 285 {
 286     return wxModalDialogs.Find((wxDialog *)this) != 0; // const_cast
 287 }
 288
 289 bool wxDialog::Show(bool show)
 290 {
 291   m_isShown = show;
 292
 293   if (show)
 294     InitDialog();
 295
 296   bool modal =  ((GetWindowStyleFlag() & wxDIALOG_MODAL) == wxDIALOG_MODAL) ;
 297
 298 #if WXGARBAGE_COLLECTION_ON /* MATTHEW: GC */
 299   if (!modal) {
 300     if (show) {
 301       if (!wxModelessWindows.Find(this))
 302         wxModelessWindows.Append(this);
 303     } else
 304       wxModelessWindows.DeleteObject(this);
 305   }
 306   if (show) {
 307     if (!wxTopLevelWindows.Find(this))
 308       wxTopLevelWindows.Append(this);
 309   } else
 310     wxTopLevelWindows.DeleteObject(this);
 311 #endif
 312
 313   if (modal)
 314   {
 315     if (show)
 316     {
 317       // find the top level window which had focus before - we will restore
 318       // focus to it later
 319       m_hwndOldFocus = 0;
 320       for ( HWND hwnd = ::GetFocus(); hwnd; hwnd = ::GetParent(hwnd) )
 321       {
 322         m_hwndOldFocus = (WXHWND)hwnd;
 323       }
 324
 325       if (m_modalShowing)
 326       {
 327         BringWindowToTop((HWND) GetHWND());
 328         return TRUE;
 329       }
 330
 331       m_modalShowing = TRUE;
 332       wxNode *node = wxModalDialogs.First();
 333       while (node)
 334       {
 335         wxDialog *box = (wxDialog *)node->Data();
 336         if (box != this)
 337           ::EnableWindow((HWND) box->GetHWND(), FALSE);
 338         node = node->Next();
 339       }
 340
 341       // if we don't do it, some window might be deleted while we have pointers
 342       // to them in our disabledWindows list and the program will crash when it
 343       // will try to reenable them after the modal dialog end
 344       wxTheApp->DeletePendingObjects();
 345       wxList disabledWindows;
 346
 347       node = wxModelessWindows.First();
 348       while (node)
 349       {
 350         wxWindow *win = (wxWindow *)node->Data();
 351         if (::IsWindowEnabled((HWND) win->GetHWND()))
 352         {
 353           ::EnableWindow((HWND) win->GetHWND(), FALSE);
 354           disabledWindows.Append(win);
 355         }
 356         node = node->Next();
 357       }
 358
 359       ShowWindow((HWND) GetHWND(), SW_SHOW);
 360       EnableWindow((HWND) GetHWND(), TRUE);
 361       BringWindowToTop((HWND) GetHWND());
 362
 363       if ( !wxModalDialogs.Find(this) )
 364         wxModalDialogs.Append(this);
 365
 366       MSG msg;
 367       // Must test whether this dialog still exists: we may not process
 368       // a message before the deletion.
 369       while (wxModalDialogs.Find(this) && m_modalShowing && GetMessage(&msg, NULL, 0, 0))
 370       {
 371         if ( m_acceleratorTable.Ok() &&
 372              ::TranslateAccelerator((HWND)GetHWND(),
 373                                      (HACCEL)m_acceleratorTable.GetHACCEL(),
 374                                      &msg) )
 375         {
 376             // Have processed the message
 377         }
 378         else if ( !wxTheApp->ProcessMessage((WXMSG *)&msg) )
 379         {
 380           TranslateMessage(&msg);
 381           DispatchMessage(&msg);
 382         }
 383
 384         // If we get crashes (as per George Tasker's message) with nested modal dialogs,
 385         // we should try removing the m_modalShowing test
 386
 387         if (m_modalShowing && !::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE))
 388         // dfgg: NB MUST test m_modalShowing again as the message loop could have triggered
 389         //       a Show(FALSE) in the mean time!!!
 390         // Without the test, we might delete the dialog before the end of modal showing.
 391         {
 392                 while (wxTheApp->ProcessIdle() && m_modalShowing)
 393                 {
 394                     // Keep going until we decide we've done enough
 395                 }
 396          }
 397       }
 398       // dfgg: now must specifically re-enable all other app windows that we disabled earlier
 399       node=disabledWindows.First();
 400       while(node) {
 401         wxWindow* win = (wxWindow*) node->Data();
 402         if (wxModalDialogs.Find(win) || wxModelessWindows.Find(win))
 403         {
 404           HWND hWnd = (HWND) win->GetHWND();
 405           if (::IsWindow(hWnd))
 406             ::EnableWindow(hWnd,TRUE);
 407         }
 408         node=node->Next();
 409       }
 410     }
 411     else // !show
 412     {
 413       ::SetFocus((HWND)m_hwndOldFocus);
 414
 415       wxModalDialogs.DeleteObject(this);
 416
 417       wxNode *last = wxModalDialogs.Last();
 418
 419       // If there's still a modal dialog active, we
 420       // enable it, else we enable all modeless windows
 421       if (last)
 422       {
 423           // VZ: I don't understand what this is supposed to do, so I'll leave
 424           //     it out for now and look for horrible consequences
 425         wxDialog *box = (wxDialog *)last->Data();
 426         HWND hwnd = (HWND) box->GetHWND();
 427 #if 0
 428         if (box->IsUserEnabled())
 429 #endif // 0
 430           EnableWindow(hwnd, TRUE);
 431         BringWindowToTop(hwnd);
 432       }
 433       else
 434       {
 435         wxNode *node = wxModelessWindows.First();
 436         while (node)
 437         {
 438           wxWindow *win = (wxWindow *)node->Data();
 439           HWND hwnd = (HWND) win->GetHWND();
 440           // Only enable again if not user-disabled.
 441 #if 0
 442           if (win->IsUserEnabled())
 443 #endif // 0
 444             EnableWindow(hwnd, TRUE);
 445           node = node->Next();
 446         }
 447       }
 448       // Try to highlight the correct window (the parent)
 449       HWND hWndParent = 0;
 450       if (GetParent())
 451       {
 452         hWndParent = (HWND) GetParent()->GetHWND();
 453         if (hWndParent)
 454           ::BringWindowToTop(hWndParent);
 455       }
 456       ShowWindow((HWND) GetHWND(), SW_HIDE);
 457       m_modalShowing = FALSE;
 458     }
 459   }
 460   else // !modal
 461   {
 462     if (show)
 463     {
 464       ShowWindow((HWND) GetHWND(), SW_SHOW);
 465       BringWindowToTop((HWND) GetHWND());
 466     }
 467     else
 468     {
 469       // Try to highlight the correct window (the parent)
 470       HWND hWndParent = 0;
 471       if (GetParent())
 472       {
 473         hWndParent = (HWND) GetParent()->GetHWND();
 474         if (hWndParent)
 475           ::BringWindowToTop(hWndParent);
 476       }
 477       ShowWindow((HWND) GetHWND(), SW_HIDE);
 478     }
 479   }
 480   return TRUE;
 481 }
 482
 483 void wxDialog::SetTitle(const wxString& title)
 484 {
 485   SetWindowText((HWND) GetHWND(), title.c_str());
 486 }
 487
 488 wxString wxDialog::GetTitle() const
 489 {
 490   GetWindowText((HWND) GetHWND(), wxBuffer, 1000);
 491   return wxString(wxBuffer);
 492 }
 493
 494 void wxDialog::Centre(int direction)
 495 {
 496   int x_offset,y_offset ;
 497   int display_width, display_height;
 498   int  width, height, x, y;
 499   wxWindow *parent = GetParent();
 500   if ((direction & wxCENTER_FRAME) && parent)
 501   {
 502       parent->GetPosition(&x_offset,&y_offset) ;
 503       parent->GetSize(&display_width,&display_height) ;
 504   }
 505   else
 506   {
 507     wxDisplaySize(&display_width, &display_height);
 508     x_offset = 0 ;
 509     y_offset = 0 ;
 510   }
 511
 512   GetSize(&width, &height);
 513   GetPosition(&x, &y);
 514
 515   if (direction & wxHORIZONTAL)
 516     x = (int)((display_width - width)/2);
 517   if (direction & wxVERTICAL)
 518     y = (int)((display_height - height)/2);
 519
 520   SetSize(x+x_offset, y+y_offset, width, height);
 521 }
 522
 523 // Replacement for Show(TRUE) for modal dialogs - returns return code
 524 int wxDialog::ShowModal()
 525 {
 526   m_windowStyle |= wxDIALOG_MODAL;
 527   Show(TRUE);
 528   return GetReturnCode();
 529 }
 530
 531 void wxDialog::EndModal(int retCode)
 532 {
 533   SetReturnCode(retCode);
 534   Show(FALSE);
 535 }
 536
 537 // Define for each class of dialog and control
 538 WXHBRUSH wxDialog::OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
 539       WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 540 {
 541 #if wxUSE_CTL3D
 542   HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
 543   return (WXHBRUSH) hbrush;
 544 #else
 545   return 0;
 546 #endif
 547 }
 548
 549 // Standard buttons
 550 void wxDialog::OnOK(wxCommandEvent& event)
 551 {
 552   if ( Validate() && TransferDataFromWindow() )
 553   {
 554         if ( IsModal() )
 555             EndModal(wxID_OK);
 556         else
 557         {
 558             SetReturnCode(wxID_OK);
 559             this->Show(FALSE);
 560         }
 561   }
 562 }
 563
 564 void wxDialog::OnApply(wxCommandEvent& event)
 565 {
 566   if (Validate())
 567     TransferDataFromWindow();
 568   // TODO probably need to disable the Apply button until things change again
 569 }
 570
 571 void wxDialog::OnCancel(wxCommandEvent& event)
 572 {
 573     if ( IsModal() )
 574         EndModal(wxID_CANCEL);
 575     else
 576     {
 577         SetReturnCode(wxID_CANCEL);
 578         this->Show(FALSE);
 579     }
 580 }
 581
 582 void wxDialog::OnCloseWindow(wxCloseEvent& event)
 583 {
 584     // We'll send a Cancel message by default,
 585     // which may close the dialog.
 586     // Check for looping if the Cancel event handler calls Close().
 587
 588     // Note that if a cancel button and handler aren't present in the dialog,
 589     // nothing will happen when you close the dialog via the window manager, or
 590     // via Close().
 591     // We wouldn't want to destroy the dialog by default, since the dialog may have been
 592     // created on the stack.
 593     // However, this does mean that calling dialog->Close() won't delete the dialog
 594     // unless the handler for wxID_CANCEL does so. So use Destroy() if you want to be
 595     // sure to destroy the dialog.
 596     // The default OnCancel (above) simply ends a modal dialog, and hides a modeless dialog.
 597
 598     static wxList closing;
 599
 600     if ( closing.Member(this) )
 601         return;
 602
 603     closing.Append(this);
 604
 605     wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 606     cancelEvent.SetEventObject( this );
 607     GetEventHandler()->ProcessEvent(cancelEvent); // This may close the dialog
 608
 609     closing.DeleteObject(this);
 610 }
 611
 612 // Destroy the window (delayed, if a managed window)
 613 bool wxDialog::Destroy()
 614 {
 615   if (!wxPendingDelete.Member(this))
 616     wxPendingDelete.Append(this);
 617   return TRUE;
 618 }
 619
 620 void wxDialog::OnSize(wxSizeEvent& WXUNUSED(event))
 621 {
 622   // if we're using constraints - do use them
 623   #if wxUSE_CONSTRAINTS
 624     if ( GetAutoLayout() )
 625     {
 626       Layout();
 627     }
 628   #endif
 629 }
 630
 631 void wxDialog::OnSysColourChanged(wxSysColourChangedEvent& event)
 632 {
 633 #if wxUSE_CTL3D
 634   Ctl3dColorChange();
 635 #else
 636   SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
 637   Refresh();
 638 #endif
 639 }
 640
 641 // ---------------------------------------------------------------------------
 642 // dialog window proc
 643 // ---------------------------------------------------------------------------
 644
 645 long wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 646 {
 647     long rc = 0;
 648     bool processed = FALSE;
 649
 650     switch ( message )
 651     {
 652         case WM_CLOSE:
 653             // if we can't close, tell the system that we processed the
 654             // message - otherwise it would close us
 655             processed = !Close();
 656             break;
 657     }
 658
 659     if ( !processed )
 660         rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 661
 662     return rc;
 663 }