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 }
 156
 157 bool wxDialog::Create(wxWindow *parent,
 158                       wxWindowID id,
 159                       const wxString& title,
 160                       const wxPoint& pos,
 161                       const wxSize& size,
 162                       long style,
 163                       const wxString& name)
 164 {
 165     SetExtraStyle(GetExtraStyle() | wxTOPLEVEL_EX_DIALOG);
 166
 167     // save focus before doing anything which can potentially change it
 168     m_oldFocus = FindFocus();
 169
 170     // All dialogs should really have this style
 171     style |= wxTAB_TRAVERSAL;
 172
 173     if ( !wxTopLevelWindow::Create(parent, id, title, pos, size, style, name) )
 174         return false;
 175
 176     if ( !m_hasFont )
 177         SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 178
 179 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
 180     SetLeftMenu(wxID_OK, _("OK"));
 181 #endif
 182 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 183     CreateToolBar();
 184 #endif
 185
 186     return true;
 187 }
 188
 189 #if WXWIN_COMPATIBILITY_2_6
 190
 191 // deprecated ctor
 192 wxDialog::wxDialog(wxWindow *parent,
 193                    const wxString& title,
 194                    bool WXUNUSED(modal),
 195                    int x,
 196                    int y,
 197                    int w,
 198                    int h,
 199                    long style,
 200                    const wxString& name)
 201 {
 202     Init();
 203
 204     Create(parent, wxID_ANY, title, wxPoint(x, y), wxSize(w, h), style, name);
 205 }
 206
 207 void wxDialog::SetModal(bool WXUNUSED(flag))
 208 {
 209     // nothing to do, obsolete method
 210 }
 211
 212 #endif // WXWIN_COMPATIBILITY_2_6
 213
 214 wxDialog::~wxDialog()
 215 {
 216     m_isBeingDeleted = true;
 217
 218     // this will also reenable all the other windows for a modal dialog
 219     Show(false);
 220 }
 221
 222 // ----------------------------------------------------------------------------
 223 // showing the dialogs
 224 // ----------------------------------------------------------------------------
 225
 226 #if WXWIN_COMPATIBILITY_2_6
 227
 228 bool wxDialog::IsModalShowing() const
 229 {
 230     return IsModal();
 231 }
 232
 233 #endif // WXWIN_COMPATIBILITY_2_6
 234
 235 wxWindow *wxDialog::FindSuitableParent() const
 236 {
 237     // first try to use the currently active window
 238     HWND hwndFg = ::GetForegroundWindow();
 239     wxWindow *parent = hwndFg ? wxFindWinFromHandle((WXHWND)hwndFg)
 240                               : NULL;
 241     if ( !parent )
 242     {
 243         // next try the main app window
 244         parent = wxTheApp->GetTopWindow();
 245     }
 246
 247     // finally, check if the parent we found is really suitable
 248     if ( !parent || parent == (wxWindow *)this || !parent->IsShown() )
 249     {
 250         // don't use this one
 251         parent = NULL;
 252     }
 253
 254     return parent;
 255 }
 256
 257 bool wxDialog::Show(bool show)
 258 {
 259     if ( show == IsShown() )
 260         return false;
 261
 262     if ( !show && m_modalData )
 263     {
 264         // we need to do this before calling wxDialogBase version because if we
 265         // had disabled other app windows, they must be reenabled right now as
 266         // if they stay disabled Windows will activate another window (one
 267         // which is enabled, anyhow) when we're hidden in the base class Show()
 268         // and we will lose activation
 269         m_modalData->ExitLoop();
 270     }
 271
 272     if ( show )
 273     {
 274         // this usually will result in TransferDataToWindow() being called
 275         // which will change the controls values so do it before showing as
 276         // otherwise we could have some flicker
 277         InitDialog();
 278     }
 279
 280     wxDialogBase::Show(show);
 281
 282     if ( show )
 283     {
 284         // dialogs don't get WM_SIZE message after creation unlike most (all?)
 285         // other windows and so could start their life non laid out correctly
 286         // if we didn't call Layout() from here
 287         //
 288         // NB: normally we should call it just the first time but doing it
 289         //     every time is simpler than keeping a flag
 290         Layout();
 291     }
 292
 293     return true;
 294 }
 295
 296 void wxDialog::Raise()
 297 {
 298     ::SetForegroundWindow(GetHwnd());
 299 }
 300
 301 // show dialog modally
 302 int wxDialog::ShowModal()
 303 {
 304     wxASSERT_MSG( !IsModal(), _T("wxDialog::ShowModal() reentered?") );
 305
 306     m_endModalCalled = false;
 307
 308     Show();
 309
 310     // EndModal may have been called from InitDialog handler (called from
 311     // inside Show()), which would cause an infinite loop if we didn't take it
 312     // into account
 313     if ( !m_endModalCalled )
 314     {
 315         // modal dialog needs a parent window, so try to find one
 316         wxWindow *parent = GetParent();
 317         if ( !parent )
 318         {
 319             parent = FindSuitableParent();
 320         }
 321
 322         // remember where the focus was
 323         wxWindow *oldFocus = m_oldFocus;
 324         if ( !oldFocus )
 325         {
 326             // VZ: do we really want to do this?
 327             oldFocus = parent;
 328         }
 329
 330         // We have to remember the HWND because we need to check
 331         // the HWND still exists (oldFocus can be garbage when the dialog
 332         // exits, if it has been destroyed)
 333         HWND hwndOldFocus = oldFocus ? GetHwndOf(oldFocus) : NULL;
 334
 335
 336         // enter and run the modal loop
 337         {
 338             wxDialogModalDataTiedPtr modalData(&m_modalData,
 339                                                new wxDialogModalData(this));
 340             modalData->RunLoop();
 341         }
 342
 343
 344         // and restore focus
 345         // Note that this code MUST NOT access the dialog object's data
 346         // in case the object has been deleted (which will be the case
 347         // for a modal dialog that has been destroyed before calling EndModal).
 348         if ( oldFocus && (oldFocus != this) && ::IsWindow(hwndOldFocus))
 349         {
 350             // This is likely to prove that the object still exists
 351             if (wxFindWinFromHandle((WXHWND) hwndOldFocus) == oldFocus)
 352                 oldFocus->SetFocus();
 353         }
 354     }
 355
 356     return GetReturnCode();
 357 }
 358
 359 void wxDialog::EndModal(int retCode)
 360 {
 361     wxASSERT_MSG( IsModal(), _T("EndModal() called for non modal dialog") );
 362
 363     m_endModalCalled = true;
 364     SetReturnCode(retCode);
 365
 366     Hide();
 367 }
 368
 369 // ----------------------------------------------------------------------------
 370 // wxWin event handlers
 371 // ----------------------------------------------------------------------------
 372
 373 #ifdef __POCKETPC__
 374 // Responds to the OK button in a PocketPC titlebar. This
 375 // can be overridden, or you can change the id used for
 376 // sending the event, by calling SetAffirmativeId.
 377 bool wxDialog::DoOK()
 378 {
 379     const int idOk = GetAffirmativeId();
 380     if ( EmulateButtonClickIfPresent(idOk) )
 381         return true;
 382
 383     wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, GetAffirmativeId());
 384     event.SetEventObject(this);
 385
 386     return GetEventHandler()->ProcessEvent(event);
 387 }
 388 #endif // __POCKETPC__
 389
 390 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 391 // create main toolbar by calling OnCreateToolBar()
 392 wxToolBar* wxDialog::CreateToolBar(long style, wxWindowID winid, const wxString& name)
 393 {
 394     m_dialogToolBar = OnCreateToolBar(style, winid, name);
 395
 396     return m_dialogToolBar;
 397 }
 398
 399 // return a new toolbar
 400 wxToolBar *wxDialog::OnCreateToolBar(long style,
 401                                        wxWindowID winid,
 402                                        const wxString& name)
 403 {
 404     return new wxToolMenuBar(this, winid,
 405                          wxDefaultPosition, wxDefaultSize,
 406                          style, name);
 407 }
 408 #endif
 409
 410 // ---------------------------------------------------------------------------
 411 // dialog Windows messages processing
 412 // ---------------------------------------------------------------------------
 413
 414 WXLRESULT wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 415 {
 416     WXLRESULT rc = 0;
 417     bool processed = false;
 418
 419     switch ( message )
 420     {
 421 #ifdef __WXWINCE__
 422         // react to pressing the OK button in the title
 423         case WM_COMMAND:
 424         {
 425             switch ( LOWORD(wParam) )
 426             {
 427 #ifdef __POCKETPC__
 428                 case IDOK:
 429                     processed = DoOK();
 430                     if (!processed)
 431                         processed = !Close();
 432 #endif
 433 #ifdef __SMARTPHONE__
 434                 case IDM_LEFT:
 435                 case IDM_RIGHT:
 436                     processed = HandleCommand( LOWORD(wParam) , 0 , NULL );
 437                     break;
 438 #endif // __SMARTPHONE__
 439             }
 440             break;
 441         }
 442 #endif
 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 ( IsModal() && 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 }