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