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