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