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 char *dlg;
 126     if ( style & wxTHICK_FRAME )
 127         dlg = "wxResizeableDialog";
 128     else if ( style & wxCAPTION )
 129         dlg = "wxCaptionDialog";
 130     else
 131         dlg = "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   if (m_modalShowing)
 175   {
 176     Show(FALSE);
 177     // For some reason, wxWindows can activate another task altogether
 178     // when a frame is destroyed after a modal dialog has been invoked.
 179     // Try to bring the parent to the top.
 180     // dfgg: I moved this following line from end of function -
 181     //       must not call if another window is on top!!
 182     //       This can often happen with Close() and delayed deleting
 183     if (GetParent() && GetParent()->GetHWND())
 184       ::BringWindowToTop((HWND) GetParent()->GetHWND());
 185   }
 186
 187   m_modalShowing = FALSE;
 188   if ( GetHWND() )
 189     ShowWindow((HWND) GetHWND(), SW_HIDE);
 190
 191   if ( (GetWindowStyleFlag() & wxDIALOG_MODAL) != wxDIALOG_MODAL )
 192     wxModelessWindows.DeleteObject(this);
 193
 194   UnsubclassWin();
 195
 196   // If this is the last top-level window, exit.
 197   if (wxTheApp && (wxTopLevelWindows.Number() == 0))
 198   {
 199     wxTheApp->SetTopWindow(NULL);
 200
 201     if (wxTheApp->GetExitOnFrameDelete())
 202     {
 203        PostQuitMessage(0);
 204     }
 205   }
 206 }
 207
 208 // By default, pressing escape cancels the dialog
 209 void wxDialog::OnCharHook(wxKeyEvent& event)
 210 {
 211   if (GetHWND())
 212   {
 213     if (event.m_keyCode == WXK_ESCAPE)
 214     {
 215         // Behaviour changed in 2.0: we'll send a Cancel message
 216         // to the dialog instead of Close.
 217         wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 218         cancelEvent.SetEventObject( this );
 219         GetEventHandler()->ProcessEvent(cancelEvent);
 220
 221         return;
 222     }
 223   }
 224   // We didn't process this event.
 225   event.Skip();
 226 }
 227
 228 void wxDialog::OnPaint(wxPaintEvent& event)
 229 {
 230   // No: if you call the default procedure, it makes
 231   // the following painting code not work.
 232 //  wxWindow::OnPaint(event);
 233 }
 234
 235 void wxDialog::Fit()
 236 {
 237   wxWindow::Fit();
 238 }
 239
 240 void wxDialog::Iconize(bool WXUNUSED(iconize))
 241 {
 242   // Windows dialog boxes can't be iconized
 243 }
 244
 245 bool wxDialog::IsIconized() const
 246 {
 247   return FALSE;
 248 }
 249
 250 void wxDialog::DoSetClientSize(int width, int height)
 251 {
 252   HWND hWnd = (HWND) GetHWND();
 253   RECT rect;
 254   ::GetClientRect(hWnd, &rect);
 255
 256   RECT rect2;
 257   GetWindowRect(hWnd, &rect2);
 258
 259   // Find the difference between the entire window (title bar and all)
 260   // and the client area; add this to the new client size to move the
 261   // window
 262   int actual_width = rect2.right - rect2.left - rect.right + width;
 263   int actual_height = rect2.bottom - rect2.top - rect.bottom + height;
 264
 265   MoveWindow(hWnd, rect2.left, rect2.top, actual_width, actual_height, TRUE);
 266
 267   wxSizeEvent event(wxSize(actual_width, actual_height), m_windowId);
 268   event.SetEventObject( this );
 269   GetEventHandler()->ProcessEvent(event);
 270 }
 271
 272 void wxDialog::GetPosition(int *x, int *y) const
 273 {
 274   HWND hWnd = (HWND) GetHWND();
 275   RECT rect;
 276   GetWindowRect(hWnd, &rect);
 277
 278   *x = rect.left;
 279   *y = rect.top;
 280 }
 281
 282 bool wxDialog::IsShown() const
 283 {
 284   return m_isShown;
 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       ShowWindow((HWND) GetHWND(), SW_HIDE);
 476     }
 477   }
 478   return TRUE;
 479 }
 480
 481 void wxDialog::SetTitle(const wxString& title)
 482 {
 483   SetWindowText((HWND) GetHWND(), (const char *)title);
 484 }
 485
 486 wxString wxDialog::GetTitle() const
 487 {
 488   GetWindowText((HWND) GetHWND(), wxBuffer, 1000);
 489   return wxString(wxBuffer);
 490 }
 491
 492 void wxDialog::Centre(int direction)
 493 {
 494   int x_offset,y_offset ;
 495   int display_width, display_height;
 496   int  width, height, x, y;
 497   wxWindow *parent = GetParent();
 498   if ((direction & wxCENTER_FRAME) && parent)
 499   {
 500       parent->GetPosition(&x_offset,&y_offset) ;
 501       parent->GetSize(&display_width,&display_height) ;
 502   }
 503   else
 504   {
 505     wxDisplaySize(&display_width, &display_height);
 506     x_offset = 0 ;
 507     y_offset = 0 ;
 508   }
 509
 510   GetSize(&width, &height);
 511   GetPosition(&x, &y);
 512
 513   if (direction & wxHORIZONTAL)
 514     x = (int)((display_width - width)/2);
 515   if (direction & wxVERTICAL)
 516     y = (int)((display_height - height)/2);
 517
 518   SetSize(x+x_offset, y+y_offset, width, height);
 519 }
 520
 521 // Replacement for Show(TRUE) for modal dialogs - returns return code
 522 int wxDialog::ShowModal()
 523 {
 524   m_windowStyle |= wxDIALOG_MODAL;
 525   Show(TRUE);
 526   return GetReturnCode();
 527 }
 528
 529 void wxDialog::EndModal(int retCode)
 530 {
 531   SetReturnCode(retCode);
 532   Show(FALSE);
 533 }
 534
 535 // Define for each class of dialog and control
 536 WXHBRUSH wxDialog::OnCtlColor(WXHDC pDC, WXHWND pWnd, WXUINT nCtlColor,
 537       WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 538 {
 539 #if wxUSE_CTL3D
 540   HBRUSH hbrush = Ctl3dCtlColorEx(message, wParam, lParam);
 541   return (WXHBRUSH) hbrush;
 542 #else
 543   return 0;
 544 #endif
 545 }
 546
 547 // Standard buttons
 548 void wxDialog::OnOK(wxCommandEvent& event)
 549 {
 550   if ( Validate() && TransferDataFromWindow() )
 551   {
 552         if ( IsModal() )
 553             EndModal(wxID_OK);
 554         else
 555         {
 556             SetReturnCode(wxID_OK);
 557             this->Show(FALSE);
 558         }
 559   }
 560 }
 561
 562 void wxDialog::OnApply(wxCommandEvent& event)
 563 {
 564   if (Validate())
 565     TransferDataFromWindow();
 566   // TODO probably need to disable the Apply button until things change again
 567 }
 568
 569 void wxDialog::OnCancel(wxCommandEvent& event)
 570 {
 571     if ( IsModal() )
 572         EndModal(wxID_CANCEL);
 573     else
 574     {
 575         SetReturnCode(wxID_CANCEL);
 576         this->Show(FALSE);
 577     }
 578 }
 579
 580 void wxDialog::OnCloseWindow(wxCloseEvent& event)
 581 {
 582     // We'll send a Cancel message by default,
 583     // which may close the dialog.
 584     // Check for looping if the Cancel event handler calls Close().
 585
 586     // Note that if a cancel button and handler aren't present in the dialog,
 587     // nothing will happen when you close the dialog via the window manager, or
 588     // via Close().
 589     // We wouldn't want to destroy the dialog by default, since the dialog may have been
 590     // created on the stack.
 591     // However, this does mean that calling dialog->Close() won't delete the dialog
 592     // unless the handler for wxID_CANCEL does so. So use Destroy() if you want to be
 593     // sure to destroy the dialog.
 594     // The default OnCancel (above) simply ends a modal dialog, and hides a modeless dialog.
 595
 596     static wxList closing;
 597
 598     if ( closing.Member(this) )
 599         return;
 600
 601     closing.Append(this);
 602
 603     wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 604     cancelEvent.SetEventObject( this );
 605     GetEventHandler()->ProcessEvent(cancelEvent); // This may close the dialog
 606
 607     closing.DeleteObject(this);
 608 }
 609
 610 // Destroy the window (delayed, if a managed window)
 611 bool wxDialog::Destroy()
 612 {
 613   if (!wxPendingDelete.Member(this))
 614     wxPendingDelete.Append(this);
 615   return TRUE;
 616 }
 617
 618 void wxDialog::OnSize(wxSizeEvent& WXUNUSED(event))
 619 {
 620   // if we're using constraints - do use them
 621   #if wxUSE_CONSTRAINTS
 622     if ( GetAutoLayout() )
 623     {
 624       Layout();
 625     }
 626   #endif
 627 }
 628
 629 void wxDialog::OnSysColourChanged(wxSysColourChangedEvent& event)
 630 {
 631 #if wxUSE_CTL3D
 632   Ctl3dColorChange();
 633 #else
 634   SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
 635   Refresh();
 636 #endif
 637 }
 638
 639 // ---------------------------------------------------------------------------
 640 // dialog window proc
 641 // ---------------------------------------------------------------------------
 642
 643 long wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 644 {
 645     long rc = 0;
 646     bool processed = FALSE;
 647
 648     switch ( message )
 649     {
 650         case WM_CLOSE:
 651             // if we can't close, tell the system that we processed the
 652             // message - otherwise it would close us
 653             processed = !Close();
 654             break;
 655     }
 656
 657     if ( !processed )
 658         rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 659
 660     return rc;
 661 }