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 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, wxTopLevelWindow)
  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::GetSystemColour(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     return TRUE;
 126 }
 127
 128 bool wxDialog::EnableCloseButton(bool enable)
 129 {
 130 #ifndef __WXMICROWIN__
 131     // get system (a.k.a. window) menu
 132     HMENU hmenu = ::GetSystemMenu(GetHwnd(), FALSE /* get it */);
 133     if ( !hmenu )
 134     {
 135         wxLogLastError(_T("GetSystemMenu"));
 136
 137         return FALSE;
 138     }
 139
 140     // enabling/disabling the close item from it also automatically
 141     // disables/enabling the close title bar button
 142     if ( !::EnableMenuItem(hmenu, SC_CLOSE,
 143                            MF_BYCOMMAND | (enable ? MF_ENABLED : MF_GRAYED)) )
 144     {
 145         wxLogLastError(_T("EnableMenuItem(SC_CLOSE)"));
 146
 147         return FALSE;
 148     }
 149
 150     // update appearance immediately
 151     if ( !::DrawMenuBar(GetHwnd()) )
 152     {
 153         wxLogLastError(_T("DrawMenuBar"));
 154     }
 155 #endif
 156
 157     return TRUE;
 158 }
 159
 160 void wxDialog::SetModal(bool flag)
 161 {
 162     if ( flag )
 163     {
 164         m_windowStyle |= wxDIALOG_MODAL;
 165
 166         wxModelessWindows.DeleteObject(this);
 167     }
 168     else
 169     {
 170         m_windowStyle &= ~wxDIALOG_MODAL;
 171
 172         wxModelessWindows.Append(this);
 173     }
 174 }
 175
 176 wxDialog::~wxDialog()
 177 {
 178     m_isBeingDeleted = TRUE;
 179
 180     // this will also reenable all the other windows for a modal dialog
 181     Show(FALSE);
 182 }
 183
 184 // ----------------------------------------------------------------------------
 185 // kbd handling
 186 // ----------------------------------------------------------------------------
 187
 188 // By default, pressing escape cancels the dialog
 189 void wxDialog::OnCharHook(wxKeyEvent& event)
 190 {
 191     if (GetHWND())
 192     {
 193         // "Esc" works as an accelerator for the "Cancel" button, but it
 194         // shouldn't close the dialog which doesn't have any cancel button
 195         if ( (event.m_keyCode == WXK_ESCAPE) && FindWindow(wxID_CANCEL) )
 196         {
 197             wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 198             cancelEvent.SetEventObject( this );
 199             GetEventHandler()->ProcessEvent(cancelEvent);
 200
 201             // ensure that there is another message for this window so the
 202             // ShowModal loop will exit and won't get stuck in GetMessage().
 203             ::PostMessage(GetHwnd(), WM_NULL, 0, 0);
 204
 205             return;
 206         }
 207     }
 208
 209     // We didn't process this event.
 210     event.Skip();
 211 }
 212
 213 // ----------------------------------------------------------------------------
 214 // showing the dialogs
 215 // ----------------------------------------------------------------------------
 216
 217 bool wxDialog::IsModal() const
 218 {
 219     return (GetWindowStyleFlag() & wxDIALOG_MODAL) != 0;
 220 }
 221
 222 bool wxDialog::IsModalShowing() const
 223 {
 224     return wxModalDialogs.Find((wxDialog *)this) != NULL; // const_cast
 225 }
 226
 227 void wxDialog::DoShowModal()
 228 {
 229     wxCHECK_RET( !IsModalShowing(), _T("DoShowModal() called twice") );
 230     wxCHECK_RET( IsModal(), _T("can't DoShowModal() modeless dialog") );
 231
 232     wxModalDialogs.Append(this);
 233
 234     wxWindow *parent = GetParent();
 235
 236     wxWindow* oldFocus = m_oldFocus;
 237
 238     // We have to remember the HWND because we need to check
 239     // the HWND still exists (oldFocus can be garbage when the dialog
 240     // exits, if it has been destroyed)
 241     HWND hwndOldFocus = 0;
 242     if (oldFocus)
 243         hwndOldFocus = (HWND) oldFocus->GetHWND();
 244
 245     // remember where the focus was
 246     if ( !oldFocus )
 247     {
 248         oldFocus = parent;
 249         if ( parent )
 250             hwndOldFocus = GetHwndOf(parent);
 251     }
 252
 253     // disable all other app windows
 254     wxASSERT_MSG( !m_windowDisabler, _T("disabling windows twice?") );
 255
 256     m_windowDisabler = new wxWindowDisabler(this);
 257
 258     // enter the modal loop
 259     while ( IsModalShowing() )
 260     {
 261 #if wxUSE_THREADS
 262         wxMutexGuiLeaveOrEnter();
 263 #endif // wxUSE_THREADS
 264
 265         while ( !wxTheApp->Pending() && wxTheApp->ProcessIdle() )
 266             ;
 267
 268         // a message came or no more idle processing to do
 269         wxTheApp->DoMessage();
 270     }
 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         // usually will result in TransferDataToWindow() being called
 308         InitDialog();
 309     }
 310
 311     if ( IsModal() )
 312     {
 313         if ( show )
 314         {
 315             // modal dialog needs a parent window, so try to find one
 316             if ( !GetParent() )
 317             {
 318                 wxWindow *parent = wxTheApp->GetTopWindow();
 319                 if ( parent && parent != this && parent->IsShown() )
 320                 {
 321                     // use it
 322                     m_parent = parent;
 323
 324                     // VZ: to make dialog behave properly we should reparent
 325                     //     the dialog for Windows as well - unfortunately,
 326                     //     following the docs for SetParent() results in this
 327                     //     code which plainly doesn't work
 328 #if 0
 329                     long dwStyle = ::GetWindowLong(GetHwnd(), GWL_STYLE);
 330                     dwStyle &= ~WS_POPUP;
 331                     dwStyle |= WS_CHILD;
 332                     ::SetWindowLong(GetHwnd(), GWL_STYLE, dwStyle);
 333                     ::SetParent(GetHwnd(), GetHwndOf(parent));
 334 #endif // 0
 335                 }
 336             }
 337
 338             DoShowModal();
 339         }
 340         else // end of modal dialog
 341         {
 342             // this will cause IsModalShowing() return FALSE and our local
 343             // message loop will terminate
 344             wxModalDialogs.DeleteObject(this);
 345         }
 346     }
 347
 348     return TRUE;
 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::GetSystemColour(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 #if 0 // now that we got owner window right it doesn't seem to be needed
 451         case WM_ACTIVATE:
 452             switch ( LOWORD(wParam) )
 453             {
 454                 case WA_ACTIVE:
 455                 case WA_CLICKACTIVE:
 456                     if ( IsModalShowing() && GetParent() )
 457                     {
 458                         // bring the owner window to top as the standard dialog
 459                         // boxes do
 460                         if ( !::SetWindowPos
 461                                 (
 462                                     GetHwndOf(GetParent()),
 463                                     GetHwnd(),
 464                                     0, 0,
 465                                     0, 0,
 466                                     SWP_NOACTIVATE |
 467                                     SWP_NOMOVE |
 468                                     SWP_NOSIZE
 469                                 ) )
 470                         {
 471                             wxLogLastError(wxT("SetWindowPos(SWP_NOACTIVATE)"));
 472                         }
 473                     }
 474                     // fall through to process it normally as well
 475             }
 476             break;
 477 #endif // 0
 478
 479         case WM_CLOSE:
 480             // if we can't close, tell the system that we processed the
 481             // message - otherwise it would close us
 482             processed = !Close();
 483             break;
 484
 485 #ifndef __WXMICROWIN__
 486         case WM_SETCURSOR:
 487             // we want to override the busy cursor for modal dialogs:
 488             // typically, wxBeginBusyCursor() is called and then a modal dialog
 489             // is shown, but the modal dialog shouldn't have hourglass cursor
 490             if ( IsModalShowing() && wxIsBusy() )
 491             {
 492                 // set our cursor for all windows (but see below)
 493                 wxCursor cursor = m_cursor;
 494                 if ( !cursor.Ok() )
 495                     cursor = wxCURSOR_ARROW;
 496
 497                 ::SetCursor(GetHcursorOf(cursor));
 498
 499                 // in any case, stop here and don't let wxWindow process this
 500                 // message (it would set the busy cursor)
 501                 processed = TRUE;
 502
 503                 // but return FALSE to tell the child window (if the event
 504                 // comes from one of them and not from ourselves) that it can
 505                 // set its own cursor if it has one: thus, standard controls
 506                 // (e.g. text ctrl) still have correct cursors in a dialog
 507                 // invoked while wxIsBusy()
 508                 rc = FALSE;
 509             }
 510             break;
 511 #endif // __WXMICROWIN__
 512     }
 513
 514     if ( !processed )
 515         rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 516
 517     return rc;
 518 }
 519
 520 #if wxUSE_CTL3D
 521
 522 // Define for each class of dialog and control
 523 WXHBRUSH wxDialog::OnCtlColor(WXHDC WXUNUSED(pDC),
 524                               WXHWND WXUNUSED(pWnd),
 525                               WXUINT WXUNUSED(nCtlColor),
 526                               WXUINT message,
 527                               WXWPARAM wParam,
 528                               WXLPARAM lParam)
 529 {
 530     return (WXHBRUSH)Ctl3dCtlColorEx(message, wParam, lParam);
 531 }
 532
 533 #endif // wxUSE_CTL3D
 534