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