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
   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 && !defined(__WXMICROWIN__)
  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 modal dialogs currently shown
  65 static wxWindowList wxModalDialogs;
  66
  67 // ----------------------------------------------------------------------------
  68 // wxWin macros
  69 // ----------------------------------------------------------------------------
  70
  71 IMPLEMENT_DYNAMIC_CLASS(wxDialog, wxTopLevelWindow)
  72
  73 BEGIN_EVENT_TABLE(wxDialog, wxDialogBase)
  74     EVT_BUTTON(wxID_OK, wxDialog::OnOK)
  75     EVT_BUTTON(wxID_APPLY, wxDialog::OnApply)
  76     EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)
  77
  78     EVT_CHAR_HOOK(wxDialog::OnCharHook)
  79
  80     EVT_SYS_COLOUR_CHANGED(wxDialog::OnSysColourChanged)
  81
  82     EVT_CLOSE(wxDialog::OnCloseWindow)
  83 END_EVENT_TABLE()
  84
  85 // ============================================================================
  86 // implementation
  87 // ============================================================================
  88
  89 // ----------------------------------------------------------------------------
  90 // wxDialog construction
  91 // ----------------------------------------------------------------------------
  92
  93 void wxDialog::Init()
  94 {
  95     m_oldFocus = (wxWindow *)NULL;
  96
  97     m_isShown = FALSE;
  98
  99     m_windowDisabler = (wxWindowDisabler *)NULL;
 100
 101     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
 102 }
 103
 104 bool wxDialog::Create(wxWindow *parent,
 105                       wxWindowID id,
 106                       const wxString& title,
 107                       const wxPoint& pos,
 108                       const wxSize& size,
 109                       long style,
 110                       const wxString& name)
 111 {
 112     Init();
 113
 114     SetExtraStyle(GetExtraStyle() | wxTOPLEVEL_EX_DIALOG);
 115
 116     // save focus before doing anything which can potentially change it
 117     m_oldFocus = FindFocus();
 118
 119     // All dialogs should really have this style
 120     style |= wxTAB_TRAVERSAL;
 121
 122     if ( !wxTopLevelWindow::Create(parent, id, title, pos, size, style, name) )
 123         return FALSE;
 124
 125     SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 126
 127     return TRUE;
 128 }
 129
 130 void wxDialog::SetModal(bool flag)
 131 {
 132     if ( flag )
 133     {
 134         m_windowStyle |= wxDIALOG_MODAL;
 135
 136         wxModelessWindows.DeleteObject(this);
 137     }
 138     else
 139     {
 140         m_windowStyle &= ~wxDIALOG_MODAL;
 141
 142         wxModelessWindows.Append(this);
 143     }
 144 }
 145
 146 wxDialog::~wxDialog()
 147 {
 148     m_isBeingDeleted = TRUE;
 149
 150     // this will also reenable all the other windows for a modal dialog
 151     Show(FALSE);
 152 }
 153
 154 // ----------------------------------------------------------------------------
 155 // kbd handling
 156 // ----------------------------------------------------------------------------
 157
 158 // By default, pressing escape cancels the dialog
 159 void wxDialog::OnCharHook(wxKeyEvent& event)
 160 {
 161     if (GetHWND())
 162     {
 163         // "Esc" works as an accelerator for the "Cancel" button, but it
 164         // shouldn't close the dialog which doesn't have any cancel button
 165         if ( (event.m_keyCode == WXK_ESCAPE) && FindWindow(wxID_CANCEL) )
 166         {
 167             wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 168             cancelEvent.SetEventObject( this );
 169             GetEventHandler()->ProcessEvent(cancelEvent);
 170
 171             // ensure that there is another message for this window so the
 172             // ShowModal loop will exit and won't get stuck in GetMessage().
 173             ::PostMessage(GetHwnd(), WM_NULL, 0, 0);
 174
 175             return;
 176         }
 177     }
 178
 179     // We didn't process this event.
 180     event.Skip();
 181 }
 182
 183 // ----------------------------------------------------------------------------
 184 // showing the dialogs
 185 // ----------------------------------------------------------------------------
 186
 187 bool wxDialog::IsModal() const
 188 {
 189     return (GetWindowStyleFlag() & wxDIALOG_MODAL) != 0;
 190 }
 191
 192 bool wxDialog::IsModalShowing() const
 193 {
 194     return wxModalDialogs.Find((wxDialog *)this); // const_cast
 195 }
 196
 197 wxWindow *wxDialog::FindSuitableParent() const
 198 {
 199     // first try to use the currently active window
 200     HWND hwndFg = ::GetForegroundWindow();
 201     wxWindow *parent = hwndFg ? wxFindWinFromHandle((WXHWND)hwndFg)
 202                               : NULL;
 203     if ( !parent )
 204     {
 205         // next try the main app window
 206         parent = wxTheApp->GetTopWindow();
 207     }
 208
 209     // finally, check if the parent we found is really suitable
 210     if ( !parent || parent == (wxWindow *)this || !parent->IsShown() )
 211     {
 212         // don't use this one
 213         parent = NULL;
 214     }
 215
 216     return parent;
 217 }
 218
 219 void wxDialog::DoShowModal()
 220 {
 221     wxCHECK_RET( !IsModalShowing(), _T("DoShowModal() called twice") );
 222     wxCHECK_RET( IsModal(), _T("can't DoShowModal() modeless dialog") );
 223
 224     wxModalDialogs.Append(this);
 225
 226     wxWindow *parent = GetParent();
 227
 228     wxWindow* oldFocus = m_oldFocus;
 229
 230     // We have to remember the HWND because we need to check
 231     // the HWND still exists (oldFocus can be garbage when the dialog
 232     // exits, if it has been destroyed)
 233     HWND hwndOldFocus = 0;
 234     if (oldFocus)
 235         hwndOldFocus = (HWND) oldFocus->GetHWND();
 236
 237     // remember where the focus was
 238     if ( !oldFocus )
 239     {
 240         oldFocus = parent;
 241         if ( parent )
 242             hwndOldFocus = GetHwndOf(parent);
 243     }
 244
 245     // disable all other app windows
 246     wxASSERT_MSG( !m_windowDisabler, _T("disabling windows twice?") );
 247
 248     m_windowDisabler = new wxWindowDisabler(this);
 249
 250     // before entering the modal loop, reset the "is in OnIdle()" flag (see
 251     // comment in app.cpp)
 252     extern bool wxIsInOnIdleFlag;
 253     bool wasInOnIdle = wxIsInOnIdleFlag;
 254     wxIsInOnIdleFlag = FALSE;
 255
 256     // enter the modal loop
 257     while ( IsModalShowing() )
 258     {
 259 #if wxUSE_THREADS
 260         wxMutexGuiLeaveOrEnter();
 261 #endif // wxUSE_THREADS
 262
 263         while ( !wxTheApp->Pending() && wxTheApp->ProcessIdle() )
 264             ;
 265
 266         // a message came or no more idle processing to do
 267         wxTheApp->DoMessage();
 268     }
 269
 270     wxIsInOnIdleFlag = wasInOnIdle;
 271
 272     // and restore focus
 273     // Note that this code MUST NOT access the dialog object's data
 274     // in case the object has been deleted (which will be the case
 275     // for a modal dialog that has been destroyed before calling EndModal).
 276     if ( oldFocus && (oldFocus != this) && ::IsWindow(hwndOldFocus))
 277     {
 278         // This is likely to prove that the object still exists
 279         if (wxFindWinFromHandle((WXHWND) hwndOldFocus) == oldFocus)
 280             oldFocus->SetFocus();
 281     }
 282 }
 283
 284 bool wxDialog::Show(bool show)
 285 {
 286     if ( !show )
 287     {
 288         // if we had disabled other app windows, reenable them back now because
 289         // if they stay disabled Windows will activate another window (one
 290         // which is enabled, anyhow) and we will lose activation
 291         if ( m_windowDisabler )
 292         {
 293             delete m_windowDisabler;
 294             m_windowDisabler = NULL;
 295         }
 296     }
 297
 298     // ShowModal() may be called for already shown dialog
 299     if ( !wxDialogBase::Show(show) && !(show && IsModal()) )
 300     {
 301         // nothing to do
 302         return FALSE;
 303     }
 304
 305     if ( show )
 306     {
 307         // dialogs don't get WM_SIZE message after creation unlike most (all?)
 308         // other windows and so could start their life non laid out correctly
 309         // if we didn't call Layout() from here
 310         //
 311         // NB: normally we should call it just the first time but doing it
 312         //     every time is simpler than keeping a flag
 313         Layout();
 314
 315         // usually will result in TransferDataToWindow() being called
 316         InitDialog();
 317     }
 318
 319     if ( IsModal() )
 320     {
 321         if ( show )
 322         {
 323             // modal dialog needs a parent window, so try to find one
 324             if ( !GetParent() )
 325             {
 326                 m_parent = FindSuitableParent();
 327             }
 328
 329             DoShowModal();
 330         }
 331         else // end of modal dialog
 332         {
 333             // this will cause IsModalShowing() return FALSE and our local
 334             // message loop will terminate
 335             wxModalDialogs.DeleteObject(this);
 336
 337             // ensure that there is another message for this window so the
 338             // ShowModal loop will exit and won't get stuck in GetMessage().
 339             ::PostMessage(GetHwnd(), WM_NULL, 0, 0);
 340         }
 341     }
 342
 343     return TRUE;
 344 }
 345
 346 void wxDialog::Raise()
 347 {
 348     ::SetForegroundWindow(GetHwnd());
 349 }
 350
 351 // a special version for Show(TRUE) for modal dialogs which returns return code
 352 int wxDialog::ShowModal()
 353 {
 354     if ( !IsModal() )
 355     {
 356         SetModal(TRUE);
 357     }
 358
 359     Show(TRUE);
 360
 361     return GetReturnCode();
 362 }
 363
 364 // NB: this function (surprizingly) may be called for both modal and modeless
 365 //     dialogs and should work for both of them
 366 void wxDialog::EndModal(int retCode)
 367 {
 368     SetReturnCode(retCode);
 369
 370     Show(FALSE);
 371 }
 372
 373 // ----------------------------------------------------------------------------
 374 // wxWin event handlers
 375 // ----------------------------------------------------------------------------
 376
 377 // Standard buttons
 378 void wxDialog::OnOK(wxCommandEvent& WXUNUSED(event))
 379 {
 380   if ( Validate() && TransferDataFromWindow() )
 381   {
 382       EndModal(wxID_OK);
 383   }
 384 }
 385
 386 void wxDialog::OnApply(wxCommandEvent& WXUNUSED(event))
 387 {
 388     if ( Validate() )
 389         TransferDataFromWindow();
 390
 391     // TODO probably need to disable the Apply button until things change again
 392 }
 393
 394 void wxDialog::OnCancel(wxCommandEvent& WXUNUSED(event))
 395 {
 396     EndModal(wxID_CANCEL);
 397 }
 398
 399 void wxDialog::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 400 {
 401     // We'll send a Cancel message by default, which may close the dialog.
 402     // Check for looping if the Cancel event handler calls Close().
 403
 404     // Note that if a cancel button and handler aren't present in the dialog,
 405     // nothing will happen when you close the dialog via the window manager, or
 406     // via Close(). We wouldn't want to destroy the dialog by default, since
 407     // the dialog may have been created on the stack. However, this does mean
 408     // that calling dialog->Close() won't delete the dialog unless the handler
 409     // for wxID_CANCEL does so. So use Destroy() if you want to be sure to
 410     // destroy the dialog. The default OnCancel (above) simply ends a modal
 411     // dialog, and hides a modeless dialog.
 412
 413     // VZ: this is horrible and MT-unsafe. Can't we reuse some of these global
 414     //     lists here? don't dare to change it now, but should be done later!
 415     static wxList closing;
 416
 417     if ( closing.Member(this) )
 418         return;
 419
 420     closing.Append(this);
 421
 422     wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 423     cancelEvent.SetEventObject( this );
 424     GetEventHandler()->ProcessEvent(cancelEvent); // This may close the dialog
 425
 426     closing.DeleteObject(this);
 427 }
 428
 429 void wxDialog::OnSysColourChanged(wxSysColourChangedEvent& WXUNUSED(event))
 430 {
 431 #if wxUSE_CTL3D
 432     Ctl3dColorChange();
 433 #else
 434     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
 435     Refresh();
 436 #endif
 437 }
 438
 439 // ---------------------------------------------------------------------------
 440 // dialog window proc
 441 // ---------------------------------------------------------------------------
 442
 443 long wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 444 {
 445     long rc = 0;
 446     bool processed = FALSE;
 447
 448     switch ( message )
 449     {
 450         case WM_CLOSE:
 451             // if we can't close, tell the system that we processed the
 452             // message - otherwise it would close us
 453             processed = !Close();
 454             break;
 455
 456         case WM_SIZE:
 457             // the Windows dialogs unfortunately are not meant to be resizeable
 458             // at all and their standard class doesn't include CS_[VH]REDRAW
 459             // styles which means that the window is not refreshed properly
 460             // after the resize and no amount of WS_CLIPCHILDREN/SIBLINGS can
 461             // help with it - so we have to refresh it manually which certainly
 462             // creates flicker but at least doesn't show garbage on the screen
 463             rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 464             processed = TRUE;
 465             if ( !HasFlag(wxNO_FULL_REPAINT_ON_RESIZE) )
 466             {
 467                 ::InvalidateRect(GetHwnd(), NULL, FALSE /* erase bg */);
 468             }
 469             break;
 470
 471 #ifndef __WXMICROWIN__
 472         case WM_SETCURSOR:
 473             // we want to override the busy cursor for modal dialogs:
 474             // typically, wxBeginBusyCursor() is called and then a modal dialog
 475             // is shown, but the modal dialog shouldn't have hourglass cursor
 476             if ( IsModalShowing() && wxIsBusy() )
 477             {
 478                 // set our cursor for all windows (but see below)
 479                 wxCursor cursor = m_cursor;
 480                 if ( !cursor.Ok() )
 481                     cursor = wxCURSOR_ARROW;
 482
 483                 ::SetCursor(GetHcursorOf(cursor));
 484
 485                 // in any case, stop here and don't let wxWindow process this
 486                 // message (it would set the busy cursor)
 487                 processed = TRUE;
 488
 489                 // but return FALSE to tell the child window (if the event
 490                 // comes from one of them and not from ourselves) that it can
 491                 // set its own cursor if it has one: thus, standard controls
 492                 // (e.g. text ctrl) still have correct cursors in a dialog
 493                 // invoked while wxIsBusy()
 494                 rc = FALSE;
 495             }
 496             break;
 497 #endif // __WXMICROWIN__
 498     }
 499
 500     if ( !processed )
 501         rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 502
 503     return rc;
 504 }
 505
 506 #if wxUSE_CTL3D
 507
 508 // Define for each class of dialog and control
 509 WXHBRUSH wxDialog::OnCtlColor(WXHDC WXUNUSED(pDC),
 510                               WXHWND WXUNUSED(pWnd),
 511                               WXUINT WXUNUSED(nCtlColor),
 512                               WXUINT message,
 513                               WXWPARAM wParam,
 514                               WXLPARAM lParam)
 515 {
 516     return (WXHBRUSH)Ctl3dCtlColorEx(message, wParam, lParam);
 517 }
 518
 519 #endif // wxUSE_CTL3D
 520