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