src/common/dlgcmn.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/dlgcmn.cpp
   3 // Purpose:     common (to all ports) wxDialog functions
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     28.06.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vadim Zeitlin
   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/app.h"
  31     #include "wx/button.h"
  32     #include "wx/dcclient.h"
  33     #include "wx/intl.h"
  34     #include "wx/settings.h"
  35     #include "wx/stattext.h"
  36     #include "wx/sizer.h"
  37     #include "wx/containr.h"
  38 #endif
  39
  40 #include "wx/statline.h"
  41 #include "wx/sysopt.h"
  42 #include "wx/module.h"
  43 #include "wx/private/stattext.h"
  44 #include "wx/bookctrl.h"
  45 #include "wx/scrolwin.h"
  46
  47 #if wxUSE_DISPLAY
  48 #include "wx/display.h"
  49 #endif
  50
  51 // ----------------------------------------------------------------------------
  52 // wxDialogBase
  53 // ----------------------------------------------------------------------------
  54
  55 BEGIN_EVENT_TABLE(wxDialogBase, wxTopLevelWindow)
  56     EVT_BUTTON(wxID_ANY, wxDialogBase::OnButton)
  57
  58     EVT_CLOSE(wxDialogBase::OnCloseWindow)
  59
  60     EVT_CHAR_HOOK(wxDialogBase::OnCharHook)
  61 END_EVENT_TABLE()
  62
  63 wxDialogLayoutAdapter* wxDialogBase::sm_layoutAdapter = NULL;
  64 bool wxDialogBase::sm_layoutAdaptation = false;
  65
  66 void wxDialogBase::Init()
  67 {
  68     m_returnCode = 0;
  69     m_affirmativeId = wxID_OK;
  70     m_escapeId = wxID_ANY;
  71     m_layoutAdaptationLevel = 3;
  72     m_layoutAdaptationDone = FALSE;
  73     m_layoutAdaptationMode = wxDIALOG_ADAPTATION_MODE_DEFAULT;
  74
  75     // the dialogs have this flag on by default to prevent the events from the
  76     // dialog controls from reaching the parent frame which is usually
  77     // undesirable and can lead to unexpected and hard to find bugs
  78     SetExtraStyle(GetExtraStyle() | wxWS_EX_BLOCK_EVENTS);
  79 }
  80
  81 // helper of GetParentForModalDialog()
  82 static bool CanBeUsedAsParent(wxWindow *parent)
  83 {
  84     extern WXDLLIMPEXP_DATA_CORE(wxList) wxPendingDelete;
  85
  86     return !parent->HasExtraStyle(wxWS_EX_TRANSIENT) &&
  87                 parent->IsShownOnScreen() &&
  88                     !wxPendingDelete.Member(parent) &&
  89                         !parent->IsBeingDeleted();
  90 }
  91
  92 wxWindow *wxDialogBase::GetParentForModalDialog(wxWindow *parent) const
  93 {
  94     // creating a parent-less modal dialog will result (under e.g. wxGTK2)
  95     // in an unfocused dialog, so try to find a valid parent for it:
  96     if ( parent )
  97         parent = wxGetTopLevelParent(parent);
  98
  99     if ( !parent || !CanBeUsedAsParent(parent) )
 100         parent = wxTheApp->GetTopWindow();
 101
 102     if ( parent && !CanBeUsedAsParent(parent) )
 103     {
 104         // can't use this one, it's going to disappear
 105         parent = NULL;
 106     }
 107
 108     return parent;
 109 }
 110
 111 #if wxUSE_STATTEXT
 112
 113 class wxTextSizerWrapper : public wxTextWrapper
 114 {
 115 public:
 116     wxTextSizerWrapper(wxWindow *win)
 117     {
 118         m_win = win;
 119         m_hLine = 0;
 120     }
 121
 122     wxSizer *CreateSizer(const wxString& text, int widthMax)
 123     {
 124         m_sizer = new wxBoxSizer(wxVERTICAL);
 125         Wrap(m_win, text, widthMax);
 126         return m_sizer;
 127     }
 128
 129 protected:
 130     virtual void OnOutputLine(const wxString& line)
 131     {
 132         if ( !line.empty() )
 133         {
 134             m_sizer->Add(new wxStaticText(m_win, wxID_ANY, line));
 135         }
 136         else // empty line, no need to create a control for it
 137         {
 138             if ( !m_hLine )
 139                 m_hLine = m_win->GetCharHeight();
 140
 141             m_sizer->Add(5, m_hLine);
 142         }
 143     }
 144
 145 private:
 146     wxWindow *m_win;
 147     wxSizer *m_sizer;
 148     int m_hLine;
 149 };
 150
 151 wxSizer *wxDialogBase::CreateTextSizer(const wxString& message)
 152 {
 153     // I admit that this is complete bogus, but it makes
 154     // message boxes work for pda screens temporarily..
 155     int widthMax = -1;
 156     const bool is_pda = wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA;
 157     if (is_pda)
 158     {
 159         widthMax = wxSystemSettings::GetMetric( wxSYS_SCREEN_X ) - 25;
 160     }
 161
 162     // '&' is used as accel mnemonic prefix in the wxWidgets controls but in
 163     // the static messages created by CreateTextSizer() (used by wxMessageBox,
 164     // for example), we don't want this special meaning, so we need to quote it
 165     wxString text(message);
 166     text.Replace(_T("&"), _T("&&"));
 167
 168     wxTextSizerWrapper wrapper(this);
 169
 170     return wrapper.CreateSizer(text, widthMax);
 171 }
 172
 173 #endif // wxUSE_STATTEXT
 174
 175 wxSizer *wxDialogBase::CreateButtonSizer(long flags)
 176 {
 177     wxSizer *sizer = NULL;
 178
 179 #ifdef __SMARTPHONE__
 180     wxDialog* dialog = (wxDialog*) this;
 181     if ( flags & wxOK )
 182         dialog->SetLeftMenu(wxID_OK);
 183
 184     if ( flags & wxCANCEL )
 185         dialog->SetRightMenu(wxID_CANCEL);
 186
 187     if ( flags & wxYES )
 188         dialog->SetLeftMenu(wxID_YES);
 189
 190     if ( flags & wxNO )
 191         dialog->SetRightMenu(wxID_NO);
 192 #else // !__SMARTPHONE__
 193
 194 #if wxUSE_BUTTON
 195
 196 #ifdef __POCKETPC__
 197     // PocketPC guidelines recommend for Ok/Cancel dialogs to use OK button
 198     // located inside caption bar and implement Cancel functionality through
 199     // Undo outside dialog. As native behaviour this will be default here but
 200     // can be replaced with real wxButtons by setting the option below to 1
 201     if ( (flags & ~(wxCANCEL|wxNO_DEFAULT)) != wxOK ||
 202             wxSystemOptions::GetOptionInt(wxT("wince.dialog.real-ok-cancel")) )
 203 #endif // __POCKETPC__
 204     {
 205         sizer = CreateStdDialogButtonSizer(flags);
 206     }
 207 #else // !wxUSE_BUTTON
 208     wxUnusedVar(flags);
 209 #endif // wxUSE_BUTTON/!wxUSE_BUTTON
 210
 211 #endif // __SMARTPHONE__/!__SMARTPHONE__
 212
 213     return sizer;
 214 }
 215
 216 wxSizer *wxDialogBase::CreateSeparatedButtonSizer(long flags)
 217 {
 218     wxSizer *sizer = CreateButtonSizer(flags);
 219     if ( !sizer )
 220         return NULL;
 221
 222     // Mac Human Interface Guidelines recommend not to use static lines as
 223     // grouping elements
 224 #if wxUSE_STATLINE && !defined(__WXMAC__)
 225     wxBoxSizer *topsizer = new wxBoxSizer(wxVERTICAL);
 226     topsizer->Add(new wxStaticLine(this),
 227                    wxSizerFlags().Expand().DoubleBorder(wxBOTTOM));
 228     topsizer->Add(sizer, wxSizerFlags().Expand());
 229     sizer = topsizer;
 230 #endif // wxUSE_STATLINE
 231
 232     return sizer;
 233 }
 234
 235 #if wxUSE_BUTTON
 236
 237 wxStdDialogButtonSizer *wxDialogBase::CreateStdDialogButtonSizer( long flags )
 238 {
 239     wxStdDialogButtonSizer *sizer = new wxStdDialogButtonSizer();
 240
 241     wxButton *ok = NULL;
 242     wxButton *yes = NULL;
 243     wxButton *no = NULL;
 244
 245     if (flags & wxOK)
 246     {
 247         ok = new wxButton(this, wxID_OK);
 248         sizer->AddButton(ok);
 249     }
 250
 251     if (flags & wxCANCEL)
 252     {
 253         wxButton *cancel = new wxButton(this, wxID_CANCEL);
 254         sizer->AddButton(cancel);
 255     }
 256
 257     if (flags & wxYES)
 258     {
 259         yes = new wxButton(this, wxID_YES);
 260         sizer->AddButton(yes);
 261     }
 262
 263     if (flags & wxNO)
 264     {
 265         no = new wxButton(this, wxID_NO);
 266         sizer->AddButton(no);
 267     }
 268
 269     if (flags & wxAPPLY)
 270     {
 271         wxButton *apply = new wxButton(this, wxID_APPLY);
 272         sizer->AddButton(apply);
 273     }
 274
 275     if (flags & wxCLOSE)
 276     {
 277         wxButton *close = new wxButton(this, wxID_CLOSE);
 278         sizer->AddButton(close);
 279     }
 280
 281     if (flags & wxHELP)
 282     {
 283         wxButton *help = new wxButton(this, wxID_HELP);
 284         sizer->AddButton(help);
 285     }
 286
 287     if (flags & wxNO_DEFAULT)
 288     {
 289         if (no)
 290         {
 291             no->SetDefault();
 292             no->SetFocus();
 293         }
 294     }
 295     else
 296     {
 297         if (ok)
 298         {
 299             ok->SetDefault();
 300             ok->SetFocus();
 301         }
 302         else if (yes)
 303         {
 304             yes->SetDefault();
 305             yes->SetFocus();
 306         }
 307     }
 308
 309     if (flags & wxOK)
 310         SetAffirmativeId(wxID_OK);
 311     else if (flags & wxYES)
 312         SetAffirmativeId(wxID_YES);
 313
 314     sizer->Realize();
 315
 316     return sizer;
 317 }
 318
 319 #endif // wxUSE_BUTTON
 320
 321 // ----------------------------------------------------------------------------
 322 // standard buttons handling
 323 // ----------------------------------------------------------------------------
 324
 325 void wxDialogBase::EndDialog(int rc)
 326 {
 327     if ( IsModal() )
 328         EndModal(rc);
 329     else
 330         Hide();
 331 }
 332
 333 void wxDialogBase::AcceptAndClose()
 334 {
 335     if ( Validate() && TransferDataFromWindow() )
 336     {
 337         EndDialog(m_affirmativeId);
 338     }
 339 }
 340
 341 void wxDialogBase::SetAffirmativeId(int affirmativeId)
 342 {
 343     m_affirmativeId = affirmativeId;
 344 }
 345
 346 void wxDialogBase::SetEscapeId(int escapeId)
 347 {
 348     m_escapeId = escapeId;
 349 }
 350
 351 bool wxDialogBase::EmulateButtonClickIfPresent(int id)
 352 {
 353 #if wxUSE_BUTTON
 354     wxButton *btn = wxDynamicCast(FindWindow(id), wxButton);
 355
 356     if ( !btn || !btn->IsEnabled() || !btn->IsShown() )
 357         return false;
 358
 359     wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, id);
 360     event.SetEventObject(btn);
 361     btn->GetEventHandler()->ProcessEvent(event);
 362
 363     return true;
 364 #else // !wxUSE_BUTTON
 365     wxUnusedVar(id);
 366     return false;
 367 #endif // wxUSE_BUTTON/!wxUSE_BUTTON
 368 }
 369
 370 bool wxDialogBase::IsEscapeKey(const wxKeyEvent& event)
 371 {
 372     // for most platforms, Esc key is used to close the dialogs
 373     return event.GetKeyCode() == WXK_ESCAPE &&
 374                 event.GetModifiers() == wxMOD_NONE;
 375 }
 376
 377 void wxDialogBase::OnCharHook(wxKeyEvent& event)
 378 {
 379     if ( event.GetKeyCode() == WXK_ESCAPE )
 380     {
 381         int idCancel = GetEscapeId();
 382         switch ( idCancel )
 383         {
 384             case wxID_NONE:
 385                 // don't handle Esc specially at all
 386                 break;
 387
 388             case wxID_ANY:
 389                 // this value is special: it means translate Esc to wxID_CANCEL
 390                 // but if there is no such button, then fall back to wxID_OK
 391                 if ( EmulateButtonClickIfPresent(wxID_CANCEL) )
 392                     return;
 393                 idCancel = GetAffirmativeId();
 394                 // fall through
 395
 396             default:
 397                 // translate Esc to button press for the button with given id
 398                 if ( EmulateButtonClickIfPresent(idCancel) )
 399                     return;
 400         }
 401     }
 402
 403     event.Skip();
 404 }
 405
 406 void wxDialogBase::OnButton(wxCommandEvent& event)
 407 {
 408     const int id = event.GetId();
 409     if ( id == GetAffirmativeId() )
 410     {
 411         AcceptAndClose();
 412     }
 413     else if ( id == wxID_APPLY )
 414     {
 415         if ( Validate() )
 416             TransferDataFromWindow();
 417
 418         // TODO: disable the Apply button until things change again
 419     }
 420     else if ( id == GetEscapeId() ||
 421                 (id == wxID_CANCEL && GetEscapeId() == wxID_ANY) )
 422     {
 423         EndDialog(wxID_CANCEL);
 424     }
 425     else // not a standard button
 426     {
 427         event.Skip();
 428     }
 429 }
 430
 431 // ----------------------------------------------------------------------------
 432 // other event handlers
 433 // ----------------------------------------------------------------------------
 434
 435 void wxDialogBase::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 436 {
 437     // We'll send a Cancel message by default, which may close the dialog.
 438     // Check for looping if the Cancel event handler calls Close().
 439
 440     // Note that if a cancel button and handler aren't present in the dialog,
 441     // nothing will happen when you close the dialog via the window manager, or
 442     // via Close(). We wouldn't want to destroy the dialog by default, since
 443     // the dialog may have been created on the stack. However, this does mean
 444     // that calling dialog->Close() won't delete the dialog unless the handler
 445     // for wxID_CANCEL does so. So use Destroy() if you want to be sure to
 446     // destroy the dialog. The default OnCancel (above) simply ends a modal
 447     // dialog, and hides a modeless dialog.
 448
 449     // VZ: this is horrible and MT-unsafe. Can't we reuse some of these global
 450     //     lists here? don't dare to change it now, but should be done later!
 451     static wxList closing;
 452
 453     if ( closing.Member(this) )
 454         return;
 455
 456     closing.Append(this);
 457
 458     wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 459     cancelEvent.SetEventObject( this );
 460     GetEventHandler()->ProcessEvent(cancelEvent); // This may close the dialog
 461
 462     closing.DeleteObject(this);
 463 }
 464
 465 void wxDialogBase::OnSysColourChanged(wxSysColourChangedEvent& event)
 466 {
 467 #ifndef __WXGTK__
 468     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
 469     Refresh();
 470 #endif
 471
 472     event.Skip();
 473 }
 474
 475 /// Do the adaptation
 476 bool wxDialogBase::DoLayoutAdaptation()
 477 {
 478     if (GetLayoutAdapter())
 479         return GetLayoutAdapter()->DoLayoutAdaptation((wxDialog*) this);
 480     else
 481         return false;
 482 }
 483
 484 /// Can we do the adaptation?
 485 bool wxDialogBase::CanDoLayoutAdaptation()
 486 {
 487     // Check if local setting overrides the global setting
 488     bool layoutEnabled = (GetLayoutAdaptationMode() == wxDIALOG_ADAPTATION_MODE_ENABLED) || (IsLayoutAdaptationEnabled() && (GetLayoutAdaptationMode() != wxDIALOG_ADAPTATION_MODE_DISABLED));
 489
 490     return (layoutEnabled && !m_layoutAdaptationDone && GetLayoutAdaptationLevel() != 0 && GetLayoutAdapter() != NULL && GetLayoutAdapter()->CanDoLayoutAdaptation((wxDialog*) this));
 491 }
 492
 493 /// Set scrolling adapter class, returning old adapter
 494 wxDialogLayoutAdapter* wxDialogBase::SetLayoutAdapter(wxDialogLayoutAdapter* adapter)
 495 {
 496     wxDialogLayoutAdapter* oldLayoutAdapter = sm_layoutAdapter;
 497     sm_layoutAdapter = adapter;
 498     return oldLayoutAdapter;
 499 }
 500
 501 /*!
 502  * Standard adapter
 503  */
 504
 505 IMPLEMENT_CLASS(wxDialogLayoutAdapter, wxObject)
 506
 507 IMPLEMENT_CLASS(wxStandardDialogLayoutAdapter, wxDialogLayoutAdapter)
 508
 509 // Allow for caption size on wxWidgets < 2.9
 510 #if defined(__WXGTK__) && !wxCHECK_VERSION(2,9,0)
 511 #define wxEXTRA_DIALOG_HEIGHT 30
 512 #else
 513 #define wxEXTRA_DIALOG_HEIGHT 0
 514 #endif
 515
 516 /// Indicate that adaptation should be done
 517 bool wxStandardDialogLayoutAdapter::CanDoLayoutAdaptation(wxDialog* dialog)
 518 {
 519     if (dialog->GetSizer())
 520     {
 521         wxSize windowSize, displaySize;
 522         return MustScroll(dialog, windowSize, displaySize) != 0;
 523     }
 524     else
 525         return false;
 526 }
 527
 528 bool wxStandardDialogLayoutAdapter::DoLayoutAdaptation(wxDialog* dialog)
 529 {
 530     if (dialog->GetSizer())
 531     {
 532         wxBookCtrlBase* bookContentWindow = wxDynamicCast(dialog->GetContentWindow(), wxBookCtrlBase);
 533
 534         if (bookContentWindow)
 535         {
 536             // If we have a book control, make all the pages (that use sizers) scrollable
 537             wxWindowList windows;
 538             for (size_t i = 0; i < bookContentWindow->GetPageCount(); i++)
 539             {
 540                 wxWindow* page = bookContentWindow->GetPage(i);
 541
 542                 wxScrolledWindow* scrolledWindow = wxDynamicCast(page, wxScrolledWindow);
 543                 if (scrolledWindow)
 544                     windows.Append(scrolledWindow);
 545                 else if (!scrolledWindow && page->GetSizer())
 546                 {
 547                     // Create a scrolled window and reparent
 548                     scrolledWindow = CreateScrolledWindow(page);
 549                     wxSizer* oldSizer = page->GetSizer();
 550
 551                     wxSizer* newSizer = new wxBoxSizer(wxVERTICAL);
 552                     newSizer->Add(scrolledWindow,1, wxEXPAND, 0);
 553
 554                     page->SetSizer(newSizer, false /* don't delete the old sizer */);
 555
 556                     scrolledWindow->SetSizer(oldSizer);
 557
 558                     ReparentControls(page, scrolledWindow);
 559
 560                     windows.Append(scrolledWindow);
 561                 }
 562             }
 563
 564             FitWithScrolling(dialog, windows);
 565         }
 566         else
 567         {
 568             // If we have an arbitrary dialog, create a scrolling area for the main content, and a button sizer
 569             // for the main buttons.
 570             wxScrolledWindow* scrolledWindow = CreateScrolledWindow(dialog);
 571
 572             int buttonSizerBorder = 0;
 573
 574             // First try to find a wxStdDialogButtonSizer
 575             wxSizer* buttonSizer = FindButtonSizer(true /* find std button sizer */, dialog, dialog->GetSizer(), buttonSizerBorder);
 576
 577             // Next try to find a wxBoxSizer containing the controls
 578             if (!buttonSizer && dialog->GetLayoutAdaptationLevel() > wxDIALOG_ADAPTATION_STANDARD_SIZER)
 579                 buttonSizer = FindButtonSizer(false /* find ordinary sizer */, dialog, dialog->GetSizer(), buttonSizerBorder);
 580
 581             // If we still don't have a button sizer, collect any 'loose' buttons in the layout
 582             if (!buttonSizer && dialog->GetLayoutAdaptationLevel() > wxDIALOG_ADAPTATION_ANY_SIZER)
 583             {
 584                 int count = 0;
 585                 wxStdDialogButtonSizer* stdButtonSizer = new wxStdDialogButtonSizer;
 586                 buttonSizer = stdButtonSizer;
 587
 588                 FindLooseButtons(dialog, stdButtonSizer, dialog->GetSizer(), count);
 589                 if (count > 0)
 590                     stdButtonSizer->Realize();
 591                 else
 592                 {
 593                     delete buttonSizer;
 594                     buttonSizer = NULL;
 595                 }
 596             }
 597
 598             if (buttonSizerBorder == 0)
 599                 buttonSizerBorder = 5;
 600
 601             ReparentControls(dialog, scrolledWindow, buttonSizer);
 602
 603             wxBoxSizer* newTopSizer = new wxBoxSizer(wxVERTICAL);
 604             wxSizer* oldSizer = dialog->GetSizer();
 605
 606             dialog->SetSizer(newTopSizer, false /* don't delete old sizer */);
 607
 608             newTopSizer->Add(scrolledWindow, 1, wxEXPAND|wxALL, 0);
 609             if (buttonSizer)
 610                 newTopSizer->Add(buttonSizer, 0, wxEXPAND|wxALL, buttonSizerBorder);
 611
 612             scrolledWindow->SetSizer(oldSizer);
 613
 614             FitWithScrolling(dialog, scrolledWindow);
 615         }
 616     }
 617
 618     dialog->SetLayoutAdaptationDone(true);
 619     return true;
 620 }
 621
 622 // Create the scrolled window
 623 wxScrolledWindow* wxStandardDialogLayoutAdapter::CreateScrolledWindow(wxWindow* parent)
 624 {
 625     wxScrolledWindow* scrolledWindow = new wxScrolledWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL|wxVSCROLL|wxHSCROLL|wxBORDER_NONE);
 626     return scrolledWindow;
 627 }
 628
 629 /// Find and remove the button sizer, if any
 630 wxSizer* wxStandardDialogLayoutAdapter::FindButtonSizer(bool stdButtonSizer, wxDialog* dialog, wxSizer* sizer, int& retBorder, int accumlatedBorder)
 631 {
 632     for ( wxSizerItemList::compatibility_iterator node = sizer->GetChildren().GetFirst();
 633           node; node = node->GetNext() )
 634     {
 635         wxSizerItem *item = node->GetData();
 636         wxSizer *childSizer = item->GetSizer();
 637
 638         if ( childSizer )
 639         {
 640             int newBorder = accumlatedBorder;
 641             if (item->GetFlag() & wxALL)
 642                 newBorder += item->GetBorder();
 643
 644             if (stdButtonSizer) // find wxStdDialogButtonSizer
 645             {
 646                 wxStdDialogButtonSizer* buttonSizer = wxDynamicCast(childSizer, wxStdDialogButtonSizer);
 647                 if (buttonSizer)
 648                 {
 649                     sizer->Detach(childSizer);
 650                     retBorder = newBorder;
 651                     return buttonSizer;
 652                 }
 653             }
 654             else // find a horizontal box sizer containing standard buttons
 655             {
 656                 wxBoxSizer* buttonSizer = wxDynamicCast(childSizer, wxBoxSizer);
 657                 if (buttonSizer && IsOrdinaryButtonSizer(dialog, buttonSizer))
 658                 {
 659                     sizer->Detach(childSizer);
 660                     retBorder = newBorder;
 661                     return buttonSizer;
 662                 }
 663             }
 664
 665             wxSizer* s = FindButtonSizer(stdButtonSizer, dialog, childSizer, retBorder, newBorder);
 666             if (s)
 667                 return s;
 668         }
 669     }
 670     return NULL;
 671 }
 672
 673 /// Check if this sizer contains standard buttons, and so can be repositioned in the dialog
 674 bool wxStandardDialogLayoutAdapter::IsOrdinaryButtonSizer(wxDialog* dialog, wxBoxSizer* sizer)
 675 {
 676     if (sizer->GetOrientation() != wxHORIZONTAL)
 677         return false;
 678
 679     for ( wxSizerItemList::compatibility_iterator node = sizer->GetChildren().GetFirst();
 680           node; node = node->GetNext() )
 681     {
 682         wxSizerItem *item = node->GetData();
 683         wxButton *childButton = wxDynamicCast(item->GetWindow(), wxButton);
 684
 685         if (childButton && IsStandardButton(dialog, childButton))
 686             return true;
 687     }
 688     return false;
 689 }
 690
 691 /// Check if this is a standard button
 692 bool wxStandardDialogLayoutAdapter::IsStandardButton(wxDialog* dialog, wxButton* button)
 693 {
 694     wxWindowID id = button->GetId();
 695
 696     return (id == wxID_OK || id == wxID_CANCEL || id == wxID_YES || id == wxID_NO || id == wxID_SAVE ||
 697             id == wxID_APPLY || id == wxID_HELP || id == wxID_CONTEXT_HELP || dialog->IsMainButtonId(id));
 698 }
 699
 700 /// Find 'loose' main buttons in the existing layout and add them to the standard dialog sizer
 701 bool wxStandardDialogLayoutAdapter::FindLooseButtons(wxDialog* dialog, wxStdDialogButtonSizer* buttonSizer, wxSizer* sizer, int& count)
 702 {
 703     wxSizerItemList::compatibility_iterator node = sizer->GetChildren().GetFirst();
 704     while (node)
 705     {
 706         wxSizerItemList::compatibility_iterator next = node->GetNext();
 707         wxSizerItem *item = node->GetData();
 708         wxSizer *childSizer = item->GetSizer();
 709         wxButton *childButton = wxDynamicCast(item->GetWindow(), wxButton);
 710
 711         if (childButton && IsStandardButton(dialog, childButton))
 712         {
 713             sizer->Detach(childButton);
 714             buttonSizer->AddButton(childButton);
 715             count ++;
 716         }
 717
 718         if (childSizer)
 719             FindLooseButtons(dialog, buttonSizer, childSizer, count);
 720
 721         node = next;
 722     }
 723     return true;
 724 }
 725
 726 /// Reparent the controls to the scrolled window
 727 void wxStandardDialogLayoutAdapter::ReparentControls(wxWindow* parent, wxWindow* reparentTo, wxSizer* buttonSizer)
 728 {
 729     DoReparentControls(parent, reparentTo, buttonSizer);
 730 }
 731
 732 void wxStandardDialogLayoutAdapter::DoReparentControls(wxWindow* parent, wxWindow* reparentTo, wxSizer* buttonSizer)
 733 {
 734     wxWindowList::compatibility_iterator node = parent->GetChildren().GetFirst();
 735     while (node)
 736     {
 737         wxWindowList::compatibility_iterator next = node->GetNext();
 738
 739         wxWindow *win = node->GetData();
 740
 741         // Don't reparent the scrolled window or buttons in the button sizer
 742         if (win != reparentTo && (!buttonSizer || !buttonSizer->GetItem(win)))
 743         {
 744             win->Reparent(reparentTo);
 745 #ifdef __WXMSW__
 746             // Restore correct tab order
 747             ::SetWindowPos((HWND) win->GetHWND(), HWND_BOTTOM, -1, -1, -1, -1, SWP_NOMOVE|SWP_NOSIZE);
 748 #endif
 749         }
 750
 751         node = next;
 752     }
 753 }
 754
 755 /// Find whether scrolling will be necessary for the dialog, returning wxVERTICAL, wxHORIZONTAL or both
 756 int wxStandardDialogLayoutAdapter::MustScroll(wxDialog* dialog, wxSize& windowSize, wxSize& displaySize)
 757 {
 758     return DoMustScroll(dialog, windowSize, displaySize);
 759 }
 760
 761 /// Find whether scrolling will be necessary for the dialog, returning wxVERTICAL, wxHORIZONTAL or both
 762 int wxStandardDialogLayoutAdapter::DoMustScroll(wxDialog* dialog, wxSize& windowSize, wxSize& displaySize)
 763 {
 764     wxSize minWindowSize = dialog->GetSizer()->GetMinSize();
 765     windowSize = dialog->GetSize();
 766     windowSize = wxSize(wxMax(windowSize.x, minWindowSize.x), wxMax(windowSize.y, minWindowSize.y));
 767 #if wxUSE_DISPLAY
 768     displaySize = wxDisplay(wxDisplay::GetFromWindow(dialog)).GetClientArea().GetSize();
 769 #else
 770     displaySize = wxGetClientDisplayRect().GetSize();
 771 #endif
 772
 773     int flags = 0;
 774
 775     if (windowSize.y >= (displaySize.y - wxEXTRA_DIALOG_HEIGHT))
 776         flags |= wxVERTICAL;
 777     if (windowSize.x >= displaySize.x)
 778         flags |= wxHORIZONTAL;
 779
 780     return flags;
 781 }
 782
 783 // A function to fit the dialog around its contents, and then adjust for screen size.
 784 // If scrolled windows are passed, scrolling is enabled in the required orientation(s).
 785 bool wxStandardDialogLayoutAdapter::FitWithScrolling(wxDialog* dialog, wxWindowList& windows)
 786 {
 787     return DoFitWithScrolling(dialog, windows);
 788 }
 789
 790 // A function to fit the dialog around its contents, and then adjust for screen size.
 791 // If a scrolled window is passed, scrolling is enabled in the required orientation(s).
 792 bool wxStandardDialogLayoutAdapter::FitWithScrolling(wxDialog* dialog, wxScrolledWindow* scrolledWindow)
 793 {
 794     return DoFitWithScrolling(dialog, scrolledWindow);
 795 }
 796
 797 // A function to fit the dialog around its contents, and then adjust for screen size.
 798 // If a scrolled window is passed, scrolling is enabled in the required orientation(s).
 799 bool wxStandardDialogLayoutAdapter::DoFitWithScrolling(wxDialog* dialog, wxScrolledWindow* scrolledWindow)
 800 {
 801     wxWindowList windows;
 802     windows.Append(scrolledWindow);
 803     return DoFitWithScrolling(dialog, windows);
 804 }
 805
 806 bool wxStandardDialogLayoutAdapter::DoFitWithScrolling(wxDialog* dialog, wxWindowList& windows)
 807 {
 808     wxSizer* sizer = dialog->GetSizer();
 809     if (!sizer)
 810         return false;
 811
 812     sizer->SetSizeHints(dialog);
 813
 814     wxSize windowSize, displaySize;
 815     int scrollFlags = DoMustScroll(dialog, windowSize, displaySize);
 816     int scrollBarSize = 20;
 817
 818     if (scrollFlags)
 819     {
 820         int scrollBarExtraX = 0, scrollBarExtraY = 0;
 821         bool resizeHorizontally = (scrollFlags & wxHORIZONTAL) != 0;
 822         bool resizeVertically = (scrollFlags & wxVERTICAL) != 0;
 823
 824         if (windows.GetCount() != 0)
 825         {
 826             // Allow extra for a scrollbar, assuming we resizing in one direction only.
 827             if ((resizeVertically && !resizeHorizontally) && (windowSize.x < (displaySize.x - scrollBarSize)))
 828                 scrollBarExtraX = scrollBarSize;
 829             if ((resizeHorizontally && !resizeVertically) && (windowSize.y < (displaySize.y - scrollBarSize)))
 830                 scrollBarExtraY = scrollBarSize;
 831         }
 832
 833         wxWindowList::compatibility_iterator node = windows.GetFirst();
 834         while (node)
 835         {
 836             wxWindow *win = node->GetData();
 837             wxScrolledWindow* scrolledWindow = wxDynamicCast(win, wxScrolledWindow);
 838             if (scrolledWindow)
 839             {
 840                 scrolledWindow->SetScrollRate(resizeHorizontally ? 10 : 0, resizeVertically ? 10 : 0);
 841
 842                 if (scrolledWindow->GetSizer())
 843                     scrolledWindow->GetSizer()->Fit(scrolledWindow);
 844             }
 845
 846             node = node->GetNext();
 847         }
 848
 849         wxSize limitTo = windowSize + wxSize(scrollBarExtraX, scrollBarExtraY);
 850         if (resizeVertically)
 851             limitTo.y = displaySize.y - wxEXTRA_DIALOG_HEIGHT;
 852         if (resizeHorizontally)
 853             limitTo.x = displaySize.x;
 854
 855         dialog->SetMinSize(limitTo);
 856         dialog->SetSize(limitTo);
 857
 858         dialog->SetSizeHints( limitTo.x, limitTo.y, dialog->GetMaxWidth(), dialog->GetMaxHeight() );
 859     }
 860
 861     return true;
 862 }
 863
 864 /*!
 865  * Module to initialise standard adapter
 866  */
 867
 868 class wxDialogLayoutAdapterModule: public wxModule
 869 {
 870     DECLARE_DYNAMIC_CLASS(wxDialogLayoutAdapterModule)
 871 public:
 872     wxDialogLayoutAdapterModule() {}
 873     virtual void OnExit() { delete wxDialogBase::SetLayoutAdapter(NULL); }
 874     virtual bool OnInit() { wxDialogBase::SetLayoutAdapter(new wxStandardDialogLayoutAdapter); return true; }
 875 };
 876
 877 IMPLEMENT_DYNAMIC_CLASS(wxDialogLayoutAdapterModule, wxModule)