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