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/scopedptr.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_isShown = false;
 149     m_modalData = NULL;
 150 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 151     m_dialogToolBar = NULL;
 152 #endif
 153 #if wxUSE_DIALOG_SIZEGRIP
 154     m_hGripper = 0;
 155 #endif // wxUSE_DIALOG_SIZEGRIP
 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     // All dialogs should really have this style
 169     style |= wxTAB_TRAVERSAL;
 170
 171     if ( !wxTopLevelWindow::Create(parent, id, title, pos, size, style, name) )
 172         return false;
 173
 174     if ( !m_hasFont )
 175         SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 176
 177 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
 178     SetLeftMenu(wxID_OK, _("OK"));
 179 #endif
 180 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 181     CreateToolBar();
 182 #endif
 183
 184 #if wxUSE_DIALOG_SIZEGRIP
 185     if ( HasFlag(wxRESIZE_BORDER) )
 186     {
 187         CreateGripper();
 188
 189         Connect(wxEVT_CREATE,
 190                 wxWindowCreateEventHandler(wxDialog::OnWindowCreate));
 191     }
 192 #endif // wxUSE_DIALOG_SIZEGRIP
 193
 194     return true;
 195 }
 196
 197 wxDialog::~wxDialog()
 198 {
 199     // this will also reenable all the other windows for a modal dialog
 200     Show(false);
 201
 202 #if wxUSE_DIALOG_SIZEGRIP
 203     DestroyGripper();
 204 #endif // wxUSE_DIALOG_SIZEGRIP
 205 }
 206
 207 // ----------------------------------------------------------------------------
 208 // showing the dialogs
 209 // ----------------------------------------------------------------------------
 210
 211 bool wxDialog::Show(bool show)
 212 {
 213     if ( show == IsShown() )
 214         return false;
 215
 216     if ( !show && m_modalData )
 217     {
 218         // we need to do this before calling wxDialogBase version because if we
 219         // had disabled other app windows, they must be reenabled right now as
 220         // if they stay disabled Windows will activate another window (one
 221         // which is enabled, anyhow) when we're hidden in the base class Show()
 222         // and we will lose activation
 223         m_modalData->ExitLoop();
 224     }
 225
 226     if ( show )
 227     {
 228         if (CanDoLayoutAdaptation())
 229             DoLayoutAdaptation();
 230
 231         // this usually will result in TransferDataToWindow() being called
 232         // which will change the controls values so do it before showing as
 233         // otherwise we could have some flicker
 234         InitDialog();
 235     }
 236
 237     wxDialogBase::Show(show);
 238
 239     if ( show )
 240     {
 241         // dialogs don't get WM_SIZE message from ::ShowWindow() for some
 242         // reason so generate it ourselves for consistency with frames and
 243         // dialogs in other ports
 244         //
 245         // NB: normally we should call it just the first time but doing it
 246         //     every time is simpler than keeping a flag
 247         const wxSize size = GetClientSize();
 248         ::SendMessage(GetHwnd(), WM_SIZE,
 249                       SIZE_RESTORED, MAKELPARAM(size.x, size.y));
 250     }
 251
 252     return true;
 253 }
 254
 255 void wxDialog::Raise()
 256 {
 257     ::SetForegroundWindow(GetHwnd());
 258 }
 259
 260 // show dialog modally
 261 int wxDialog::ShowModal()
 262 {
 263     wxASSERT_MSG( !IsModal(), wxT("ShowModal() can't be called twice") );
 264
 265     Show();
 266
 267     // EndModal may have been called from InitDialog handler (called from
 268     // inside Show()) and hidden the dialog back again
 269     if ( IsShown() )
 270     {
 271         // enter and run the modal loop
 272         wxDialogModalDataTiedPtr modalData(&m_modalData,
 273                                            new wxDialogModalData(this));
 274         modalData->RunLoop();
 275     }
 276
 277     return GetReturnCode();
 278 }
 279
 280 void wxDialog::EndModal(int retCode)
 281 {
 282     wxASSERT_MSG( IsModal(), wxT("EndModal() called for non modal dialog") );
 283
 284     SetReturnCode(retCode);
 285
 286     Hide();
 287 }
 288
 289 // ----------------------------------------------------------------------------
 290 // wxDialog gripper handling
 291 // ----------------------------------------------------------------------------
 292
 293 #if wxUSE_DIALOG_SIZEGRIP
 294
 295 void wxDialog::SetWindowStyleFlag(long style)
 296 {
 297     wxDialogBase::SetWindowStyleFlag(style);
 298
 299     if ( HasFlag(wxRESIZE_BORDER) )
 300         CreateGripper();
 301     else
 302         DestroyGripper();
 303 }
 304
 305 void wxDialog::CreateGripper()
 306 {
 307     if ( !m_hGripper )
 308     {
 309         // just create it here, it will be positioned and shown later
 310         m_hGripper = (WXHWND)::CreateWindow
 311                                (
 312                                     wxT("SCROLLBAR"),
 313                                     wxT(""),
 314                                     WS_CHILD |
 315                                     WS_CLIPSIBLINGS |
 316                                     SBS_SIZEGRIP |
 317                                     SBS_SIZEBOX |
 318                                     SBS_SIZEBOXBOTTOMRIGHTALIGN,
 319                                     0, 0, 0, 0,
 320                                     GetHwnd(),
 321                                     0,
 322                                     wxGetInstance(),
 323                                     NULL
 324                                );
 325     }
 326 }
 327
 328 void wxDialog::DestroyGripper()
 329 {
 330     if ( m_hGripper )
 331     {
 332         // we used to have trouble with gripper appearing on top (and hence
 333         // overdrawing) the other, real, dialog children -- check that this
 334         // isn't the case automatically (but notice that this could be false if
 335         // we're not shown at all as in this case ResizeGripper() might not
 336         // have been called yet)
 337         wxASSERT_MSG( !IsShown() ||
 338                       ::GetWindow((HWND)m_hGripper, GW_HWNDNEXT) == 0,
 339             wxT("Bug in wxWidgets: gripper should be at the bottom of Z-order") );
 340         ::DestroyWindow((HWND) m_hGripper);
 341         m_hGripper = 0;
 342     }
 343 }
 344
 345 void wxDialog::ShowGripper(bool show)
 346 {
 347     wxASSERT_MSG( m_hGripper, wxT("shouldn't be called if we have no gripper") );
 348
 349     if ( show )
 350         ResizeGripper();
 351
 352     ::ShowWindow((HWND)m_hGripper, show ? SW_SHOW : SW_HIDE);
 353 }
 354
 355 void wxDialog::ResizeGripper()
 356 {
 357     wxASSERT_MSG( m_hGripper, wxT("shouldn't be called if we have no gripper") );
 358
 359     HWND hwndGripper = (HWND)m_hGripper;
 360
 361     const wxRect rectGripper = wxRectFromRECT(wxGetWindowRect(hwndGripper));
 362     const wxSize size = GetClientSize() - rectGripper.GetSize();
 363
 364     ::SetWindowPos(hwndGripper, HWND_BOTTOM,
 365                    size.x, size.y,
 366                    rectGripper.width, rectGripper.height,
 367                    SWP_NOACTIVATE);
 368 }
 369
 370 void wxDialog::OnWindowCreate(wxWindowCreateEvent& event)
 371 {
 372     if ( m_hGripper && IsShown() &&
 373             event.GetWindow() && event.GetWindow()->GetParent() == this )
 374     {
 375         // Put gripper below the newly created child window
 376         ::SetWindowPos((HWND)m_hGripper, HWND_BOTTOM, 0, 0, 0, 0,
 377                        SWP_NOSIZE | SWP_NOMOVE | SWP_NOACTIVATE);
 378     }
 379
 380     event.Skip();
 381 }
 382
 383 #endif // wxUSE_DIALOG_SIZEGRIP
 384
 385 // ----------------------------------------------------------------------------
 386 // wxWin event handlers
 387 // ----------------------------------------------------------------------------
 388
 389 #ifdef __POCKETPC__
 390 // Responds to the OK button in a PocketPC titlebar. This
 391 // can be overridden, or you can change the id used for
 392 // sending the event, by calling SetAffirmativeId.
 393 bool wxDialog::DoOK()
 394 {
 395     const int idOk = GetAffirmativeId();
 396     if ( EmulateButtonClickIfPresent(idOk) )
 397         return true;
 398
 399     wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, GetAffirmativeId());
 400     event.SetEventObject(this);
 401
 402     return HandleWindowEvent(event);
 403 }
 404 #endif // __POCKETPC__
 405
 406 #if wxUSE_TOOLBAR && defined(__POCKETPC__)
 407 // create main toolbar by calling OnCreateToolBar()
 408 wxToolBar* wxDialog::CreateToolBar(long style, wxWindowID winid, const wxString& name)
 409 {
 410     m_dialogToolBar = OnCreateToolBar(style, winid, name);
 411
 412     return m_dialogToolBar;
 413 }
 414
 415 // return a new toolbar
 416 wxToolBar *wxDialog::OnCreateToolBar(long style,
 417                                        wxWindowID winid,
 418                                        const wxString& name)
 419 {
 420     return new wxToolMenuBar(this, winid,
 421                          wxDefaultPosition, wxDefaultSize,
 422                          style, name);
 423 }
 424 #endif
 425
 426 // ---------------------------------------------------------------------------
 427 // dialog Windows messages processing
 428 // ---------------------------------------------------------------------------
 429
 430 WXLRESULT wxDialog::MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam)
 431 {
 432     WXLRESULT rc = 0;
 433     bool processed = false;
 434
 435     switch ( message )
 436     {
 437 #ifdef __WXWINCE__
 438         // react to pressing the OK button in the title
 439         case WM_COMMAND:
 440         {
 441             switch ( LOWORD(wParam) )
 442             {
 443 #ifdef __POCKETPC__
 444                 case IDOK:
 445                     processed = DoOK();
 446                     if (!processed)
 447                         processed = !Close();
 448 #endif
 449 #ifdef __SMARTPHONE__
 450                 case IDM_LEFT:
 451                 case IDM_RIGHT:
 452                     processed = HandleCommand( LOWORD(wParam) , 0 , NULL );
 453                     break;
 454 #endif // __SMARTPHONE__
 455             }
 456             break;
 457         }
 458 #endif
 459         case WM_CLOSE:
 460             // if we can't close, tell the system that we processed the
 461             // message - otherwise it would close us
 462             processed = !Close();
 463             break;
 464
 465         case WM_SIZE:
 466 #if wxUSE_DIALOG_SIZEGRIP
 467             if ( m_hGripper )
 468             {
 469                 switch ( wParam )
 470                 {
 471                     case SIZE_MAXIMIZED:
 472                         ShowGripper(false);
 473                         break;
 474
 475                     case SIZE_RESTORED:
 476                         ShowGripper(true);
 477                 }
 478             }
 479 #endif // wxUSE_DIALOG_SIZEGRIP
 480
 481             // the Windows dialogs unfortunately are not meant to be resizeable
 482             // at all and their standard class doesn't include CS_[VH]REDRAW
 483             // styles which means that the window is not refreshed properly
 484             // after the resize and no amount of WS_CLIPCHILDREN/SIBLINGS can
 485             // help with it - so we have to refresh it manually which certainly
 486             // creates flicker but at least doesn't show garbage on the screen
 487             rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 488             processed = true;
 489             if ( HasFlag(wxFULL_REPAINT_ON_RESIZE) )
 490             {
 491                 ::InvalidateRect(GetHwnd(), NULL, false /* erase bg */);
 492             }
 493             break;
 494
 495 #ifndef __WXMICROWIN__
 496         case WM_SETCURSOR:
 497             // we want to override the busy cursor for modal dialogs:
 498             // typically, wxBeginBusyCursor() is called and then a modal dialog
 499             // is shown, but the modal dialog shouldn't have hourglass cursor
 500             if ( IsModal() && wxIsBusy() )
 501             {
 502                 // set our cursor for all windows (but see below)
 503                 wxCursor cursor = m_cursor;
 504                 if ( !cursor.Ok() )
 505                     cursor = wxCURSOR_ARROW;
 506
 507                 ::SetCursor(GetHcursorOf(cursor));
 508
 509                 // in any case, stop here and don't let wxWindow process this
 510                 // message (it would set the busy cursor)
 511                 processed = true;
 512
 513                 // but return false to tell the child window (if the event
 514                 // comes from one of them and not from ourselves) that it can
 515                 // set its own cursor if it has one: thus, standard controls
 516                 // (e.g. text ctrl) still have correct cursors in a dialog
 517                 // invoked while wxIsBusy()
 518                 rc = false;
 519             }
 520             break;
 521 #endif // __WXMICROWIN__
 522     }
 523
 524     if ( !processed )
 525         rc = wxWindow::MSWWindowProc(message, wParam, lParam);
 526
 527     return rc;
 528 }