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