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 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #include "wx/dialog.h"
  28
  29 #ifndef WX_PRECOMP
  30     #include "wx/msw/wrapcdlg.h"
  31     #include "wx/utils.h"
  32     #include "wx/frame.h"
  33     #include "wx/app.h"
  34     #include "wx/button.h"
  35     #include "wx/settings.h"
  36     #include "wx/intl.h"
  37     #include "wx/log.h"
  38     #include "wx/toolbar.h"
  39 #endif
  40
  41 #include "wx/msw/private.h"
  42 #include "wx/evtloop.h"
  43 #include "wx/ptr_scpd.h"
  44
  45 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
  46     #include "wx/msw/wince/resources.h"
  47 #endif // __SMARTPHONE__ && __WXWINCE__
  48
  49 // ----------------------------------------------------------------------------
  50 // wxWin macros
  51 // ----------------------------------------------------------------------------
  52
  53 #if wxUSE_EXTENDED_RTTI
  54 WX_DEFINE_FLAGS( wxDialogStyle )
  55
  56 wxBEGIN_FLAGS( wxDialogStyle )
  57     // new style border flags, we put them first to
  58     // use them for streaming out
  59     wxFLAGS_MEMBER(wxBORDER_SIMPLE)
  60     wxFLAGS_MEMBER(wxBORDER_SUNKEN)
  61     wxFLAGS_MEMBER(wxBORDER_DOUBLE)
  62     wxFLAGS_MEMBER(wxBORDER_RAISED)
  63     wxFLAGS_MEMBER(wxBORDER_STATIC)
  64     wxFLAGS_MEMBER(wxBORDER_NONE)
  65
  66     // old style border flags
  67     wxFLAGS_MEMBER(wxSIMPLE_BORDER)
  68     wxFLAGS_MEMBER(wxSUNKEN_BORDER)
  69     wxFLAGS_MEMBER(wxDOUBLE_BORDER)
  70     wxFLAGS_MEMBER(wxRAISED_BORDER)
  71     wxFLAGS_MEMBER(wxSTATIC_BORDER)
  72     wxFLAGS_MEMBER(wxNO_BORDER)
  73
  74     // standard window styles
  75     wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
  76     wxFLAGS_MEMBER(wxCLIP_CHILDREN)
  77
  78     // dialog styles
  79     wxFLAGS_MEMBER(wxWS_EX_VALIDATE_RECURSIVELY)
  80     wxFLAGS_MEMBER(wxSTAY_ON_TOP)
  81     wxFLAGS_MEMBER(wxCAPTION)
  82 #if WXWIN_COMPATIBILITY_2_6
  83     wxFLAGS_MEMBER(wxTHICK_FRAME)
  84 #endif // WXWIN_COMPATIBILITY_2_6
  85     wxFLAGS_MEMBER(wxSYSTEM_MENU)
  86     wxFLAGS_MEMBER(wxRESIZE_BORDER)
  87 #if WXWIN_COMPATIBILITY_2_6
  88     wxFLAGS_MEMBER(wxRESIZE_BOX)
  89 #endif // WXWIN_COMPATIBILITY_2_6
  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 , EMPTY_MACROVALUE , 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 // ----------------------------------------------------------------------------
 112 // wxDialogModalData
 113 // ----------------------------------------------------------------------------
 114
 115 // this is simply a container for any data we need to implement modality which
 116 // allows us to avoid changing wxDialog each time the implementation changes
 117 class wxDialogModalData
 118 {
 119 public:
 120     wxDialogModalData(wxDialog *dialog) : m_evtLoop(dialog) { }
 121
 122     void RunLoop()
 123     {
 124         m_evtLoop.Run();
 125     }
 126
 127     void ExitLoop()
 128     {
 129         m_evtLoop.Exit();
 130     }
 131
 132 private:
 133     wxModalEventLoop m_evtLoop;
 134 };
 135
 136 wxDEFINE_TIED_SCOPED_PTR_TYPE(wxDialogModalData)
 137
 138 // ============================================================================
 139 // implementation
 140 // ============================================================================
 141
 142 // ----------------------------------------------------------------------------
 143 // wxDialog construction
 144 // ----------------------------------------------------------------------------
 145
 146 void wxDialog::Init()
 147 {
 148     m_oldFocus = (wxWindow *)NULL;
 149     m_isShown = false;
 150     m_modalData = NULL;
 151     m_endModalCalled = false;
 152 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 153     m_dialogToolBar = NULL;
 154 #endif
 155     m_hGripper = 0;
 156 }
 157
 158 bool wxDialog::Create(wxWindow *parent,
 159                       wxWindowID id,
 160                       const wxString& title,
 161                       const wxPoint& pos,
 162                       const wxSize& size,
 163                       long style,
 164                       const wxString& name)
 165 {
 166     SetExtraStyle(GetExtraStyle() | wxTOPLEVEL_EX_DIALOG);
 167
 168     // save focus before doing anything which can potentially change it
 169     m_oldFocus = FindFocus();
 170
 171     // All dialogs should really have this style
 172     style |= wxTAB_TRAVERSAL;
 173
 174     if ( !wxTopLevelWindow::Create(parent, id, title, pos, size, style, name) )
 175         return false;
 176
 177     if ( !m_hasFont )
 178         SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 179
 180 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
 181     SetLeftMenu(wxID_OK, _("OK"));
 182 #endif
 183 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 184     CreateToolBar();
 185 #endif
 186
 187     if ( HasFlag(wxRESIZE_BORDER) )
 188         CreateGripper();
 189
 190     return true;
 191 }
 192
 193 wxDialog::~wxDialog()
 194 {
 195     m_isBeingDeleted = true;
 196
 197     // this will also reenable all the other windows for a modal dialog
 198     Show(false);
 199
 200     DestroyGripper();
 201 }
 202
 203 // ----------------------------------------------------------------------------
 204 // showing the dialogs
 205 // ----------------------------------------------------------------------------
 206
 207 wxWindow *wxDialog::FindSuitableParent() const
 208 {
 209     // first try to use the currently active window
 210     HWND hwndFg = ::GetForegroundWindow();
 211     wxWindow *parent = hwndFg ? wxFindWinFromHandle((WXHWND)hwndFg)
 212                               : NULL;
 213     if ( !parent )
 214     {
 215         // next try the main app window
 216         parent = wxTheApp->GetTopWindow();
 217     }
 218
 219     // finally, check if the parent we found is really suitable
 220     if ( !parent || parent == (wxWindow *)this || !parent->IsShown() )
 221     {
 222         // don't use this one
 223         parent = NULL;
 224     }
 225
 226     return parent;
 227 }
 228
 229 bool wxDialog::Show(bool show)
 230 {
 231     if ( show == IsShown() )
 232         return false;
 233
 234     if ( !show && m_modalData )
 235     {
 236         // we need to do this before calling wxDialogBase version because if we
 237         // had disabled other app windows, they must be reenabled right now as
 238         // if they stay disabled Windows will activate another window (one
 239         // which is enabled, anyhow) when we're hidden in the base class Show()
 240         // and we will lose activation
 241         m_modalData->ExitLoop();
 242     }
 243
 244     if ( show )
 245     {
 246         if (CanDoLayoutAdaptation())
 247             DoLayoutAdaptation();
 248
 249         // this usually will result in TransferDataToWindow() being called
 250         // which will change the controls values so do it before showing as
 251         // otherwise we could have some flicker
 252         InitDialog();
 253     }
 254
 255     wxDialogBase::Show(show);
 256
 257     if ( show )
 258     {
 259         // dialogs don't get WM_SIZE message from ::ShowWindow() for some
 260         // reason so generate it ourselves for consistency with frames and
 261         // dialogs in other ports
 262         //
 263         // NB: normally we should call it just the first time but doing it
 264         //     every time is simpler than keeping a flag
 265         const wxSize size = GetClientSize();
 266         ::SendMessage(GetHwnd(), WM_SIZE,
 267                       SIZE_RESTORED, MAKELPARAM(size.x, size.y));
 268     }
 269
 270     return true;
 271 }
 272
 273 void wxDialog::Raise()
 274 {
 275     ::SetForegroundWindow(GetHwnd());
 276 }
 277
 278 // show dialog modally
 279 int wxDialog::ShowModal()
 280 {
 281     wxASSERT_MSG( !IsModal(), _T("wxDialog::ShowModal() reentered?") );
 282
 283     m_endModalCalled = false;
 284
 285     Show();
 286
 287     // EndModal may have been called from InitDialog handler (called from
 288     // inside Show()), which would cause an infinite loop if we didn't take it
 289     // into account
 290     if ( !m_endModalCalled )
 291     {
 292         // modal dialog needs a parent window, so try to find one
 293         wxWindow *parent = GetParent();
 294         if ( !parent )
 295         {
 296             parent = FindSuitableParent();
 297         }
 298
 299         // remember where the focus was
 300         wxWindow *oldFocus = m_oldFocus;
 301         if ( !oldFocus )
 302         {
 303             // VZ: do we really want to do this?
 304             oldFocus = parent;
 305         }
 306
 307         // We have to remember the HWND because we need to check
 308         // the HWND still exists (oldFocus can be garbage when the dialog
 309         // exits, if it has been destroyed)
 310         HWND hwndOldFocus = oldFocus ? GetHwndOf(oldFocus) : NULL;
 311
 312
 313         // enter and run the modal loop
 314         {
 315             wxDialogModalDataTiedPtr modalData(&m_modalData,
 316                                                new wxDialogModalData(this));
 317             modalData->RunLoop();
 318         }
 319
 320
 321         // and restore focus
 322         // Note that this code MUST NOT access the dialog object's data
 323         // in case the object has been deleted (which will be the case
 324         // for a modal dialog that has been destroyed before calling EndModal).
 325         if ( oldFocus && (oldFocus != this) && ::IsWindow(hwndOldFocus))
 326         {
 327             // This is likely to prove that the object still exists
 328             if (wxFindWinFromHandle((WXHWND) hwndOldFocus) == oldFocus)
 329                 oldFocus->SetFocus();
 330         }
 331     }
 332
 333     return GetReturnCode();
 334 }
 335
 336 void wxDialog::EndModal(int retCode)
 337 {
 338     wxASSERT_MSG( IsModal(), _T("EndModal() called for non modal dialog") );
 339
 340     m_endModalCalled = true;
 341     SetReturnCode(retCode);
 342
 343     Hide();
 344 }
 345
 346 // ----------------------------------------------------------------------------
 347 // wxDialog gripper handling
 348 // ----------------------------------------------------------------------------
 349
 350 void wxDialog::SetWindowStyleFlag(long style)
 351 {
 352     wxDialogBase::SetWindowStyleFlag(style);
 353
 354     if ( HasFlag(wxRESIZE_BORDER) )
 355         CreateGripper();
 356     else
 357         DestroyGripper();
 358 }
 359
 360 void wxDialog::CreateGripper()
 361 {
 362     if ( !m_hGripper )
 363     {
 364         // just create it here, it will be positioned and shown later
 365         m_hGripper = (WXHWND)::CreateWindow
 366                                (
 367                                     wxT("SCROLLBAR"),
 368                                     wxT(""),
 369                                     WS_CHILD |
 370                                     WS_CLIPSIBLINGS |
 371                                     SBS_SIZEGRIP |
 372                                     SBS_SIZEBOX |
 373                                     SBS_SIZEBOXBOTTOMRIGHTALIGN,
 374                                     0, 0, 0, 0,
 375                                     GetHwnd(),
 376                                     0,
 377                                     wxGetInstance(),
 378                                     NULL
 379                                );
 380     }
 381 }
 382
 383 void wxDialog::DestroyGripper()
 384 {
 385     if ( m_hGripper )
 386     {
 387         ::DestroyWindow((HWND) m_hGripper);
 388         m_hGripper = 0;
 389     }
 390 }
 391
 392 void wxDialog::ShowGripper(bool show)
 393 {
 394     wxASSERT_MSG( m_hGripper, _T("shouldn't be called if we have no gripper") );
 395
 396     if ( show )
 397         ResizeGripper();
 398
 399     ::ShowWindow((HWND)m_hGripper, show ? SW_SHOW : SW_HIDE);
 400 }
 401
 402 void wxDialog::ResizeGripper()
 403 {
 404     wxASSERT_MSG( m_hGripper, _T("shouldn't be called if we have no gripper") );
 405
 406     HWND hwndGripper = (HWND)m_hGripper;
 407
 408     const wxRect rectGripper = wxRectFromRECT(wxGetWindowRect(hwndGripper));
 409     const wxSize size = GetClientSize() - rectGripper.GetSize();
 410
 411     ::SetWindowPos(hwndGripper, HWND_BOTTOM,
 412                    size.x, size.y,
 413                    rectGripper.width, rectGripper.height,
 414                    SWP_NOACTIVATE);
 415 }
 416
 417 // ----------------------------------------------------------------------------
 418 // wxWin event handlers
 419 // ----------------------------------------------------------------------------
 420
 421 #ifdef __POCKETPC__
 422 // Responds to the OK button in a PocketPC titlebar. This
 423 // can be overridden, or you can change the id used for
 424 // sending the event, by calling SetAffirmativeId.
 425 bool wxDialog::DoOK()
 426 {
 427     const int idOk = GetAffirmativeId();
 428     if ( EmulateButtonClickIfPresent(idOk) )
 429         return true;
 430
 431     wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, GetAffirmativeId());
 432     event.SetEventObject(this);
 433
 434     return HandleWindowEvent(event);
 435 }
 436 #endif // __POCKETPC__
 437
 438 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 439 // create main toolbar by calling OnCreateToolBar()
 440 wxToolBar* wxDialog::CreateToolBar(long style, wxWindowID winid, const wxString& name)
 441 {
 442     m_dialogToolBar = OnCreateToolBar(style, winid, name);
 443
 444     return m_dialogToolBar;
 445 }
 446
 447 // return a new toolbar
 448 wxToolBar *wxDialog::OnCreateToolBar(long style,
 449                                        wxWindowID winid,
 450                                        const wxString& name)
 451 {
 452     return new wxToolMenuBar(this, winid,
 453                          wxDefaultPosition, wxDefaultSize,
 454                          style, name);
 455 }
 456 #endif
 457
 458 // ---------------------------------------------------------------------------
 459 // dialog Windows messages processing
 460 // ---------------------------------------------------------------------------
 461
 462 WXLRESULT wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 463 {
 464     WXLRESULT rc = 0;
 465     bool processed = false;
 466
 467     switch ( message )
 468     {
 469 #ifdef __WXWINCE__
 470         // react to pressing the OK button in the title
 471         case WM_COMMAND:
 472         {
 473             switch ( LOWORD(wParam) )
 474             {
 475 #ifdef __POCKETPC__
 476                 case IDOK:
 477                     processed = DoOK();
 478                     if (!processed)
 479                         processed = !Close();
 480 #endif
 481 #ifdef __SMARTPHONE__
 482                 case IDM_LEFT:
 483                 case IDM_RIGHT:
 484                     processed = HandleCommand( LOWORD(wParam) , 0 , NULL );
 485                     break;
 486 #endif // __SMARTPHONE__
 487             }
 488             break;
 489         }
 490 #endif
 491         case WM_CLOSE:
 492             // if we can't close, tell the system that we processed the
 493             // message - otherwise it would close us
 494             processed = !Close();
 495             break;
 496
 497         case WM_SIZE:
 498             if ( m_hGripper )
 499             {
 500                 switch ( wParam )
 501                 {
 502                     case SIZE_MAXIMIZED:
 503                         ShowGripper(false);
 504                         break;
 505
 506                     case SIZE_RESTORED:
 507                         ShowGripper(true);
 508                 }
 509             }
 510
 511             // the Windows dialogs unfortunately are not meant to be resizeable
 512             // at all and their standard class doesn't include CS_[VH]REDRAW
 513             // styles which means that the window is not refreshed properly
 514             // after the resize and no amount of WS_CLIPCHILDREN/SIBLINGS can
 515             // help with it - so we have to refresh it manually which certainly
 516             // creates flicker but at least doesn't show garbage on the screen
 517             rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 518             processed = true;
 519             if ( HasFlag(wxFULL_REPAINT_ON_RESIZE) )
 520             {
 521                 ::InvalidateRect(GetHwnd(), NULL, false /* erase bg */);
 522             }
 523             break;
 524
 525 #ifndef __WXMICROWIN__
 526         case WM_SETCURSOR:
 527             // we want to override the busy cursor for modal dialogs:
 528             // typically, wxBeginBusyCursor() is called and then a modal dialog
 529             // is shown, but the modal dialog shouldn't have hourglass cursor
 530             if ( IsModal() && wxIsBusy() )
 531             {
 532                 // set our cursor for all windows (but see below)
 533                 wxCursor cursor = m_cursor;
 534                 if ( !cursor.Ok() )
 535                     cursor = wxCURSOR_ARROW;
 536
 537                 ::SetCursor(GetHcursorOf(cursor));
 538
 539                 // in any case, stop here and don't let wxWindow process this
 540                 // message (it would set the busy cursor)
 541                 processed = true;
 542
 543                 // but return false to tell the child window (if the event
 544                 // comes from one of them and not from ourselves) that it can
 545                 // set its own cursor if it has one: thus, standard controls
 546                 // (e.g. text ctrl) still have correct cursors in a dialog
 547                 // invoked while wxIsBusy()
 548                 rc = false;
 549             }
 550             break;
 551 #endif // __WXMICROWIN__
 552     }
 553
 554     if ( !processed )
 555         rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 556
 557     return rc;
 558 }