src/ribbon/panel.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/ribbon/panel.cpp
   3 // Purpose:     Ribbon-style container for a group of related tools / controls
   4 // Author:      Peter Cawley
   5 // Modified by:
   6 // Created:     2009-05-25
   7 // RCS-ID:      $Id$
   8 // Copyright:   (C) Peter Cawley
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #include "wx/wxprec.h"
  13
  14 #ifdef __BORLANDC__
  15     #pragma hdrstop
  16 #endif
  17
  18 #if wxUSE_RIBBON
  19
  20 #include "wx/ribbon/panel.h"
  21 #include "wx/ribbon/art.h"
  22 #include "wx/ribbon/bar.h"
  23 #include "wx/dcbuffer.h"
  24 #include "wx/display.h"
  25 #include "wx/sizer.h"
  26
  27 #ifndef WX_PRECOMP
  28 #include "wx/frame.h"
  29 #endif
  30
  31 #ifdef __WXMSW__
  32 #include "wx/msw/private.h"
  33 #endif
  34
  35 IMPLEMENT_CLASS(wxRibbonPanel, wxRibbonControl)
  36
  37 BEGIN_EVENT_TABLE(wxRibbonPanel, wxRibbonControl)
  38     EVT_ENTER_WINDOW(wxRibbonPanel::OnMouseEnter)
  39     EVT_ERASE_BACKGROUND(wxRibbonPanel::OnEraseBackground)
  40     EVT_KILL_FOCUS(wxRibbonPanel::OnKillFocus)
  41     EVT_LEAVE_WINDOW(wxRibbonPanel::OnMouseLeave)
  42     EVT_LEFT_DOWN(wxRibbonPanel::OnMouseClick)
  43     EVT_PAINT(wxRibbonPanel::OnPaint)
  44     EVT_SIZE(wxRibbonPanel::OnSize)
  45 END_EVENT_TABLE()
  46
  47 wxRibbonPanel::wxRibbonPanel() : m_expanded_dummy(NULL), m_expanded_panel(NULL)
  48 {
  49 }
  50
  51 wxRibbonPanel::wxRibbonPanel(wxWindow* parent,
  52                   wxWindowID id,
  53                   const wxString& label,
  54                   const wxBitmap& minimised_icon,
  55                   const wxPoint& pos,
  56                   const wxSize& size,
  57                   long style)
  58     : wxRibbonControl(parent, id, pos, size, wxBORDER_NONE)
  59 {
  60     CommonInit(label, minimised_icon, style);
  61 }
  62
  63 wxRibbonPanel::~wxRibbonPanel()
  64 {
  65     if(m_expanded_panel)
  66     {
  67         m_expanded_panel->m_expanded_dummy = NULL;
  68         m_expanded_panel->GetParent()->Destroy();
  69     }
  70 }
  71
  72 bool wxRibbonPanel::Create(wxWindow* parent,
  73                 wxWindowID id,
  74                 const wxString& label,
  75                 const wxBitmap& icon,
  76                 const wxPoint& pos,
  77                 const wxSize& size,
  78                 long style)
  79 {
  80     if(!wxRibbonControl::Create(parent, id, pos, size, wxBORDER_NONE))
  81     {
  82         return false;
  83     }
  84
  85     CommonInit(label, icon, style);
  86
  87     return true;
  88 }
  89
  90 void wxRibbonPanel::SetArtProvider(wxRibbonArtProvider* art)
  91 {
  92     m_art = art;
  93     for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
  94           node;
  95           node = node->GetNext() )
  96     {
  97         wxWindow* child = node->GetData();
  98         wxRibbonControl* ribbon_child = wxDynamicCast(child, wxRibbonControl);
  99         if(ribbon_child)
 100         {
 101             ribbon_child->SetArtProvider(art);
 102         }
 103     }
 104     if(m_expanded_panel)
 105         m_expanded_panel->SetArtProvider(art);
 106 }
 107
 108 void wxRibbonPanel::CommonInit(const wxString& label, const wxBitmap& icon, long style)
 109 {
 110     SetName(label);
 111     SetLabel(label);
 112
 113     m_minimised_size = wxDefaultSize; // Unknown / none
 114     m_smallest_unminimised_size = wxDefaultSize;// Unknown / none for IsFullySpecified()
 115     m_preferred_expand_direction = wxSOUTH;
 116     m_expanded_dummy = NULL;
 117     m_expanded_panel = NULL;
 118     m_flags = style;
 119     m_minimised_icon = icon;
 120     m_minimised = false;
 121     m_hovered = false;
 122
 123     if(m_art == NULL)
 124     {
 125         wxRibbonControl* parent = wxDynamicCast(GetParent(), wxRibbonControl);
 126         if(parent != NULL)
 127         {
 128             m_art = parent->GetArtProvider();
 129         }
 130     }
 131
 132     SetAutoLayout(true);
 133     SetBackgroundStyle(wxBG_STYLE_CUSTOM);
 134     SetMinSize(wxSize(20, 20));
 135 }
 136
 137 bool wxRibbonPanel::IsMinimised() const
 138 {
 139     return m_minimised;
 140 }
 141
 142 bool wxRibbonPanel::IsHovered() const
 143 {
 144     return m_hovered;
 145 }
 146
 147 void wxRibbonPanel::OnMouseEnter(wxMouseEvent& evt)
 148 {
 149     TestPositionForHover(evt.GetPosition());
 150 }
 151
 152 void wxRibbonPanel::OnMouseEnterChild(wxMouseEvent& evt)
 153 {
 154     wxPoint pos = evt.GetPosition();
 155     wxWindow *child = wxDynamicCast(evt.GetEventObject(), wxWindow);
 156     if(child)
 157     {
 158         pos += child->GetPosition();
 159         TestPositionForHover(pos);
 160     }
 161     evt.Skip();
 162 }
 163
 164 void wxRibbonPanel::OnMouseLeave(wxMouseEvent& evt)
 165 {
 166     TestPositionForHover(evt.GetPosition());
 167 }
 168
 169 void wxRibbonPanel::OnMouseLeaveChild(wxMouseEvent& evt)
 170 {
 171     wxPoint pos = evt.GetPosition();
 172     wxWindow *child = wxDynamicCast(evt.GetEventObject(), wxWindow);
 173     if(child)
 174     {
 175         pos += child->GetPosition();
 176         TestPositionForHover(pos);
 177     }
 178     evt.Skip();
 179 }
 180
 181 void wxRibbonPanel::TestPositionForHover(const wxPoint& pos)
 182 {
 183     bool hovered = false;
 184     if(pos.x >= 0 && pos.y >= 0)
 185     {
 186         wxSize size = GetSize();
 187         if(pos.x < size.GetWidth() && pos.y < size.GetHeight())
 188         {
 189             hovered = true;
 190         }
 191     }
 192     if(hovered != m_hovered)
 193     {
 194         m_hovered = hovered;
 195         Refresh(false);
 196     }
 197 }
 198
 199 void wxRibbonPanel::AddChild(wxWindowBase *child)
 200 {
 201     wxRibbonControl::AddChild(child);
 202
 203     // Window enter / leave events count for only the window in question, not
 204     // for children of the window. The panel wants to be in the hovered state
 205     // whenever the mouse cursor is within its boundary, so the events need to
 206     // be attached to children too.
 207     child->Connect(wxEVT_ENTER_WINDOW, (wxObjectEventFunction)&wxRibbonPanel::OnMouseEnterChild, NULL, this);
 208     child->Connect(wxEVT_LEAVE_WINDOW, (wxObjectEventFunction)&wxRibbonPanel::OnMouseLeaveChild, NULL, this);
 209 }
 210
 211 void wxRibbonPanel::RemoveChild(wxWindowBase *child)
 212 {
 213     child->Disconnect(wxEVT_ENTER_WINDOW, (wxObjectEventFunction)&wxRibbonPanel::OnMouseEnterChild, NULL, this);
 214     child->Disconnect(wxEVT_LEAVE_WINDOW, (wxObjectEventFunction)&wxRibbonPanel::OnMouseLeaveChild, NULL, this);
 215
 216     wxRibbonControl::RemoveChild(child);
 217 }
 218
 219 void wxRibbonPanel::OnSize(wxSizeEvent& evt)
 220 {
 221     if(GetAutoLayout())
 222         Layout();
 223
 224     evt.Skip();
 225 }
 226
 227 void wxRibbonPanel::DoSetSize(int x, int y, int width, int height, int sizeFlags)
 228 {
 229     // At least on MSW, changing the size of a window will cause GetSize() to
 230     // report the new size, but a size event may not be handled immediately.
 231     // If this minimised check was performed in the OnSize handler, then
 232     // GetSize() could return a size much larger than the minimised size while
 233     // IsMinimised() returns true. This would then affect layout, as the panel
 234     // will refuse to grow any larger while in limbo between minimised and non.
 235
 236     bool minimised = (m_flags & wxRIBBON_PANEL_NO_AUTO_MINIMISE) == 0 &&
 237         IsMinimised(wxSize(width, height)); // check if would be at this size
 238     if(minimised != m_minimised)
 239     {
 240         m_minimised = minimised;
 241         // Note that for sizers, this routine disallows the use of mixed shown
 242         // and hidden controls
 243         // TODO ? use some list of user set invisible children to restore status.
 244         for (wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 245                   node;
 246                   node = node->GetNext())
 247         {
 248             node->GetData()->Show(!minimised);
 249         }
 250
 251         Refresh();
 252     }
 253
 254     wxRibbonControl::DoSetSize(x, y, width, height, sizeFlags);
 255 }
 256
 257 // Checks if panel would be minimised at (client size) at_size
 258 bool wxRibbonPanel::IsMinimised(wxSize at_size) const
 259 {
 260     if(GetSizer())
 261     {
 262         // we have no information on size change direction
 263         // so check both
 264         wxSize size = GetMinNotMinimisedSize();
 265         if(size.x > at_size.x || size.y > at_size.y)
 266             return true;
 267
 268         return false;
 269     }
 270
 271     if(!m_minimised_size.IsFullySpecified())
 272         return false;
 273
 274     return (at_size.GetX() <= m_minimised_size.GetX() &&
 275         at_size.GetY() <= m_minimised_size.GetY()) ||
 276         at_size.GetX() < m_smallest_unminimised_size.GetX() ||
 277         at_size.GetY() < m_smallest_unminimised_size.GetY();
 278 }
 279
 280 void wxRibbonPanel::OnEraseBackground(wxEraseEvent& WXUNUSED(evt))
 281 {
 282     // All painting done in main paint handler to minimise flicker
 283 }
 284
 285 void wxRibbonPanel::OnPaint(wxPaintEvent& WXUNUSED(evt))
 286 {
 287     wxAutoBufferedPaintDC dc(this);
 288
 289     if(m_art != NULL)
 290     {
 291         if(IsMinimised())
 292         {
 293             m_art->DrawMinimisedPanel(dc, this, GetSize(), m_minimised_icon_resized);
 294         }
 295         else
 296         {
 297             m_art->DrawPanelBackground(dc, this, GetSize());
 298         }
 299     }
 300 }
 301
 302 bool wxRibbonPanel::IsSizingContinuous() const
 303 {
 304     // A panel never sizes continuously, even if all of its children can,
 305     // as it would appear out of place along side non-continuous panels.
 306     return false;
 307 }
 308
 309 wxSize wxRibbonPanel::DoGetNextSmallerSize(wxOrientation direction,
 310                                          wxSize relative_to) const
 311 {
 312     if(m_expanded_panel != NULL)
 313     {
 314         // Next size depends upon children, who are currently in the
 315         // expanded panel
 316         return m_expanded_panel->DoGetNextSmallerSize(direction, relative_to);
 317     }
 318
 319     if(m_art != NULL)
 320     {
 321         wxClientDC dc((wxRibbonPanel*) this);
 322         wxSize child_relative = m_art->GetPanelClientSize(dc, this, relative_to, NULL);
 323         wxSize smaller(-1, -1);
 324         bool minimise = false;
 325
 326         if(GetSizer())
 327         {
 328             // Get smallest non minimised size
 329             smaller = GetMinSize();
 330             // and adjust to child_relative for parent page
 331             if(m_art->GetFlags() & wxRIBBON_BAR_FLOW_VERTICAL)
 332             {
 333                  minimise = (child_relative.y <= smaller.y);
 334                  if(smaller.x < child_relative.x)
 335                     smaller.x = child_relative.x;
 336             }
 337             else
 338             {
 339                 minimise = (child_relative.x <= smaller.x);
 340                 if(smaller.y < child_relative.y)
 341                     smaller.y = child_relative.y;
 342             }
 343         }
 344         else if(GetChildren().GetCount() == 1)
 345         {
 346             // Simple (and common) case of single ribbon child or Sizer
 347             wxWindow* child = GetChildren().Item(0)->GetData();
 348             wxRibbonControl* ribbon_child = wxDynamicCast(child, wxRibbonControl);
 349             if(ribbon_child != NULL)
 350             {
 351                 smaller = ribbon_child->GetNextSmallerSize(direction, child_relative);
 352                 minimise = (smaller == child_relative);
 353             }
 354         }
 355
 356         if(minimise)
 357         {
 358             if(CanAutoMinimise())
 359             {
 360                 wxSize minimised = m_minimised_size;
 361                 switch(direction)
 362                 {
 363                 case wxHORIZONTAL:
 364                     minimised.SetHeight(relative_to.GetHeight());
 365                     break;
 366                 case wxVERTICAL:
 367                     minimised.SetWidth(relative_to.GetWidth());
 368                     break;
 369                 default:
 370                     break;
 371                 }
 372                 return minimised;
 373             }
 374             else
 375             {
 376                 return relative_to;
 377             }
 378         }
 379         else if(smaller.IsFullySpecified()) // Use fallback if !(sizer/child = 1)
 380         {
 381             return m_art->GetPanelSize(dc, this, smaller, NULL);
 382         }
 383     }
 384
 385     // Fallback: Decrease by 20% (or minimum size, whichever larger)
 386     wxSize current(relative_to);
 387     wxSize minimum(GetMinSize());
 388     if(direction & wxHORIZONTAL)
 389     {
 390         current.x = (current.x * 4) / 5;
 391         if(current.x < minimum.x)
 392         {
 393             current.x = minimum.x;
 394         }
 395     }
 396     if(direction & wxVERTICAL)
 397     {
 398         current.y = (current.y * 4) / 5;
 399         if(current.y < minimum.y)
 400         {
 401             current.y = minimum.y;
 402         }
 403     }
 404     return current;
 405 }
 406
 407 wxSize wxRibbonPanel::DoGetNextLargerSize(wxOrientation direction,
 408                                         wxSize relative_to) const
 409 {
 410     if(m_expanded_panel != NULL)
 411     {
 412         // Next size depends upon children, who are currently in the
 413         // expanded panel
 414         return m_expanded_panel->DoGetNextLargerSize(direction, relative_to);
 415     }
 416
 417     if(IsMinimised(relative_to))
 418     {
 419         wxSize current = relative_to;
 420         wxSize min_size = GetMinNotMinimisedSize();
 421         switch(direction)
 422         {
 423         case wxHORIZONTAL:
 424             if(min_size.x > current.x && min_size.y == current.y)
 425                 return min_size;
 426             break;
 427         case wxVERTICAL:
 428             if(min_size.x == current.x && min_size.y > current.y)
 429                 return min_size;
 430             break;
 431         case wxBOTH:
 432             if(min_size.x > current.x && min_size.y > current.y)
 433                 return min_size;
 434             break;
 435         default:
 436             break;
 437         }
 438     }
 439
 440     if(m_art != NULL)
 441     {
 442         wxClientDC dc((wxRibbonPanel*) this);
 443         wxSize child_relative = m_art->GetPanelClientSize(dc, this, relative_to, NULL);
 444         wxSize larger(-1, -1);
 445
 446         if(GetSizer())
 447         {
 448             // We could just let the sizer expand in flow direction but see comment
 449             // in IsSizingContinuous()
 450             larger = GetPanelSizerBestSize();
 451             // and adjust for page in non flow direction
 452             if(m_art->GetFlags() & wxRIBBON_BAR_FLOW_VERTICAL)
 453             {
 454                  if(larger.x != child_relative.x)
 455                     larger.x = child_relative.x;
 456             }
 457             else if(larger.y != child_relative.y)
 458             {
 459                 larger.y = child_relative.y;
 460             }
 461         }
 462         else if(GetChildren().GetCount() == 1)
 463         {
 464             // Simple (and common) case of single ribbon child
 465             wxWindow* child = GetChildren().Item(0)->GetData();
 466             wxRibbonControl* ribbon_child = wxDynamicCast(child, wxRibbonControl);
 467             if(ribbon_child != NULL)
 468             {
 469                 larger = ribbon_child->GetNextLargerSize(direction, child_relative);
 470             }
 471         }
 472
 473         if(larger.IsFullySpecified()) // Use fallback if !(sizer/child = 1)
 474         {
 475             if(larger == child_relative)
 476             {
 477                 return relative_to;
 478             }
 479             else
 480             {
 481                 return m_art->GetPanelSize(dc, this, larger, NULL);
 482             }
 483         }
 484     }
 485
 486     // Fallback: Increase by 25% (equal to a prior or subsequent 20% decrease)
 487     // Note that due to rounding errors, this increase may not exactly equal a
 488     // matching decrease - an ideal solution would not have these errors, but
 489     // avoiding them is non-trivial unless an increase is by 100% rather than
 490     // a fractional amount. This would then be non-ideal as the resizes happen
 491     // at very large intervals.
 492     wxSize current(relative_to);
 493     if(direction & wxHORIZONTAL)
 494     {
 495         current.x = (current.x * 5 + 3) / 4;
 496     }
 497     if(direction & wxVERTICAL)
 498     {
 499         current.y = (current.y * 5 + 3) / 4;
 500     }
 501     return current;
 502 }
 503
 504 bool wxRibbonPanel::CanAutoMinimise() const
 505 {
 506     return (m_flags & wxRIBBON_PANEL_NO_AUTO_MINIMISE) == 0
 507         && m_minimised_size.IsFullySpecified();
 508 }
 509
 510 wxSize wxRibbonPanel::GetMinSize() const
 511 {
 512     if(m_expanded_panel != NULL)
 513     {
 514         // Minimum size depends upon children, who are currently in the
 515         // expanded panel
 516         return m_expanded_panel->GetMinSize();
 517     }
 518
 519     if(CanAutoMinimise())
 520     {
 521         return m_minimised_size;
 522     }
 523     else
 524     {
 525         return GetMinNotMinimisedSize();
 526     }
 527 }
 528
 529 wxSize wxRibbonPanel::GetMinNotMinimisedSize() const
 530 {
 531     // Ask sizer if present
 532     if(GetSizer())
 533     {
 534         wxClientDC dc((wxRibbonPanel*) this);
 535         return m_art->GetPanelSize(dc, this, GetPanelSizerMinSize(), NULL);
 536     }
 537     else if(GetChildren().GetCount() == 1)
 538     {
 539         // Common case of single child taking up the entire panel
 540         wxWindow* child = GetChildren().Item(0)->GetData();
 541         wxClientDC dc((wxRibbonPanel*) this);
 542         return m_art->GetPanelSize(dc, this, child->GetMinSize(), NULL);
 543     }
 544
 545     return wxRibbonControl::GetMinSize();
 546 }
 547
 548 wxSize wxRibbonPanel::GetPanelSizerMinSize() const
 549 {
 550     // Called from Realize() to set m_smallest_unminimised_size and from other
 551     // functions to get the minimum size.
 552     // The panel will be invisible when minimised and sizer calcs will be 0
 553     // Uses m_smallest_unminimised_size in preference to GetSizer()->CalcMin()
 554     // to eliminate flicker.
 555
 556     // Check if is visible and not previously calculated
 557     if(IsShown() && !m_smallest_unminimised_size.IsFullySpecified())
 558     {
 559          return GetSizer()->CalcMin();
 560     }
 561     // else use previously calculated m_smallest_unminimised_size
 562     wxClientDC dc((wxRibbonPanel*) this);
 563     return m_art->GetPanelClientSize(dc,
 564                                     this,
 565                                     m_smallest_unminimised_size,
 566                                     NULL);
 567 }
 568
 569 wxSize wxRibbonPanel::GetPanelSizerBestSize() const
 570 {
 571     wxSize size = GetPanelSizerMinSize();
 572     // TODO allow panel to increase its size beyond minimum size
 573     // by steps similarly to ribbon control panels (preferred for aesthetics)
 574     // or continuously.
 575     return size;
 576 }
 577
 578 wxSize wxRibbonPanel::DoGetBestSize() const
 579 {
 580     // Ask sizer if present
 581     if( GetSizer())
 582     {
 583         wxClientDC dc((wxRibbonPanel*) this);
 584         return m_art->GetPanelSize(dc, this, GetPanelSizerBestSize(), NULL);
 585     }
 586     else if(GetChildren().GetCount() == 1)
 587     {
 588         // Common case of no sizer and single child taking up the entire panel
 589         wxWindow* child = GetChildren().Item(0)->GetData();
 590         wxClientDC dc((wxRibbonPanel*) this);
 591         return m_art->GetPanelSize(dc, this, child->GetBestSize(), NULL);
 592     }
 593
 594     return wxRibbonControl::DoGetBestSize();
 595 }
 596
 597 bool wxRibbonPanel::Realize()
 598 {
 599     bool status = true;
 600
 601     for (wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 602                   node;
 603                   node = node->GetNext())
 604     {
 605         wxRibbonControl* child = wxDynamicCast(node->GetData(), wxRibbonControl);
 606         if(child == NULL)
 607         {
 608             continue;
 609         }
 610         if(!child->Realize())
 611         {
 612             status = false;
 613         }
 614     }
 615
 616     wxSize minimum_children_size(0, 0);
 617
 618     // Ask sizer if there is one present
 619     if(GetSizer())
 620     {
 621         minimum_children_size = GetPanelSizerMinSize();
 622     }
 623     else if(GetChildren().GetCount() == 1)
 624     {
 625         minimum_children_size = GetChildren().GetFirst()->GetData()->GetMinSize();
 626     }
 627
 628     if(m_art != NULL)
 629     {
 630         wxClientDC temp_dc(this);
 631
 632         m_smallest_unminimised_size =
 633             m_art->GetPanelSize(temp_dc, this, minimum_children_size, NULL);
 634
 635         wxSize bitmap_size;
 636         wxSize panel_min_size = GetMinNotMinimisedSize();
 637         m_minimised_size = m_art->GetMinimisedPanelMinimumSize(temp_dc, this,
 638             &bitmap_size, &m_preferred_expand_direction);
 639         if(m_minimised_icon.IsOk() && m_minimised_icon.GetSize() != bitmap_size)
 640         {
 641             wxImage img(m_minimised_icon.ConvertToImage());
 642             img.Rescale(bitmap_size.GetWidth(), bitmap_size.GetHeight(), wxIMAGE_QUALITY_HIGH);
 643             m_minimised_icon_resized = wxBitmap(img);
 644         }
 645         else
 646         {
 647             m_minimised_icon_resized = m_minimised_icon;
 648         }
 649         if(m_minimised_size.x > panel_min_size.x &&
 650             m_minimised_size.y > panel_min_size.y)
 651         {
 652             // No point in having a minimised size which is larger than the
 653             // minimum size which the children can go to.
 654             m_minimised_size = wxSize(-1, -1);
 655         }
 656         else
 657         {
 658             if(m_art->GetFlags() & wxRIBBON_BAR_FLOW_VERTICAL)
 659             {
 660                 m_minimised_size.x = panel_min_size.x;
 661             }
 662             else
 663             {
 664                 m_minimised_size.y = panel_min_size.y;
 665             }
 666         }
 667     }
 668     else
 669     {
 670         m_minimised_size = wxSize(-1, -1);
 671     }
 672
 673     return Layout() && status;
 674 }
 675
 676 bool wxRibbonPanel::Layout()
 677 {
 678     if(IsMinimised())
 679     {
 680         // Children are all invisible when minimised
 681         return true;
 682     }
 683
 684     // Get wxRibbonPanel client size
 685     wxPoint position;
 686     wxClientDC dc(this);
 687     wxSize size = m_art->GetPanelClientSize(dc, this, GetSize(), &position);
 688
 689     // If there is a sizer, use it
 690     if(GetSizer())
 691     {
 692         GetSizer()->SetDimension(position, size); // SetSize and Layout()
 693     }
 694     else if(GetChildren().GetCount() == 1)
 695     {
 696         // Common case of no sizer and single child taking up the entire panel
 697         wxWindow* child = GetChildren().Item(0)->GetData();
 698         child->SetSize(position.x, position.y, size.GetWidth(), size.GetHeight());
 699     }
 700     return true;
 701 }
 702
 703 void wxRibbonPanel::OnMouseClick(wxMouseEvent& WXUNUSED(evt))
 704 {
 705     if(IsMinimised())
 706     {
 707         if(m_expanded_panel != NULL)
 708         {
 709             HideExpanded();
 710         }
 711         else
 712         {
 713             ShowExpanded();
 714         }
 715     }
 716 }
 717
 718 wxRibbonPanel* wxRibbonPanel::GetExpandedDummy()
 719 {
 720     return m_expanded_dummy;
 721 }
 722
 723 wxRibbonPanel* wxRibbonPanel::GetExpandedPanel()
 724 {
 725     return m_expanded_panel;
 726 }
 727
 728 bool wxRibbonPanel::ShowExpanded()
 729 {
 730     if(!IsMinimised())
 731     {
 732         return false;
 733     }
 734     if(m_expanded_dummy != NULL || m_expanded_panel != NULL)
 735     {
 736         return false;
 737     }
 738
 739     wxSize size = GetBestSize();
 740     wxPoint pos = GetExpandedPosition(wxRect(GetScreenPosition(), GetSize()),
 741         size, m_preferred_expand_direction).GetTopLeft();
 742
 743     // Need a top-level frame to contain the expanded panel
 744     wxFrame *container = new wxFrame(NULL, wxID_ANY, GetLabel(),
 745         pos, size, wxFRAME_NO_TASKBAR | wxBORDER_NONE);
 746
 747     m_expanded_panel = new wxRibbonPanel(container, wxID_ANY,
 748         GetLabel(), m_minimised_icon, wxPoint(0, 0), size, m_flags);
 749
 750     m_expanded_panel->SetArtProvider(m_art);
 751     m_expanded_panel->m_expanded_dummy = this;
 752
 753     // Move all children to the new panel.
 754     // Conceptually it might be simpler to reparent this entire panel to the
 755     // container and create a new panel to sit in its place while expanded.
 756     // This approach has a problem though - when the panel is reinserted into
 757     // its original parent, it'll be at a different position in the child list
 758     // and thus assume a new position.
 759     // NB: Children iterators not used as behaviour is not well defined
 760     // when iterating over a container which is being emptied
 761     while(!GetChildren().IsEmpty())
 762     {
 763         wxWindow *child = GetChildren().GetFirst()->GetData();
 764         child->Reparent(m_expanded_panel);
 765         child->Show();
 766     }
 767
 768     // Move sizer to new panel
 769     if(GetSizer())
 770     {
 771         wxSizer* sizer = GetSizer();
 772         SetSizer(NULL, false);
 773         m_expanded_panel->SetSizer(sizer);
 774     }
 775
 776     m_expanded_panel->Realize();
 777     Refresh();
 778     container->SetMinClientSize(size);
 779     container->Show();
 780     m_expanded_panel->SetFocus();
 781
 782     return true;
 783 }
 784
 785 bool wxRibbonPanel::ShouldSendEventToDummy(wxEvent& evt)
 786 {
 787     // For an expanded panel, filter events between being sent up to the
 788     // floating top level window or to the dummy panel sitting in the ribbon
 789     // bar.
 790
 791     // Child focus events should not be redirected, as the child would not be a
 792     // child of the window the event is redirected to. All other command events
 793     // seem to be suitable for redirecting.
 794     return evt.IsCommandEvent() && evt.GetEventType() != wxEVT_CHILD_FOCUS;
 795 }
 796
 797 bool wxRibbonPanel::TryAfter(wxEvent& evt)
 798 {
 799     if(m_expanded_dummy && ShouldSendEventToDummy(evt))
 800     {
 801         wxPropagateOnce propagateOnce(evt);
 802         return m_expanded_dummy->GetEventHandler()->ProcessEvent(evt);
 803     }
 804     else
 805     {
 806         return wxRibbonControl::TryAfter(evt);
 807     }
 808 }
 809
 810 static bool IsAncestorOf(wxWindow *ancestor, wxWindow *window)
 811 {
 812     while(window != NULL)
 813     {
 814         wxWindow *parent = window->GetParent();
 815         if(parent == ancestor)
 816             return true;
 817         else
 818             window = parent;
 819     }
 820     return false;
 821 }
 822
 823 void wxRibbonPanel::OnKillFocus(wxFocusEvent& evt)
 824 {
 825     if(m_expanded_dummy)
 826     {
 827         wxWindow *receiver = evt.GetWindow();
 828         if(IsAncestorOf(this, receiver))
 829         {
 830             m_child_with_focus = receiver;
 831             receiver->Connect(wxEVT_KILL_FOCUS,
 832                 wxFocusEventHandler(wxRibbonPanel::OnChildKillFocus),
 833                 NULL, this);
 834         }
 835         else if(receiver == NULL || receiver != m_expanded_dummy)
 836         {
 837             HideExpanded();
 838         }
 839     }
 840 }
 841
 842 void wxRibbonPanel::OnChildKillFocus(wxFocusEvent& evt)
 843 {
 844     if(m_child_with_focus == NULL)
 845         return; // Should never happen, but a check can't hurt
 846
 847     m_child_with_focus->Disconnect(wxEVT_KILL_FOCUS,
 848       wxFocusEventHandler(wxRibbonPanel::OnChildKillFocus), NULL, this);
 849     m_child_with_focus = NULL;
 850
 851     wxWindow *receiver = evt.GetWindow();
 852     if(receiver == this || IsAncestorOf(this, receiver))
 853     {
 854         m_child_with_focus = receiver;
 855         receiver->Connect(wxEVT_KILL_FOCUS,
 856             wxFocusEventHandler(wxRibbonPanel::OnChildKillFocus), NULL, this);
 857         evt.Skip();
 858     }
 859     else if(receiver == NULL || receiver != m_expanded_dummy)
 860     {
 861         HideExpanded();
 862         // Do not skip event, as the panel has been de-expanded, causing the
 863         // child with focus to be reparented (and hidden). If the event
 864         // continues propogation then bad things happen.
 865     }
 866     else
 867     {
 868         evt.Skip();
 869     }
 870 }
 871
 872 bool wxRibbonPanel::HideExpanded()
 873 {
 874     if(m_expanded_dummy == NULL)
 875     {
 876         if(m_expanded_panel)
 877         {
 878             return m_expanded_panel->HideExpanded();
 879         }
 880         else
 881         {
 882             return false;
 883         }
 884     }
 885
 886     // Move children back to original panel
 887     // NB: Children iterators not used as behaviour is not well defined
 888     // when iterating over a container which is being emptied
 889     while(!GetChildren().IsEmpty())
 890     {
 891         wxWindow *child = GetChildren().GetFirst()->GetData();
 892         child->Reparent(m_expanded_dummy);
 893         child->Hide();
 894     }
 895
 896     // Move sizer back
 897     if(GetSizer())
 898     {
 899         wxSizer* sizer = GetSizer();
 900         SetSizer(NULL, false);
 901         m_expanded_dummy->SetSizer(sizer);
 902     }
 903
 904     m_expanded_dummy->m_expanded_panel = NULL;
 905     m_expanded_dummy->Realize();
 906     m_expanded_dummy->Refresh();
 907     wxWindow *parent = GetParent();
 908     Destroy();
 909     parent->Destroy();
 910
 911     return true;
 912 }
 913
 914 wxRect wxRibbonPanel::GetExpandedPosition(wxRect panel,
 915                                           wxSize expanded_size,
 916                                           wxDirection direction)
 917 {
 918     // Strategy:
 919     // 1) Determine primary position based on requested direction
 920     // 2) Move the position so that it sits entirely within a display
 921     //    (for single monitor systems, this moves it into the display region,
 922     //     but for multiple monitors, it does so without splitting it over
 923     //     more than one display)
 924     // 2.1) Move in the primary axis
 925     // 2.2) Move in the secondary axis
 926
 927     wxPoint pos;
 928     bool primary_x = false;
 929     int secondary_x = 0;
 930     int secondary_y = 0;
 931     switch(direction)
 932     {
 933     case wxNORTH:
 934         pos.x = panel.GetX() + (panel.GetWidth() - expanded_size.GetWidth()) / 2;
 935         pos.y = panel.GetY() - expanded_size.GetHeight();
 936         primary_x = true;
 937         secondary_y = 1;
 938         break;
 939     case wxEAST:
 940         pos.x = panel.GetRight();
 941         pos.y = panel.GetY() + (panel.GetHeight() - expanded_size.GetHeight()) / 2;
 942         secondary_x = -1;
 943         break;
 944     case wxSOUTH:
 945         pos.x = panel.GetX() + (panel.GetWidth() - expanded_size.GetWidth()) / 2;
 946         pos.y = panel.GetBottom();
 947         primary_x = true;
 948         secondary_y = -1;
 949         break;
 950     case wxWEST:
 951     default:
 952         pos.x = panel.GetX() - expanded_size.GetWidth();
 953         pos.y = panel.GetY() + (panel.GetHeight() - expanded_size.GetHeight()) / 2;
 954         secondary_x = 1;
 955         break;
 956     }
 957     wxRect expanded(pos, expanded_size);
 958
 959     wxRect best(expanded);
 960     int best_distance = INT_MAX;
 961
 962     const unsigned display_n = wxDisplay::GetCount();
 963     unsigned display_i;
 964     for(display_i = 0; display_i < display_n; ++display_i)
 965     {
 966         wxRect display = wxDisplay(display_i).GetGeometry();
 967
 968         if(display.Contains(expanded))
 969         {
 970             return expanded;
 971         }
 972         else if(display.Intersects(expanded))
 973         {
 974             wxRect new_rect(expanded);
 975             int distance = 0;
 976
 977             if(primary_x)
 978             {
 979                 if(expanded.GetRight() > display.GetRight())
 980                 {
 981                     distance = expanded.GetRight() - display.GetRight();
 982                     new_rect.x -= distance;
 983                 }
 984                 else if(expanded.GetLeft() < display.GetLeft())
 985                 {
 986                     distance = display.GetLeft() - expanded.GetLeft();
 987                     new_rect.x += distance;
 988                 }
 989             }
 990             else
 991             {
 992                 if(expanded.GetBottom() > display.GetBottom())
 993                 {
 994                     distance = expanded.GetBottom() - display.GetBottom();
 995                     new_rect.y -= distance;
 996                 }
 997                 else if(expanded.GetTop() < display.GetTop())
 998                 {
 999                     distance = display.GetTop() - expanded.GetTop();
1000                     new_rect.y += distance;
1001                 }
1002             }
1003             if(!display.Contains(new_rect))
1004             {
1005                 // Tried moving in primary axis, but failed.
1006                 // Hence try moving in the secondary axis.
1007                 int dx = secondary_x * (panel.GetWidth() + expanded_size.GetWidth());
1008                 int dy = secondary_y * (panel.GetHeight() + expanded_size.GetHeight());
1009                 new_rect.x += dx;
1010                 new_rect.y += dy;
1011
1012                 // Squaring makes secondary moves more expensive (and also
1013                 // prevents a negative cost)
1014                 distance += dx * dx + dy * dy;
1015             }
1016             if(display.Contains(new_rect) && distance < best_distance)
1017             {
1018                 best = new_rect;
1019                 best_distance = distance;
1020             }
1021         }
1022     }
1023
1024     return best;
1025 }
1026
1027 #endif // wxUSE_RIBBON