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/utils.h"
  31     #include "wx/frame.h"
  32     #include "wx/app.h"
  33     #include "wx/button.h"
  34     #include "wx/settings.h"
  35     #include "wx/intl.h"
  36     #include "wx/log.h"
  37     #include "wx/toolbar.h"
  38 #endif
  39
  40 #include "wx/msw/private.h"
  41 #include "wx/evtloop.h"
  42 #include "wx/ptr_scpd.h"
  43
  44 #include "wx/msw/wrapcdlg.h"
  45
  46 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
  47     #include "wx/msw/wince/resources.h"
  48 #endif // __SMARTPHONE__ && __WXWINCE__
  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 #if WXWIN_COMPATIBILITY_2_6
  84     wxFLAGS_MEMBER(wxTHICK_FRAME)
  85 #endif // WXWIN_COMPATIBILITY_2_6
  86     wxFLAGS_MEMBER(wxSYSTEM_MENU)
  87     wxFLAGS_MEMBER(wxRESIZE_BORDER)
  88 #if WXWIN_COMPATIBILITY_2_6
  89     wxFLAGS_MEMBER(wxRESIZE_BOX)
  90 #endif // WXWIN_COMPATIBILITY_2_6
  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 // ----------------------------------------------------------------------------
 113 // wxDialogModalData
 114 // ----------------------------------------------------------------------------
 115
 116 // this is simply a container for any data we need to implement modality which
 117 // allows us to avoid changing wxDialog each time the implementation changes
 118 class wxDialogModalData
 119 {
 120 public:
 121     wxDialogModalData(wxDialog *dialog) : m_evtLoop(dialog) { }
 122
 123     void RunLoop()
 124     {
 125         m_evtLoop.Run();
 126     }
 127
 128     void ExitLoop()
 129     {
 130         m_evtLoop.Exit();
 131     }
 132
 133 private:
 134     wxModalEventLoop m_evtLoop;
 135 };
 136
 137 wxDEFINE_TIED_SCOPED_PTR_TYPE(wxDialogModalData)
 138
 139 // ============================================================================
 140 // implementation
 141 // ============================================================================
 142
 143 // ----------------------------------------------------------------------------
 144 // wxDialog construction
 145 // ----------------------------------------------------------------------------
 146
 147 void wxDialog::Init()
 148 {
 149     m_oldFocus = (wxWindow *)NULL;
 150     m_isShown = false;
 151     m_modalData = NULL;
 152     m_endModalCalled = false;
 153 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 154     m_dialogToolBar = NULL;
 155 #endif
 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     return true;
 188 }
 189
 190 #if WXWIN_COMPATIBILITY_2_6
 191
 192 // deprecated ctor
 193 wxDialog::wxDialog(wxWindow *parent,
 194                    const wxString& title,
 195                    bool WXUNUSED(modal),
 196                    int x,
 197                    int y,
 198                    int w,
 199                    int h,
 200                    long style,
 201                    const wxString& name)
 202 {
 203     Init();
 204
 205     Create(parent, wxID_ANY, title, wxPoint(x, y), wxSize(w, h), style, name);
 206 }
 207
 208 void wxDialog::SetModal(bool WXUNUSED(flag))
 209 {
 210     // nothing to do, obsolete method
 211 }
 212
 213 #endif // WXWIN_COMPATIBILITY_2_6
 214
 215 wxDialog::~wxDialog()
 216 {
 217     m_isBeingDeleted = true;
 218
 219     // this will also reenable all the other windows for a modal dialog
 220     Show(false);
 221 }
 222
 223 // ----------------------------------------------------------------------------
 224 // showing the dialogs
 225 // ----------------------------------------------------------------------------
 226
 227 #if WXWIN_COMPATIBILITY_2_6
 228
 229 bool wxDialog::IsModalShowing() const
 230 {
 231     return IsModal();
 232 }
 233
 234 #endif // WXWIN_COMPATIBILITY_2_6
 235
 236 wxWindow *wxDialog::FindSuitableParent() const
 237 {
 238     // first try to use the currently active window
 239     HWND hwndFg = ::GetForegroundWindow();
 240     wxWindow *parent = hwndFg ? wxFindWinFromHandle((WXHWND)hwndFg)
 241                               : NULL;
 242     if ( !parent )
 243     {
 244         // next try the main app window
 245         parent = wxTheApp->GetTopWindow();
 246     }
 247
 248     // finally, check if the parent we found is really suitable
 249     if ( !parent || parent == (wxWindow *)this || !parent->IsShown() )
 250     {
 251         // don't use this one
 252         parent = NULL;
 253     }
 254
 255     return parent;
 256 }
 257
 258 bool wxDialog::Show(bool show)
 259 {
 260     if ( show == IsShown() )
 261         return false;
 262
 263     if ( !show && m_modalData )
 264     {
 265         // we need to do this before calling wxDialogBase version because if we
 266         // had disabled other app windows, they must be reenabled right now as
 267         // if they stay disabled Windows will activate another window (one
 268         // which is enabled, anyhow) when we're hidden in the base class Show()
 269         // and we will lose activation
 270         m_modalData->ExitLoop();
 271     }
 272
 273     if ( show )
 274     {
 275         // this usually will result in TransferDataToWindow() being called
 276         // which will change the controls values so do it before showing as
 277         // otherwise we could have some flicker
 278         InitDialog();
 279     }
 280
 281     wxDialogBase::Show(show);
 282
 283     if ( show )
 284     {
 285         // dialogs don't get WM_SIZE message after creation unlike most (all?)
 286         // other windows and so could start their life non laid out correctly
 287         // if we didn't call Layout() from here
 288         //
 289         // NB: normally we should call it just the first time but doing it
 290         //     every time is simpler than keeping a flag
 291         Layout();
 292     }
 293
 294     return true;
 295 }
 296
 297 void wxDialog::Raise()
 298 {
 299     ::SetForegroundWindow(GetHwnd());
 300 }
 301
 302 // show dialog modally
 303 int wxDialog::ShowModal()
 304 {
 305     wxASSERT_MSG( !IsModal(), _T("wxDialog::ShowModal() reentered?") );
 306
 307     m_endModalCalled = false;
 308
 309     Show();
 310
 311     // EndModal may have been called from InitDialog handler (called from
 312     // inside Show()), which would cause an infinite loop if we didn't take it
 313     // into account
 314     if ( !m_endModalCalled )
 315     {
 316         // modal dialog needs a parent window, so try to find one
 317         wxWindow *parent = GetParent();
 318         if ( !parent )
 319         {
 320             parent = FindSuitableParent();
 321         }
 322
 323         // remember where the focus was
 324         wxWindow *oldFocus = m_oldFocus;
 325         if ( !oldFocus )
 326         {
 327             // VZ: do we really want to do this?
 328             oldFocus = parent;
 329         }
 330
 331         // We have to remember the HWND because we need to check
 332         // the HWND still exists (oldFocus can be garbage when the dialog
 333         // exits, if it has been destroyed)
 334         HWND hwndOldFocus = oldFocus ? GetHwndOf(oldFocus) : NULL;
 335
 336
 337         // enter and run the modal loop
 338         {
 339             wxDialogModalDataTiedPtr modalData(&m_modalData,
 340                                                new wxDialogModalData(this));
 341             modalData->RunLoop();
 342         }
 343
 344
 345         // and restore focus
 346         // Note that this code MUST NOT access the dialog object's data
 347         // in case the object has been deleted (which will be the case
 348         // for a modal dialog that has been destroyed before calling EndModal).
 349         if ( oldFocus && (oldFocus != this) && ::IsWindow(hwndOldFocus))
 350         {
 351             // This is likely to prove that the object still exists
 352             if (wxFindWinFromHandle((WXHWND) hwndOldFocus) == oldFocus)
 353                 oldFocus->SetFocus();
 354         }
 355     }
 356
 357     return GetReturnCode();
 358 }
 359
 360 void wxDialog::EndModal(int retCode)
 361 {
 362     wxASSERT_MSG( IsModal(), _T("EndModal() called for non modal dialog") );
 363
 364     m_endModalCalled = true;
 365     SetReturnCode(retCode);
 366
 367     Hide();
 368 }
 369
 370 // ----------------------------------------------------------------------------
 371 // wxWin event handlers
 372 // ----------------------------------------------------------------------------
 373
 374 #ifdef __POCKETPC__
 375 // Responds to the OK button in a PocketPC titlebar. This
 376 // can be overridden, or you can change the id used for
 377 // sending the event, by calling SetAffirmativeId.
 378 bool wxDialog::DoOK()
 379 {
 380     const int idOk = GetAffirmativeId();
 381     if ( EmulateButtonClickIfPresent(idOk) )
 382         return true;
 383
 384     wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, GetAffirmativeId());
 385     event.SetEventObject(this);
 386
 387     return GetEventHandler()->ProcessEvent(event);
 388 }
 389 #endif // __POCKETPC__
 390
 391 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 392 // create main toolbar by calling OnCreateToolBar()
 393 wxToolBar* wxDialog::CreateToolBar(long style, wxWindowID winid, const wxString& name)
 394 {
 395     m_dialogToolBar = OnCreateToolBar(style, winid, name);
 396
 397     return m_dialogToolBar;
 398 }
 399
 400 // return a new toolbar
 401 wxToolBar *wxDialog::OnCreateToolBar(long style,
 402                                        wxWindowID winid,
 403                                        const wxString& name)
 404 {
 405     return new wxToolMenuBar(this, winid,
 406                          wxDefaultPosition, wxDefaultSize,
 407                          style, name);
 408 }
 409 #endif
 410
 411 // ---------------------------------------------------------------------------
 412 // dialog Windows messages processing
 413 // ---------------------------------------------------------------------------
 414
 415 WXLRESULT wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 416 {
 417     WXLRESULT rc = 0;
 418     bool processed = false;
 419
 420     switch ( message )
 421     {
 422 #ifdef __WXWINCE__
 423         // react to pressing the OK button in the title
 424         case WM_COMMAND:
 425         {
 426             switch ( LOWORD(wParam) )
 427             {
 428 #ifdef __POCKETPC__
 429                 case IDOK:
 430                     processed = DoOK();
 431                     if (!processed)
 432                         processed = !Close();
 433 #endif
 434 #ifdef __SMARTPHONE__
 435                 case IDM_LEFT:
 436                 case IDM_RIGHT:
 437                     processed = HandleCommand( LOWORD(wParam) , 0 , NULL );
 438                     break;
 439 #endif // __SMARTPHONE__
 440             }
 441             break;
 442         }
 443 #endif
 444         case WM_CLOSE:
 445             // if we can't close, tell the system that we processed the
 446             // message - otherwise it would close us
 447             processed = !Close();
 448             break;
 449
 450         case WM_SIZE:
 451             // the Windows dialogs unfortunately are not meant to be resizeable
 452             // at all and their standard class doesn't include CS_[VH]REDRAW
 453             // styles which means that the window is not refreshed properly
 454             // after the resize and no amount of WS_CLIPCHILDREN/SIBLINGS can
 455             // help with it - so we have to refresh it manually which certainly
 456             // creates flicker but at least doesn't show garbage on the screen
 457             rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 458             processed = true;
 459             if ( HasFlag(wxFULL_REPAINT_ON_RESIZE) )
 460             {
 461                 ::InvalidateRect(GetHwnd(), NULL, false /* erase bg */);
 462             }
 463             break;
 464
 465 #ifndef __WXMICROWIN__
 466         case WM_SETCURSOR:
 467             // we want to override the busy cursor for modal dialogs:
 468             // typically, wxBeginBusyCursor() is called and then a modal dialog
 469             // is shown, but the modal dialog shouldn't have hourglass cursor
 470             if ( IsModal() && wxIsBusy() )
 471             {
 472                 // set our cursor for all windows (but see below)
 473                 wxCursor cursor = m_cursor;
 474                 if ( !cursor.Ok() )
 475                     cursor = wxCURSOR_ARROW;
 476
 477                 ::SetCursor(GetHcursorOf(cursor));
 478
 479                 // in any case, stop here and don't let wxWindow process this
 480                 // message (it would set the busy cursor)
 481                 processed = true;
 482
 483                 // but return false to tell the child window (if the event
 484                 // comes from one of them and not from ourselves) that it can
 485                 // set its own cursor if it has one: thus, standard controls
 486                 // (e.g. text ctrl) still have correct cursors in a dialog
 487                 // invoked while wxIsBusy()
 488                 rc = false;
 489             }
 490             break;
 491 #endif // __WXMICROWIN__
 492     }
 493
 494     if ( !processed )
 495         rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 496
 497     return rc;
 498 }