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(wxDIALOG_MODAL)
  81     wxFLAGS_MEMBER(wxDIALOG_MODELESS)
  82     wxFLAGS_MEMBER(wxNO_3D)
  83     wxFLAGS_MEMBER(wxWS_EX_VALIDATE_RECURSIVELY)
  84     wxFLAGS_MEMBER(wxSTAY_ON_TOP)
  85     wxFLAGS_MEMBER(wxCAPTION)
  86     wxFLAGS_MEMBER(wxTHICK_FRAME)
  87     wxFLAGS_MEMBER(wxSYSTEM_MENU)
  88     wxFLAGS_MEMBER(wxRESIZE_BORDER)
  89     wxFLAGS_MEMBER(wxRESIZE_BOX)
  90     wxFLAGS_MEMBER(wxCLOSE_BOX)
  91     wxFLAGS_MEMBER(wxMAXIMIZE_BOX)
  92     wxFLAGS_MEMBER(wxMINIMIZE_BOX)
  93 wxEND_FLAGS( wxDialogStyle )
  94
  95 IMPLEMENT_DYNAMIC_CLASS_XTI(wxDialog, wxTopLevelWindow,"wx/dialog.h")
  96
  97 wxBEGIN_PROPERTIES_TABLE(wxDialog)
  98     wxPROPERTY( Title,wxString, SetTitle, GetTitle, wxString() , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
  99     wxPROPERTY_FLAGS( WindowStyle , wxDialogStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
 100 wxEND_PROPERTIES_TABLE()
 101
 102 wxBEGIN_HANDLERS_TABLE(wxDialog)
 103 wxEND_HANDLERS_TABLE()
 104
 105 wxCONSTRUCTOR_6( wxDialog , wxWindow* , Parent , wxWindowID , Id , wxString , Title , wxPoint , Position , wxSize , Size , long , WindowStyle)
 106
 107 #else
 108 IMPLEMENT_DYNAMIC_CLASS(wxDialog, wxTopLevelWindow)
 109 #endif
 110
 111 BEGIN_EVENT_TABLE(wxDialog, wxDialogBase)
 112     EVT_BUTTON(wxID_OK, wxDialog::OnOK)
 113     EVT_BUTTON(wxID_APPLY, wxDialog::OnApply)
 114     EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)
 115
 116     EVT_SYS_COLOUR_CHANGED(wxDialog::OnSysColourChanged)
 117
 118     EVT_CLOSE(wxDialog::OnCloseWindow)
 119 END_EVENT_TABLE()
 120
 121 // ----------------------------------------------------------------------------
 122 // wxDialogModalData
 123 // ----------------------------------------------------------------------------
 124
 125 // this is simply a container for any data we need to implement modality which
 126 // allows us to avoid changing wxDialog each time the implementation changes
 127 class wxDialogModalData
 128 {
 129 public:
 130     wxDialogModalData(wxDialog *dialog) : m_evtLoop(dialog) { }
 131
 132     void RunLoop()
 133     {
 134         m_evtLoop.Run();
 135     }
 136
 137     void ExitLoop()
 138     {
 139         m_evtLoop.Exit();
 140     }
 141
 142 private:
 143     wxModalEventLoop m_evtLoop;
 144 };
 145
 146 wxDEFINE_TIED_SCOPED_PTR_TYPE(wxDialogModalData);
 147
 148 // ============================================================================
 149 // implementation
 150 // ============================================================================
 151
 152 // ----------------------------------------------------------------------------
 153 // wxDialog construction
 154 // ----------------------------------------------------------------------------
 155
 156 void wxDialog::Init()
 157 {
 158     m_oldFocus = (wxWindow *)NULL;
 159     m_isShown = FALSE;
 160     m_modalData = NULL;
 161     m_endModalCalled = FALSE;
 162 }
 163
 164 bool wxDialog::Create(wxWindow *parent,
 165                       wxWindowID id,
 166                       const wxString& title,
 167                       const wxPoint& pos,
 168                       const wxSize& size,
 169                       long style,
 170                       const wxString& name)
 171 {
 172     SetExtraStyle(GetExtraStyle() | wxTOPLEVEL_EX_DIALOG);
 173
 174     // save focus before doing anything which can potentially change it
 175     m_oldFocus = FindFocus();
 176
 177     // All dialogs should really have this style
 178     style |= wxTAB_TRAVERSAL;
 179
 180     if ( !wxTopLevelWindow::Create(parent, id, title, pos, size, style, name) )
 181         return FALSE;
 182
 183     if ( !m_hasFont )
 184         SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 185
 186     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
 187
 188     return TRUE;
 189 }
 190
 191 void wxDialog::SetModal(bool flag)
 192 {
 193     if ( flag )
 194     {
 195         m_windowStyle |= wxDIALOG_MODAL;
 196
 197         wxModelessWindows.DeleteObject(this);
 198     }
 199     else
 200     {
 201         m_windowStyle &= ~wxDIALOG_MODAL;
 202
 203         wxModelessWindows.Append(this);
 204     }
 205 }
 206
 207 wxDialog::~wxDialog()
 208 {
 209     m_isBeingDeleted = TRUE;
 210
 211     // this will also reenable all the other windows for a modal dialog
 212     Show(FALSE);
 213 }
 214
 215 // ----------------------------------------------------------------------------
 216 // showing the dialogs
 217 // ----------------------------------------------------------------------------
 218
 219 bool wxDialog::IsModal() const
 220 {
 221     return (GetWindowStyleFlag() & wxDIALOG_MODAL) != 0;
 222 }
 223
 224 bool wxDialog::IsModalShowing() const
 225 {
 226     return m_modalData != NULL;
 227 }
 228
 229 wxWindow *wxDialog::FindSuitableParent() const
 230 {
 231     // first try to use the currently active window
 232     HWND hwndFg = ::GetForegroundWindow();
 233     wxWindow *parent = hwndFg ? wxFindWinFromHandle((WXHWND)hwndFg)
 234                               : NULL;
 235     if ( !parent )
 236     {
 237         // next try the main app window
 238         parent = wxTheApp->GetTopWindow();
 239     }
 240
 241     // finally, check if the parent we found is really suitable
 242     if ( !parent || parent == (wxWindow *)this || !parent->IsShown() )
 243     {
 244         // don't use this one
 245         parent = NULL;
 246     }
 247
 248     return parent;
 249 }
 250
 251 void wxDialog::DoShowModal()
 252 {
 253     wxCHECK_RET( !IsModalShowing(), _T("DoShowModal() called twice") );
 254     wxCHECK_RET( IsModal(), _T("can't DoShowModal() modeless dialog") );
 255
 256     wxWindow *parent = GetParent();
 257
 258     wxWindow* oldFocus = m_oldFocus;
 259
 260     // We have to remember the HWND because we need to check
 261     // the HWND still exists (oldFocus can be garbage when the dialog
 262     // exits, if it has been destroyed)
 263     HWND hwndOldFocus = 0;
 264     if (oldFocus)
 265         hwndOldFocus = (HWND) oldFocus->GetHWND();
 266
 267     // remember where the focus was
 268     if ( !oldFocus )
 269     {
 270         oldFocus = parent;
 271         if ( parent )
 272             hwndOldFocus = GetHwndOf(parent);
 273     }
 274
 275     // enter the modal loop
 276     {
 277         wxDialogModalDataTiedPtr modalData(&m_modalData,
 278                                            new wxDialogModalData(this));
 279         modalData->RunLoop();
 280     }
 281
 282     // and restore focus
 283     // Note that this code MUST NOT access the dialog object's data
 284     // in case the object has been deleted (which will be the case
 285     // for a modal dialog that has been destroyed before calling EndModal).
 286     if ( oldFocus && (oldFocus != this) && ::IsWindow(hwndOldFocus))
 287     {
 288         // This is likely to prove that the object still exists
 289         if (wxFindWinFromHandle((WXHWND) hwndOldFocus) == oldFocus)
 290             oldFocus->SetFocus();
 291     }
 292 }
 293
 294 bool wxDialog::Show(bool show)
 295 {
 296     if ( !show && m_modalData )
 297     {
 298         // we need to do this before calling wxDialogBase version because if we
 299         // had disabled other app windows, they must be reenabled right now as
 300         // if they stay disabled Windows will activate another window (one
 301         // which is enabled, anyhow) when we're hidden in the base class Show()
 302         // and we will lose activation
 303         m_modalData->ExitLoop();
 304     }
 305
 306     // ShowModal() may be called for already shown dialog
 307     if ( !wxDialogBase::Show(show) && !(show && IsModal()) )
 308     {
 309         // nothing to do
 310         return FALSE;
 311     }
 312
 313     if ( show )
 314     {
 315         // dialogs don't get WM_SIZE message after creation unlike most (all?)
 316         // other windows and so could start their life non laid out correctly
 317         // if we didn't call Layout() from here
 318         //
 319         // NB: normally we should call it just the first time but doing it
 320         //     every time is simpler than keeping a flag
 321         Layout();
 322
 323         // this usually will result in TransferDataToWindow() being called
 324         InitDialog();
 325     }
 326
 327     // EndModal may have been called from InitDialog handler,
 328     // which would cause an infinite loop if we didn't take it
 329     // into account
 330     if ( show && IsModal() && !m_endModalCalled )
 331     {
 332         // modal dialog needs a parent window, so try to find one
 333         if ( !GetParent() )
 334         {
 335             m_parent = FindSuitableParent();
 336         }
 337
 338         DoShowModal();
 339     }
 340
 341     return TRUE;
 342 }
 343
 344 void wxDialog::Raise()
 345 {
 346     ::SetForegroundWindow(GetHwnd());
 347 }
 348
 349 // a special version for Show(TRUE) for modal dialogs which returns return code
 350 int wxDialog::ShowModal()
 351 {
 352     m_endModalCalled = FALSE;
 353     if ( !IsModal() )
 354     {
 355         SetModal(TRUE);
 356     }
 357
 358     Show(TRUE);
 359
 360     return GetReturnCode();
 361 }
 362
 363 // NB: this function (surprizingly) may be called for both modal and modeless
 364 //     dialogs and should work for both of them
 365 void wxDialog::EndModal(int retCode)
 366 {
 367     m_endModalCalled = TRUE;
 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 WXLRESULT wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 444 {
 445     WXLRESULT 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(wxFULL_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