src/msw/dialog.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/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 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "dialog.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/dialog.h"
  33     #include "wx/utils.h"
  34     #include "wx/frame.h"
  35     #include "wx/app.h"
  36     #include "wx/settings.h"
  37     #include "wx/intl.h"
  38     #include "wx/log.h"
  39 #endif
  40
  41 #include "wx/msw/private.h"
  42 #include "wx/log.h"
  43
  44 #if wxUSE_COMMON_DIALOGS
  45     #include <commdlg.h>
  46 #endif
  47
  48 // ----------------------------------------------------------------------------
  49 // constants
  50 // ----------------------------------------------------------------------------
  51
  52 // default dialog pos and size
  53
  54 #define wxDIALOG_DEFAULT_X 300
  55 #define wxDIALOG_DEFAULT_Y 300
  56
  57 #define wxDIALOG_DEFAULT_WIDTH 500
  58 #define wxDIALOG_DEFAULT_HEIGHT 500
  59
  60 // ----------------------------------------------------------------------------
  61 // globals
  62 // ----------------------------------------------------------------------------
  63
  64 // all objects to be deleted during next idle processing - from window.cpp
  65 extern wxList WXDLLEXPORT wxPendingDelete;
  66
  67 // all frames and modeless dialogs - not static, used in frame.cpp, mdi.cpp &c
  68 wxWindowList wxModelessWindows;
  69
  70 // all modal dialogs currently shown
  71 static wxWindowList wxModalDialogs;
  72
  73 // ----------------------------------------------------------------------------
  74 // wxWin macros
  75 // ----------------------------------------------------------------------------
  76
  77 IMPLEMENT_DYNAMIC_CLASS(wxDialog, wxPanel)
  78
  79 BEGIN_EVENT_TABLE(wxDialog, wxPanel)
  80     EVT_BUTTON(wxID_OK, wxDialog::OnOK)
  81     EVT_BUTTON(wxID_APPLY, wxDialog::OnApply)
  82     EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)
  83
  84     EVT_CHAR_HOOK(wxDialog::OnCharHook)
  85
  86     EVT_SYS_COLOUR_CHANGED(wxDialog::OnSysColourChanged)
  87
  88     EVT_CLOSE(wxDialog::OnCloseWindow)
  89 END_EVENT_TABLE()
  90
  91 // ============================================================================
  92 // implementation
  93 // ============================================================================
  94
  95 // ----------------------------------------------------------------------------
  96 // wxDialog construction
  97 // ----------------------------------------------------------------------------
  98
  99 wxDialog::wxDialog()
 100 {
 101     m_oldFocus = (wxWindow *)NULL;
 102     m_isShown = FALSE;
 103
 104     SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
 105 }
 106
 107 bool wxDialog::Create(wxWindow *parent, wxWindowID id,
 108                       const wxString& title,
 109                       const wxPoint& pos,
 110                       const wxSize& size,
 111                       long style,
 112                       const wxString& name)
 113 {
 114     m_oldFocus = FindFocus();
 115
 116     SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
 117     SetName(name);
 118
 119     wxTopLevelWindows.Append(this);
 120
 121     //  windowFont = wxTheFontList->FindOrCreateFont(11, wxSWISS, wxNORMAL, wxNORMAL);
 122
 123     if (parent) parent->AddChild(this);
 124
 125     if ( id == -1 )
 126         m_windowId = (int)NewControlId();
 127     else
 128         m_windowId = id;
 129
 130     int x = pos.x;
 131     int y = pos.y;
 132     int width = size.x;
 133     int height = size.y;
 134
 135     if (x < 0)
 136         x = wxDIALOG_DEFAULT_X;
 137     if (y < 0)
 138         y = wxDIALOG_DEFAULT_Y;
 139
 140     m_windowStyle = style;
 141
 142     m_isShown = FALSE;
 143
 144     if (width < 0)
 145         width = wxDIALOG_DEFAULT_WIDTH;
 146     if (height < 0)
 147         height = wxDIALOG_DEFAULT_HEIGHT;
 148
 149     // All dialogs should really have this style
 150     m_windowStyle |= wxTAB_TRAVERSAL;
 151
 152     WXDWORD extendedStyle = MakeExtendedStyle(m_windowStyle);
 153     if (m_windowStyle & wxSTAY_ON_TOP)
 154         extendedStyle |= WS_EX_TOPMOST;
 155
 156     // Allows creation of dialogs with & without captions under MSWindows,
 157     // resizeable or not (but a resizeable dialog always has caption -
 158     // otherwise it would look too strange)
 159     const wxChar *dlg;
 160     if ( style & wxRESIZE_BORDER )
 161         dlg = wxT("wxResizeableDialog");
 162     else if ( style & wxCAPTION )
 163         dlg = wxT("wxCaptionDialog");
 164     else
 165         dlg = wxT("wxNoCaptionDialog");
 166     MSWCreate(m_windowId, parent, NULL, this, NULL,
 167               x, y, width, height,
 168               0, // style is not used if we have dlg template
 169               dlg,
 170               extendedStyle);
 171
 172     HWND hwnd = (HWND)GetHWND();
 173
 174     if ( !hwnd )
 175     {
 176         wxFAIL_MSG(_("Failed to create dialog. You probably forgot to include wx/msw/wx.rc in your resources."));
 177
 178         return FALSE;
 179     }
 180
 181     SubclassWin(GetHWND());
 182
 183     SetWindowText(hwnd, title);
 184     SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
 185
 186     return TRUE;
 187 }
 188
 189 void wxDialog::SetModal(bool flag)
 190 {
 191     if ( flag )
 192     {
 193         m_windowStyle |= wxDIALOG_MODAL;
 194
 195         wxModelessWindows.DeleteObject(this);
 196     }
 197     else
 198     {
 199         m_windowStyle &= ~wxDIALOG_MODAL;
 200
 201         wxModelessWindows.Append(this);
 202     }
 203 }
 204
 205 wxDialog::~wxDialog()
 206 {
 207     m_isBeingDeleted = TRUE;
 208
 209     wxTopLevelWindows.DeleteObject(this);
 210
 211     // this will call BringWindowToTop() if necessary to bring back our parent
 212     // window to top
 213     Show(FALSE);
 214
 215     if ( !IsModal() )
 216         wxModelessWindows.DeleteObject(this);
 217
 218     // If this is the last top-level window, exit.
 219     if ( wxTheApp && (wxTopLevelWindows.Number() == 0) )
 220     {
 221         wxTheApp->SetTopWindow(NULL);
 222
 223         if ( wxTheApp->GetExitOnFrameDelete() )
 224         {
 225             ::PostQuitMessage(0);
 226         }
 227     }
 228 }
 229
 230 // ----------------------------------------------------------------------------
 231 // kbd handling
 232 // ----------------------------------------------------------------------------
 233
 234 // By default, pressing escape cancels the dialog
 235 void wxDialog::OnCharHook(wxKeyEvent& event)
 236 {
 237     if (GetHWND())
 238     {
 239         // "Esc" works as an accelerator for the "Cancel" button, but it
 240         // shouldn't close the dialog which doesn't have any cancel button
 241         if ( (event.m_keyCode == WXK_ESCAPE) && FindWindow(wxID_CANCEL) )
 242         {
 243             wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 244             cancelEvent.SetEventObject( this );
 245             GetEventHandler()->ProcessEvent(cancelEvent);
 246
 247             // ensure that there is another message for this window so the
 248             // ShowModal loop will exit and won't get stuck in GetMessage().
 249             ::PostMessage(GetHwnd(), WM_NULL, 0, 0);
 250
 251             return;
 252         }
 253     }
 254
 255     // We didn't process this event.
 256     event.Skip();
 257 }
 258
 259 // ----------------------------------------------------------------------------
 260 // Windows dialog boxes can't be iconized
 261 // ----------------------------------------------------------------------------
 262
 263 void wxDialog::Iconize(bool WXUNUSED(iconize))
 264 {
 265 }
 266
 267 bool wxDialog::IsIconized() const
 268 {
 269     return FALSE;
 270 }
 271
 272 // ----------------------------------------------------------------------------
 273 // size/position handling
 274 // ----------------------------------------------------------------------------
 275
 276 void wxDialog::DoSetClientSize(int width, int height)
 277 {
 278     HWND hWnd = (HWND) GetHWND();
 279     RECT rect;
 280     ::GetClientRect(hWnd, &rect);
 281
 282     RECT rect2;
 283     GetWindowRect(hWnd, &rect2);
 284
 285     // Find the difference between the entire window (title bar and all)
 286     // and the client area; add this to the new client size to move the
 287     // window
 288     int actual_width = rect2.right - rect2.left - rect.right + width;
 289     int actual_height = rect2.bottom - rect2.top - rect.bottom + height;
 290
 291     MoveWindow(hWnd, rect2.left, rect2.top, actual_width, actual_height, TRUE);
 292
 293     wxSizeEvent event(wxSize(actual_width, actual_height), m_windowId);
 294     event.SetEventObject( this );
 295     GetEventHandler()->ProcessEvent(event);
 296 }
 297
 298 void wxDialog::DoGetPosition(int *x, int *y) const
 299 {
 300     RECT rect;
 301     GetWindowRect(GetHwnd(), &rect);
 302
 303     if ( x )
 304         *x = rect.left;
 305     if ( y )
 306         *y = rect.top;
 307 }
 308
 309 // ----------------------------------------------------------------------------
 310 // showing the dialogs
 311 // ----------------------------------------------------------------------------
 312
 313 bool wxDialog::IsModal() const
 314 {
 315     return (GetWindowStyleFlag() & wxDIALOG_MODAL) != 0;
 316 }
 317
 318 bool wxDialog::IsModalShowing() const
 319 {
 320     return wxModalDialogs.Find((wxDialog *)this) != NULL; // const_cast
 321 }
 322
 323 void wxDialog::DoShowModal()
 324 {
 325     wxCHECK_RET( !IsModalShowing(), _T("DoShowModal() called twice") );
 326     wxCHECK_RET( IsModal(), _T("can't DoShowModal() modeless dialog") );
 327
 328     wxModalDialogs.Append(this);
 329
 330     wxWindow *parent = GetParent();
 331
 332     wxWindow* oldFocus = m_oldFocus;
 333
 334     // We have to remember the HWND because we need to check
 335     // the HWND still exists (oldFocus can be garbage when the dialog
 336     // exits, if it has been destroyed)
 337     HWND hwndOldFocus = 0;
 338     if (oldFocus)
 339         hwndOldFocus = (HWND) oldFocus->GetHWND();
 340
 341     // inside this block, all app windows are disabled
 342     {
 343         wxWindowDisabler wd(this);
 344
 345         // remember where the focus was
 346         if ( !oldFocus )
 347         {
 348             oldFocus = parent;
 349             if (parent)
 350                 hwndOldFocus = (HWND) parent->GetHWND();
 351         }
 352
 353         // enter the modal loop
 354         while ( IsModalShowing() )
 355         {
 356 #if wxUSE_THREADS
 357             wxMutexGuiLeaveOrEnter();
 358 #endif // wxUSE_THREADS
 359
 360             while ( !wxTheApp->Pending() && wxTheApp->ProcessIdle() )
 361                 ;
 362
 363             // a message came or no more idle processing to do
 364             wxTheApp->DoMessage();
 365         }
 366     }
 367
 368 #ifdef __WIN32__
 369     if ( parent )
 370         ::SetActiveWindow(GetHwndOf(parent));
 371 #endif // __WIN32__
 372
 373     // and restore focus
 374     // Note that this code MUST NOT access the dialog object's data
 375     // in case the object has been deleted (which will be the case
 376     // for a modal dialog that has been destroyed before calling EndModal).
 377     if ( oldFocus && (oldFocus != this) && ::IsWindow(hwndOldFocus))
 378     {
 379         // This is likely to prove that the object still exists
 380         if (wxFindWinFromHandle((WXHWND) hwndOldFocus) == oldFocus)
 381             oldFocus->SetFocus();
 382     }
 383 }
 384
 385 bool wxDialog::Show(bool show)
 386 {
 387     // The following is required when the parent has been disabled, (modal
 388     // dialogs, or modeless dialogs with disabling such as wxProgressDialog).
 389     // Otherwise the parent disappears behind other windows when the dialog is
 390     // hidden.
 391     if ( !show )
 392     {
 393         wxWindow *parent = GetParent();
 394         if ( parent )
 395         {
 396             ::BringWindowToTop(GetHwndOf(parent));
 397         }
 398     }
 399
 400     // ShowModal() may be called for already shown dialog
 401     if ( !wxDialogBase::Show(show) && !(show && IsModal()) )
 402     {
 403         // nothing to do
 404         return FALSE;
 405     }
 406
 407     if ( show )
 408     {
 409         // usually will result in TransferDataToWindow() being called
 410         InitDialog();
 411     }
 412
 413     if ( IsModal() )
 414     {
 415         if ( show )
 416         {
 417             // modal dialog needs a parent window, so try to find one
 418             if ( !GetParent() )
 419             {
 420                 wxWindow *parent = wxTheApp->GetTopWindow();
 421                 if ( parent && parent != this && parent->IsShown() )
 422                 {
 423                     // use it
 424                     m_parent = parent;
 425                 }
 426             }
 427
 428             DoShowModal();
 429         }
 430         else // end of modal dialog
 431         {
 432             // this will cause IsModalShowing() return FALSE and our local
 433             // message loop will terminate
 434             wxModalDialogs.DeleteObject(this);
 435         }
 436     }
 437
 438     return TRUE;
 439 }
 440
 441 // a special version for Show(TRUE) for modal dialogs which returns return code
 442 int wxDialog::ShowModal()
 443 {
 444     if ( !IsModal() )
 445     {
 446         SetModal(TRUE);
 447     }
 448
 449     Show(TRUE);
 450
 451     return GetReturnCode();
 452 }
 453
 454 // NB: this function (surprizingly) may be called for both modal and modeless
 455 //     dialogs and should work for both of them
 456 void wxDialog::EndModal(int retCode)
 457 {
 458     SetReturnCode(retCode);
 459
 460     Show(FALSE);
 461 }
 462
 463 // ----------------------------------------------------------------------------
 464 // wxWin event handlers
 465 // ----------------------------------------------------------------------------
 466
 467 // Standard buttons
 468 void wxDialog::OnOK(wxCommandEvent& event)
 469 {
 470   if ( Validate() && TransferDataFromWindow() )
 471   {
 472       EndModal(wxID_OK);
 473   }
 474 }
 475
 476 void wxDialog::OnApply(wxCommandEvent& event)
 477 {
 478     if ( Validate() )
 479         TransferDataFromWindow();
 480
 481     // TODO probably need to disable the Apply button until things change again
 482 }
 483
 484 void wxDialog::OnCancel(wxCommandEvent& event)
 485 {
 486     EndModal(wxID_CANCEL);
 487 }
 488
 489 void wxDialog::OnCloseWindow(wxCloseEvent& event)
 490 {
 491     // We'll send a Cancel message by default, which may close the dialog.
 492     // Check for looping if the Cancel event handler calls Close().
 493
 494     // Note that if a cancel button and handler aren't present in the dialog,
 495     // nothing will happen when you close the dialog via the window manager, or
 496     // via Close(). We wouldn't want to destroy the dialog by default, since
 497     // the dialog may have been created on the stack. However, this does mean
 498     // that calling dialog->Close() won't delete the dialog unless the handler
 499     // for wxID_CANCEL does so. So use Destroy() if you want to be sure to
 500     // destroy the dialog. The default OnCancel (above) simply ends a modal
 501     // dialog, and hides a modeless dialog.
 502
 503     // VZ: this is horrible and MT-unsafe. Can't we reuse some of these global
 504     //     lists here? don't dare to change it now, but should be done later!
 505     static wxList closing;
 506
 507     if ( closing.Member(this) )
 508         return;
 509
 510     closing.Append(this);
 511
 512     wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 513     cancelEvent.SetEventObject( this );
 514     GetEventHandler()->ProcessEvent(cancelEvent); // This may close the dialog
 515
 516     closing.DeleteObject(this);
 517 }
 518
 519 // Destroy the window (delayed, if a managed window)
 520 bool wxDialog::Destroy()
 521 {
 522     wxCHECK_MSG( !wxPendingDelete.Member(this), FALSE,
 523                  _T("wxDialog destroyed twice") );
 524
 525     wxPendingDelete.Append(this);
 526
 527     return TRUE;
 528 }
 529
 530 void wxDialog::OnSysColourChanged(wxSysColourChangedEvent& event)
 531 {
 532 #if wxUSE_CTL3D
 533     Ctl3dColorChange();
 534 #else
 535     SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
 536     Refresh();
 537 #endif
 538 }
 539
 540 // ---------------------------------------------------------------------------
 541 // dialog window proc
 542 // ---------------------------------------------------------------------------
 543
 544 long wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 545 {
 546     long rc = 0;
 547     bool processed = FALSE;
 548
 549     switch ( message )
 550     {
 551         case WM_ACTIVATE:
 552             switch ( LOWORD(wParam) )
 553             {
 554                 case WA_ACTIVE:
 555                 case WA_CLICKACTIVE:
 556                     if ( IsModalShowing() && GetParent() )
 557                     {
 558                         // bring the owner window to top as the standard dialog
 559                         // boxes do
 560                         if ( !::SetWindowPos
 561                                 (
 562                                     GetHwndOf(GetParent()),
 563                                     GetHwnd(),
 564                                     0, 0,
 565                                     0, 0,
 566                                     SWP_NOACTIVATE |
 567                                     SWP_NOMOVE |
 568                                     SWP_NOSIZE
 569                                 ) )
 570                         {
 571                             wxLogLastError(wxT("SetWindowPos(SWP_NOACTIVATE)"));
 572                         }
 573                     }
 574                     // fall through to process it normally as well
 575             }
 576             break;
 577
 578         case WM_CLOSE:
 579             // if we can't close, tell the system that we processed the
 580             // message - otherwise it would close us
 581             processed = !Close();
 582             break;
 583
 584         case WM_SETCURSOR:
 585             // we want to override the busy cursor for modal dialogs:
 586             // typically, wxBeginBusyCursor() is called and then a modal dialog
 587             // is shown, but the modal dialog shouldn't have hourglass cursor
 588             if ( IsModalShowing() && wxIsBusy() )
 589             {
 590                 // set our cursor for all windows (but see below)
 591                 wxCursor cursor = m_cursor;
 592                 if ( !cursor.Ok() )
 593                     cursor = wxCURSOR_ARROW;
 594
 595                 ::SetCursor(GetHcursorOf(cursor));
 596
 597                 // in any case, stop here and don't let wxWindow process this
 598                 // message (it would set the busy cursor)
 599                 processed = TRUE;
 600
 601                 // but return FALSE to tell the child window (if the event
 602                 // comes from one of them and not from ourselves) that it can
 603                 // set its own cursor if it has one: thus, standard controls
 604                 // (e.g. text ctrl) still have correct cursors in a dialog
 605                 // invoked while wxIsBusy()
 606                 rc = FALSE;
 607             }
 608             break;
 609     }
 610
 611     if ( !processed )
 612         rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 613
 614     return rc;
 615 }
 616
 617 #if wxUSE_CTL3D
 618
 619 // Define for each class of dialog and control
 620 WXHBRUSH wxDialog::OnCtlColor(WXHDC WXUNUSED(pDC),
 621                               WXHWND WXUNUSED(pWnd),
 622                               WXUINT WXUNUSED(nCtlColor),
 623                               WXUINT message,
 624                               WXWPARAM wParam,
 625                               WXLPARAM lParam)
 626 {
 627     return (WXHBRUSH)Ctl3dCtlColorEx(message, wParam, lParam);
 628 }
 629
 630 #endif // wxUSE_CTL3D
 631