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