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     IMPLEMENT_DYNAMIC_CLASS(wxDialog, wxPanel)
  50
  51     BEGIN_EVENT_TABLE(wxDialog, wxPanel)
  52         EVT_SIZE(wxDialog::OnSize)
  53         EVT_BUTTON(wxID_OK, wxDialog::OnOK)
  54         EVT_BUTTON(wxID_APPLY, wxDialog::OnApply)
  55         EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)
  56         EVT_CHAR_HOOK(wxDialog::OnCharHook)
  57         EVT_SYS_COLOUR_CHANGED(wxDialog::OnSysColourChanged)
  58         EVT_CLOSE(wxDialog::OnCloseWindow)
  59     END_EVENT_TABLE()
  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 wxChar *dlg;
 124     if ( style & wxRESIZE_BORDER )
 125         dlg = wxT("wxResizeableDialog");
 126     else if ( style & wxCAPTION )
 127         dlg = wxT("wxCaptionDialog");
 128     else
 129         dlg = wxT("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   Show(FALSE);
 173
 174   if (m_modalShowing)
 175   {
 176     // For some reason, wxWindows can activate another task altogether
 177     // when a frame is destroyed after a modal dialog has been invoked.
 178     // Try to bring the parent to the top.
 179     // dfgg: I moved this following line from end of function -
 180     //       must not call if another window is on top!!
 181     //       This can often happen with Close() and delayed deleting
 182     if (GetParent() && GetParent()->GetHWND())
 183       ::BringWindowToTop((HWND) GetParent()->GetHWND());
 184   }
 185
 186   m_modalShowing = FALSE;
 187
 188   if ( (GetWindowStyleFlag() & wxDIALOG_MODAL) != wxDIALOG_MODAL )
 189     wxModelessWindows.DeleteObject(this);
 190
 191   // If this is the last top-level window, exit.
 192   if (wxTheApp && (wxTopLevelWindows.Number() == 0))
 193   {
 194     wxTheApp->SetTopWindow(NULL);
 195
 196     if (wxTheApp->GetExitOnFrameDelete())
 197     {
 198        PostQuitMessage(0);
 199     }
 200   }
 201 }
 202
 203 // By default, pressing escape cancels the dialog
 204 void wxDialog::OnCharHook(wxKeyEvent& event)
 205 {
 206   if (GetHWND())
 207   {
 208     if (event.m_keyCode == WXK_ESCAPE)
 209     {
 210         // Behaviour changed in 2.0: we'll send a Cancel message
 211         // to the dialog instead of Close.
 212         wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 213         cancelEvent.SetEventObject( this );
 214         GetEventHandler()->ProcessEvent(cancelEvent);
 215
 216         return;
 217     }
 218   }
 219   // We didn't process this event.
 220   event.Skip();
 221 }
 222
 223 void wxDialog::OnPaint(wxPaintEvent& event)
 224 {
 225   // No: if you call the default procedure, it makes
 226   // the following painting code not work.
 227 //  wxWindow::OnPaint(event);
 228 }
 229
 230 void wxDialog::Fit()
 231 {
 232   wxWindow::Fit();
 233 }
 234
 235 void wxDialog::Iconize(bool WXUNUSED(iconize))
 236 {
 237   // Windows dialog boxes can't be iconized
 238 }
 239
 240 bool wxDialog::IsIconized() const
 241 {
 242   return FALSE;
 243 }
 244
 245 void wxDialog::DoSetClientSize(int width, int height)
 246 {
 247   HWND hWnd = (HWND) GetHWND();
 248   RECT rect;
 249   ::GetClientRect(hWnd, &rect);
 250
 251   RECT rect2;
 252   GetWindowRect(hWnd, &rect2);
 253
 254   // Find the difference between the entire window (title bar and all)
 255   // and the client area; add this to the new client size to move the
 256   // window
 257   int actual_width = rect2.right - rect2.left - rect.right + width;
 258   int actual_height = rect2.bottom - rect2.top - rect.bottom + height;
 259
 260   MoveWindow(hWnd, rect2.left, rect2.top, actual_width, actual_height, TRUE);
 261
 262   wxSizeEvent event(wxSize(actual_width, actual_height), m_windowId);
 263   event.SetEventObject( this );
 264   GetEventHandler()->ProcessEvent(event);
 265 }
 266
 267 void wxDialog::GetPosition(int *x, int *y) const
 268 {
 269   HWND hWnd = (HWND) GetHWND();
 270   RECT rect;
 271   GetWindowRect(hWnd, &rect);
 272
 273   *x = rect.left;
 274   *y = rect.top;
 275 }
 276
 277 bool wxDialog::IsShown() const
 278 {
 279   return m_isShown;
 280 }
 281
 282 bool wxDialog::IsModal() const
 283 {
 284     return wxModalDialogs.Find((wxDialog *)this) != 0; // const_cast
 285 }
 286
 287 bool wxDialog::Show(bool show)
 288 {
 289   m_isShown = show;
 290
 291   if (show)
 292     InitDialog();
 293
 294   bool modal =  ((GetWindowStyleFlag() & wxDIALOG_MODAL) == wxDIALOG_MODAL) ;
 295
 296 #if WXGARBAGE_COLLECTION_ON /* MATTHEW: GC */
 297   if (!modal) {
 298     if (show) {
 299       if (!wxModelessWindows.Find(this))
 300         wxModelessWindows.Append(this);
 301     } else
 302       wxModelessWindows.DeleteObject(this);
 303   }
 304   if (show) {
 305     if (!wxTopLevelWindows.Find(this))
 306       wxTopLevelWindows.Append(this);
 307   } else
 308     wxTopLevelWindows.DeleteObject(this);
 309 #endif
 310
 311   if (modal)
 312   {
 313     if (show)
 314     {
 315       // find the top level window which had focus before - we will restore
 316       // focus to it later
 317       m_hwndOldFocus = 0;
 318       for ( HWND hwnd = ::GetFocus(); hwnd; hwnd = ::GetParent(hwnd) )
 319       {
 320         m_hwndOldFocus = (WXHWND)hwnd;
 321       }
 322
 323       if (m_modalShowing)
 324       {
 325         BringWindowToTop((HWND) GetHWND());
 326         return TRUE;
 327       }
 328
 329       m_modalShowing = TRUE;
 330       wxNode *node = wxModalDialogs.First();
 331       while (node)
 332       {
 333         wxDialog *box = (wxDialog *)node->Data();
 334         if (box != this)
 335           ::EnableWindow((HWND) box->GetHWND(), FALSE);
 336         node = node->Next();
 337       }
 338
 339       // if we don't do it, some window might be deleted while we have pointers
 340       // to them in our disabledWindows list and the program will crash when it
 341       // will try to reenable them after the modal dialog end
 342       wxTheApp->DeletePendingObjects();
 343       wxList disabledWindows;
 344
 345       node = wxModelessWindows.First();
 346       while (node)
 347       {
 348         wxWindow *win = (wxWindow *)node->Data();
 349         if (::IsWindowEnabled((HWND) win->GetHWND()))
 350         {
 351           ::EnableWindow((HWND) win->GetHWND(), FALSE);
 352           disabledWindows.Append(win);
 353         }
 354         node = node->Next();
 355       }
 356
 357       ShowWindow((HWND) GetHWND(), SW_SHOW);
 358       EnableWindow((HWND) GetHWND(), TRUE);
 359       BringWindowToTop((HWND) GetHWND());
 360
 361       if ( !wxModalDialogs.Find(this) )
 362         wxModalDialogs.Append(this);
 363
 364       MSG msg;
 365       // Must test whether this dialog still exists: we may not process
 366       // a message before the deletion.
 367       while (wxModalDialogs.Find(this) && m_modalShowing && GetMessage(&msg, NULL, 0, 0))
 368       {
 369         if ( m_acceleratorTable.Ok() &&
 370              ::TranslateAccelerator((HWND)GetHWND(),
 371                                      (HACCEL)m_acceleratorTable.GetHACCEL(),
 372                                      &msg) )
 373         {
 374             // Have processed the message
 375         }
 376         else if ( !wxTheApp->ProcessMessage((WXMSG *)&msg) )
 377         {
 378           TranslateMessage(&msg);
 379           DispatchMessage(&msg);
 380         }
 381
 382         // If we get crashes (as per George Tasker's message) with nested modal dialogs,
 383         // we should try removing the m_modalShowing test
 384
 385         if (m_modalShowing && !::PeekMessage(&msg, 0, 0, 0, PM_NOREMOVE))
 386         // dfgg: NB MUST test m_modalShowing again as the message loop could have triggered
 387         //       a Show(FALSE) in the mean time!!!
 388         // Without the test, we might delete the dialog before the end of modal showing.
 389         {
 390                 while (wxTheApp->ProcessIdle() && m_modalShowing)
 391                 {
 392                     // Keep going until we decide we've done enough
 393                 }
 394          }
 395       }
 396       // dfgg: now must specifically re-enable all other app windows that we disabled earlier
 397       node=disabledWindows.First();
 398       while(node) {
 399         wxWindow* win = (wxWindow*) node->Data();
 400         if (wxModalDialogs.Find(win) || wxModelessWindows.Find(win))
 401         {
 402           HWND hWnd = (HWND) win->GetHWND();
 403           if (::IsWindow(hWnd))
 404             ::EnableWindow(hWnd,TRUE);
 405         }
 406         node=node->Next();
 407       }
 408     }
 409     else // !show
 410     {
 411       ::SetFocus((HWND)m_hwndOldFocus);
 412
 413       wxModalDialogs.DeleteObject(this);
 414
 415       wxNode *last = wxModalDialogs.Last();
 416
 417       // If there's still a modal dialog active, we
 418       // enable it, else we enable all modeless windows
 419       if (last)
 420       {
 421           // VZ: I don't understand what this is supposed to do, so I'll leave
 422           //     it out for now and look for horrible consequences
 423         wxDialog *box = (wxDialog *)last->Data();
 424         HWND hwnd = (HWND) box->GetHWND();
 425 #if 0
 426         if (box->IsUserEnabled())
 427 #endif // 0
 428           EnableWindow(hwnd, TRUE);
 429         BringWindowToTop(hwnd);
 430       }
 431       else
 432       {
 433         wxNode *node = wxModelessWindows.First();
 434         while (node)
 435         {
 436           wxWindow *win = (wxWindow *)node->Data();
 437           HWND hwnd = (HWND) win->GetHWND();
 438           // Only enable again if not user-disabled.
 439 #if 0
 440           if (win->IsUserEnabled())
 441 #endif // 0
 442             EnableWindow(hwnd, TRUE);
 443           node = node->Next();
 444         }
 445       }
 446       // Try to highlight the correct window (the parent)
 447       HWND hWndParent = 0;
 448       if (GetParent())
 449       {
 450         hWndParent = (HWND) GetParent()->GetHWND();
 451         if (hWndParent)
 452           ::BringWindowToTop(hWndParent);
 453       }
 454       ShowWindow((HWND) GetHWND(), SW_HIDE);
 455       m_modalShowing = FALSE;
 456     }
 457   }
 458   else // !modal
 459   {
 460     if (show)
 461     {
 462       ShowWindow((HWND) GetHWND(), SW_SHOW);
 463       BringWindowToTop((HWND) GetHWND());
 464     }
 465     else
 466     {
 467       // Try to highlight the correct window (the parent)
 468       HWND hWndParent = 0;
 469       if (GetParent())
 470       {
 471         hWndParent = (HWND) GetParent()->GetHWND();
 472         if (hWndParent)
 473           ::BringWindowToTop(hWndParent);
 474       }
 475
 476       if ( m_hWnd )
 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 }