src/ribbon/page.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/ribbon/page.cpp
   3 // Purpose:     Container for ribbon-bar-style interface panels
   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 #include "wx/wxprec.h"
  12
  13 #ifdef __BORLANDC__
  14     #pragma hdrstop
  15 #endif
  16
  17 #include "wx/ribbon/page.h"
  18
  19 #if wxUSE_RIBBON
  20
  21 #include "wx/ribbon/art.h"
  22 #include "wx/ribbon/bar.h"
  23 #include "wx/dcbuffer.h"
  24
  25 #ifndef WX_PRECOMP
  26 #endif
  27
  28 #ifdef __WXMSW__
  29 #include "wx/msw/private.h"
  30 #endif
  31
  32 static int GetSizeInOrientation(wxSize size, wxOrientation orientation);
  33
  34 // As scroll buttons need to be rendered on top of a page's child windows, the
  35 // buttons themselves have to be proper child windows (rather than just painted
  36 // onto the page). In order to get proper clipping of a page's children (with
  37 // regard to the scroll button), the scroll buttons are created as children of
  38 // the ribbon bar rather than children of the page. This could not have been
  39 // achieved by creating buttons as children of the page and then doing some Z-order
  40 // manipulation, as this causes problems on win32 due to ribbon panels having the
  41 // transparent flag set.
  42 class wxRibbonPageScrollButton : public wxRibbonControl
  43 {
  44 public:
  45     wxRibbonPageScrollButton(wxRibbonPage* sibling,
  46                  wxWindowID id = wxID_ANY,
  47                  const wxPoint& pos = wxDefaultPosition,
  48                  const wxSize& size = wxDefaultSize,
  49                  long style = 0);
  50
  51     virtual ~wxRibbonPageScrollButton();
  52
  53 protected:
  54     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
  55
  56     void OnEraseBackground(wxEraseEvent& evt);
  57     void OnPaint(wxPaintEvent& evt);
  58     void OnMouseEnter(wxMouseEvent& evt);
  59     void OnMouseLeave(wxMouseEvent& evt);
  60     void OnMouseDown(wxMouseEvent& evt);
  61     void OnMouseUp(wxMouseEvent& evt);
  62
  63     wxRibbonPage* m_sibling;
  64     long m_flags;
  65
  66     DECLARE_CLASS(wxRibbonPageScrollButton)
  67     DECLARE_EVENT_TABLE()
  68 };
  69
  70 IMPLEMENT_CLASS(wxRibbonPageScrollButton, wxRibbonControl)
  71
  72 BEGIN_EVENT_TABLE(wxRibbonPageScrollButton, wxRibbonControl)
  73     EVT_ENTER_WINDOW(wxRibbonPageScrollButton::OnMouseEnter)
  74     EVT_ERASE_BACKGROUND(wxRibbonPageScrollButton::OnEraseBackground)
  75     EVT_LEAVE_WINDOW(wxRibbonPageScrollButton::OnMouseLeave)
  76     EVT_LEFT_DOWN(wxRibbonPageScrollButton::OnMouseDown)
  77     EVT_LEFT_UP(wxRibbonPageScrollButton::OnMouseUp)
  78     EVT_PAINT(wxRibbonPageScrollButton::OnPaint)
  79 END_EVENT_TABLE()
  80
  81 wxRibbonPageScrollButton::wxRibbonPageScrollButton(wxRibbonPage* sibling,
  82                  wxWindowID id,
  83                  const wxPoint& pos,
  84                  const wxSize& size,
  85                  long style) : wxRibbonControl(sibling->GetParent(), id, pos, size, wxBORDER_NONE)
  86 {
  87     SetBackgroundStyle(wxBG_STYLE_CUSTOM);
  88     m_sibling = sibling;
  89     m_flags = (style & wxRIBBON_SCROLL_BTN_DIRECTION_MASK) | wxRIBBON_SCROLL_BTN_FOR_PAGE;
  90 }
  91
  92 wxRibbonPageScrollButton::~wxRibbonPageScrollButton()
  93 {
  94 }
  95
  96 void wxRibbonPageScrollButton::OnEraseBackground(wxEraseEvent& WXUNUSED(evt))
  97 {
  98     // Do nothing - all painting done in main paint handler
  99 }
 100
 101 void wxRibbonPageScrollButton::OnPaint(wxPaintEvent& WXUNUSED(evt))
 102 {
 103     wxAutoBufferedPaintDC dc(this);
 104     if(m_art)
 105     {
 106         m_art->DrawScrollButton(dc, this, GetSize(), m_flags);
 107     }
 108 }
 109
 110 void wxRibbonPageScrollButton::OnMouseEnter(wxMouseEvent& WXUNUSED(evt))
 111 {
 112     m_flags |= wxRIBBON_SCROLL_BTN_HOVERED;
 113     Refresh(false);
 114 }
 115
 116 void wxRibbonPageScrollButton::OnMouseLeave(wxMouseEvent& WXUNUSED(evt))
 117 {
 118     m_flags &= ~wxRIBBON_SCROLL_BTN_HOVERED;
 119     m_flags &= ~wxRIBBON_SCROLL_BTN_ACTIVE;
 120     Refresh(false);
 121 }
 122
 123 void wxRibbonPageScrollButton::OnMouseDown(wxMouseEvent& WXUNUSED(evt))
 124 {
 125     m_flags |= wxRIBBON_SCROLL_BTN_ACTIVE;
 126     Refresh(false);
 127 }
 128
 129 void wxRibbonPageScrollButton::OnMouseUp(wxMouseEvent& WXUNUSED(evt))
 130 {
 131     if(m_flags & wxRIBBON_SCROLL_BTN_ACTIVE)
 132     {
 133         m_flags &= ~wxRIBBON_SCROLL_BTN_ACTIVE;
 134         Refresh(false);
 135         switch(m_flags & wxRIBBON_SCROLL_BTN_DIRECTION_MASK)
 136         {
 137         case wxRIBBON_SCROLL_BTN_DOWN:
 138         case wxRIBBON_SCROLL_BTN_RIGHT:
 139             m_sibling->ScrollLines(1);
 140             break;
 141         case wxRIBBON_SCROLL_BTN_UP:
 142         case wxRIBBON_SCROLL_BTN_LEFT:
 143             m_sibling->ScrollLines(-1);
 144             break;
 145         default:
 146             break;
 147         }
 148     }
 149 }
 150
 151 IMPLEMENT_CLASS(wxRibbonPage, wxRibbonControl)
 152
 153 BEGIN_EVENT_TABLE(wxRibbonPage, wxRibbonControl)
 154     EVT_ERASE_BACKGROUND(wxRibbonPage::OnEraseBackground)
 155     EVT_PAINT(wxRibbonPage::OnPaint)
 156     EVT_SIZE(wxRibbonPage::OnSize)
 157 END_EVENT_TABLE()
 158
 159 wxRibbonPage::wxRibbonPage()
 160 {
 161     m_scroll_left_btn = NULL;
 162     m_scroll_right_btn = NULL;
 163     m_scroll_amount = 0;
 164     m_scroll_buttons_visible = false;
 165 }
 166
 167 wxRibbonPage::wxRibbonPage(wxRibbonBar* parent,
 168                    wxWindowID id,
 169                    const wxString& label,
 170                    const wxBitmap& icon,
 171                    long WXUNUSED(style))
 172     : wxRibbonControl(parent, id, wxDefaultPosition, wxDefaultSize, wxBORDER_NONE)
 173 {
 174     CommonInit(label, icon);
 175 }
 176
 177 wxRibbonPage::~wxRibbonPage()
 178 {
 179     delete[] m_size_calc_array;
 180 }
 181
 182 bool wxRibbonPage::Create(wxRibbonBar* parent,
 183                 wxWindowID id,
 184                 const wxString& label,
 185                 const wxBitmap& icon,
 186                 long WXUNUSED(style))
 187 {
 188     if(!wxRibbonControl::Create(parent, id, wxDefaultPosition, wxDefaultSize, wxBORDER_NONE))
 189         return false;
 190
 191     CommonInit(label, icon);
 192
 193     return true;
 194 }
 195
 196 void wxRibbonPage::CommonInit(const wxString& label, const wxBitmap& icon)
 197 {
 198     SetName(label);
 199
 200     SetLabel(label);
 201     m_old_size = wxSize(0, 0);
 202     m_icon = icon;
 203     m_scroll_left_btn = NULL;
 204     m_scroll_right_btn = NULL;
 205     m_size_calc_array = NULL;
 206     m_size_calc_array_size = 0;
 207     m_scroll_amount = 0;
 208     m_scroll_buttons_visible = false;
 209
 210     SetBackgroundStyle(wxBG_STYLE_CUSTOM);
 211
 212     wxDynamicCast(GetParent(), wxRibbonBar)->AddPage(this);
 213 }
 214
 215 void wxRibbonPage::SetArtProvider(wxRibbonArtProvider* art)
 216 {
 217     m_art = art;
 218     for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 219           node;
 220           node = node->GetNext() )
 221     {
 222         wxWindow* child = node->GetData();
 223         wxRibbonControl* ribbon_child = wxDynamicCast(child, wxRibbonControl);
 224         if(ribbon_child)
 225         {
 226             ribbon_child->SetArtProvider(art);
 227         }
 228     }
 229 }
 230
 231 void wxRibbonPage::AdjustRectToIncludeScrollButtons(wxRect* rect) const
 232 {
 233     if(m_scroll_buttons_visible)
 234     {
 235         if(GetMajorAxis() == wxVERTICAL)
 236         {
 237             if(m_scroll_left_btn)
 238             {
 239                 rect->SetY(rect->GetY() -
 240                     m_scroll_left_btn->GetSize().GetHeight());
 241                 rect->SetHeight(rect->GetHeight() +
 242                     m_scroll_left_btn->GetSize().GetHeight());
 243             }
 244             if(m_scroll_right_btn)
 245             {
 246                 rect->SetHeight(rect->GetHeight() +
 247                     m_scroll_right_btn->GetSize().GetHeight());
 248             }
 249         }
 250         else
 251         {
 252             if(m_scroll_left_btn)
 253             {
 254                 rect->SetX(rect->GetX() -
 255                     m_scroll_left_btn->GetSize().GetWidth());
 256                 rect->SetWidth(rect->GetWidth() +
 257                     m_scroll_left_btn->GetSize().GetWidth());
 258             }
 259             if(m_scroll_right_btn)
 260             {
 261                 rect->SetWidth(rect->GetWidth() +
 262                     m_scroll_right_btn->GetSize().GetWidth());
 263             }
 264         }
 265     }
 266 }
 267
 268 void wxRibbonPage::OnEraseBackground(wxEraseEvent& WXUNUSED(evt))
 269 {
 270     // All painting done in main paint handler to minimise flicker
 271 }
 272
 273 void wxRibbonPage::OnPaint(wxPaintEvent& WXUNUSED(evt))
 274 {
 275     // No foreground painting done by the page itself, but a paint DC
 276     // must be created anyway.
 277     wxAutoBufferedPaintDC dc(this);
 278     wxRect rect(GetSize());
 279     AdjustRectToIncludeScrollButtons(&rect);
 280     m_art->DrawPageBackground(dc, this, rect);
 281 }
 282
 283 wxOrientation wxRibbonPage::GetMajorAxis() const
 284 {
 285     if(m_art && (m_art->GetFlags() & wxRIBBON_BAR_FLOW_VERTICAL))
 286     {
 287         return wxVERTICAL;
 288     }
 289     else
 290     {
 291         return wxHORIZONTAL;
 292     }
 293 }
 294
 295 bool wxRibbonPage::ScrollLines(int lines)
 296 {
 297     return ScrollPixels(lines * 8);
 298 }
 299
 300 bool wxRibbonPage::ScrollPixels(int pixels)
 301 {
 302     if(pixels < 0)
 303     {
 304         if(m_scroll_amount == 0)
 305             return false;
 306         if(m_scroll_amount < -pixels)
 307             pixels = -m_scroll_amount;
 308     }
 309     else if(pixels > 0)
 310     {
 311         if(m_scroll_amount == m_scroll_amount_limit)
 312             return false;
 313         if(m_scroll_amount + pixels > m_scroll_amount_limit)
 314             pixels = m_scroll_amount_limit - m_scroll_amount;
 315     }
 316     else
 317         return false;
 318
 319     m_scroll_amount += pixels;
 320
 321     for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 322               node;
 323               node = node->GetNext() )
 324     {
 325         wxWindow* child = node->GetData();
 326         int x, y;
 327         child->GetPosition(&x, &y);
 328         if(GetMajorAxis() == wxHORIZONTAL)
 329             x -= pixels;
 330         else
 331             y -= pixels;
 332         child->SetPosition(wxPoint(x, y));
 333     }
 334
 335     ShowScrollButtons();
 336     Refresh();
 337     return true;
 338 }
 339
 340 void wxRibbonPage::SetSizeWithScrollButtonAdjustment(int x, int y, int width, int height)
 341 {
 342     if(m_scroll_buttons_visible)
 343     {
 344         if(GetMajorAxis() == wxHORIZONTAL)
 345         {
 346             if(m_scroll_left_btn)
 347             {
 348                 int w = m_scroll_left_btn->GetSize().GetWidth();
 349                 m_scroll_left_btn->SetPosition(wxPoint(x, y));
 350                 x += w;
 351                 width -= w;
 352             }
 353             if(m_scroll_right_btn)
 354             {
 355                 int w = m_scroll_right_btn->GetSize().GetWidth();
 356                 width -= w;
 357                 m_scroll_right_btn->SetPosition(wxPoint(x + width, y));
 358             }
 359         }
 360         else
 361         {
 362             if(m_scroll_left_btn)
 363             {
 364                 int h = m_scroll_left_btn->GetSize().GetHeight();
 365                 m_scroll_left_btn->SetPosition(wxPoint(x, y));
 366                 y += h;
 367                 height -= h;
 368             }
 369             if(m_scroll_right_btn)
 370             {
 371                 int h = m_scroll_right_btn->GetSize().GetHeight();
 372                 height -= h;
 373                 m_scroll_right_btn->SetPosition(wxPoint(x, y + height));
 374             }
 375         }
 376     }
 377     SetSize(x, y, width, height);
 378 }
 379
 380 void wxRibbonPage::DoSetSize(int x, int y, int width, int height, int sizeFlags)
 381 {
 382     // When a resize triggers the scroll buttons to become visible, the page is resized.
 383     // This resize from within a resize event can cause (MSW) wxWidgets some confusion,
 384     // and report the 1st size to the 2nd size event. Hence the most recent size is
 385     // remembered internally and used in Layout() where appropiate.
 386
 387     if(GetMajorAxis() == wxHORIZONTAL)
 388     {
 389         m_size_in_major_axis_for_children = width;
 390         if(m_scroll_buttons_visible)
 391         {
 392             if(m_scroll_left_btn)
 393                 m_size_in_major_axis_for_children += m_scroll_left_btn->GetSize().GetWidth();
 394             if(m_scroll_right_btn)
 395                 m_size_in_major_axis_for_children += m_scroll_right_btn->GetSize().GetWidth();
 396         }
 397     }
 398     else
 399     {
 400         m_size_in_major_axis_for_children = height;
 401         if(m_scroll_buttons_visible)
 402         {
 403             if(m_scroll_left_btn)
 404                 m_size_in_major_axis_for_children += m_scroll_left_btn->GetSize().GetHeight();
 405             if(m_scroll_right_btn)
 406                 m_size_in_major_axis_for_children += m_scroll_right_btn->GetSize().GetHeight();
 407         }
 408     }
 409
 410     wxRibbonControl::DoSetSize(x, y, width, height, sizeFlags);
 411 }
 412
 413 void wxRibbonPage::OnSize(wxSizeEvent& evt)
 414 {
 415     wxSize new_size = evt.GetSize();
 416
 417     wxMemoryDC temp_dc;
 418     wxRect invalid_rect = m_art->GetPageBackgroundRedrawArea(temp_dc, this, m_old_size, new_size);
 419     Refresh(true, &invalid_rect);
 420
 421     m_old_size = new_size;
 422
 423     if(new_size.GetX() > 0 && new_size.GetY() > 0)
 424     {
 425         Layout();
 426     }
 427     else
 428     {
 429         // Simplify other calculations by pretending new size is zero in both
 430         // X and Y
 431         new_size.Set(0, 0);
 432         // When size == 0, no point in doing any layout
 433     }
 434
 435     evt.Skip();
 436 }
 437
 438 void wxRibbonPage::RemoveChild(wxWindowBase *child)
 439 {
 440     // Remove all references to the child from the collapse stack
 441     size_t count = m_collapse_stack.GetCount();
 442     size_t src, dst;
 443     for(src = 0, dst = 0; src < count; ++src, ++dst)
 444     {
 445         wxRibbonControl *item = m_collapse_stack.Item(src);
 446         if(item == child)
 447         {
 448             ++src;
 449             if(src == count)
 450             {
 451                 break;
 452             }
 453         }
 454         if(src != dst)
 455         {
 456             m_collapse_stack.Item(dst) = item;
 457         }
 458     }
 459     if(src > dst)
 460     {
 461         m_collapse_stack.RemoveAt(dst, src - dst);
 462     }
 463
 464     // ... and then proceed as normal
 465     wxRibbonControl::RemoveChild(child);
 466 }
 467
 468 bool wxRibbonPage::Realize()
 469 {
 470     bool status = true;
 471
 472     m_collapse_stack.Clear();
 473     for (wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 474                   node;
 475                   node = node->GetNext())
 476     {
 477         wxRibbonControl* child = wxDynamicCast(node->GetData(), wxRibbonControl);
 478         if(child == NULL)
 479         {
 480             continue;
 481         }
 482         if(!child->Realize())
 483         {
 484             status = false;
 485         }
 486     }
 487     PopulateSizeCalcArray(&wxWindow::GetMinSize);
 488
 489     return DoActualLayout() && status;
 490 }
 491
 492 void wxRibbonPage::PopulateSizeCalcArray(wxSize (wxWindow::*get_size)(void) const)
 493 {
 494     if(m_size_calc_array_size != GetChildren().GetCount())
 495     {
 496         delete[] m_size_calc_array;
 497         m_size_calc_array_size = GetChildren().GetCount();
 498         m_size_calc_array = new wxSize[m_size_calc_array_size];
 499     }
 500     wxSize* node_size = m_size_calc_array;
 501     for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 502           node;
 503           node = node->GetNext(), ++node_size )
 504     {
 505         wxWindow* child = node->GetData();
 506         *node_size = (child->*get_size)();
 507     }
 508 }
 509
 510 bool wxRibbonPage::Layout()
 511 {
 512     if(GetChildren().GetCount() == 0)
 513     {
 514         return true;
 515     }
 516     else
 517     {
 518         PopulateSizeCalcArray(&wxWindow::GetSize);
 519         return DoActualLayout();
 520     }
 521 }
 522
 523 bool wxRibbonPage::DoActualLayout()
 524 {
 525     wxPoint origin(m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_LEFT_SIZE), m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_TOP_SIZE));
 526     wxOrientation major_axis = GetMajorAxis();
 527     int gap;
 528     int minor_axis_size;
 529     int available_space;
 530     if(major_axis == wxHORIZONTAL)
 531     {
 532         gap = m_art->GetMetric(wxRIBBON_ART_PANEL_X_SEPARATION_SIZE);
 533         minor_axis_size = GetSize().GetHeight() - origin.y - m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_BOTTOM_SIZE);
 534         available_space = m_size_in_major_axis_for_children - m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_RIGHT_SIZE) - origin.x;
 535     }
 536     else
 537     {
 538         gap = m_art->GetMetric(wxRIBBON_ART_PANEL_Y_SEPARATION_SIZE);
 539         minor_axis_size = GetSize().GetWidth() - origin.x - m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_RIGHT_SIZE);
 540         available_space = m_size_in_major_axis_for_children - m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_BOTTOM_SIZE) - origin.y;
 541     }
 542     size_t size_index;
 543     for(size_index = 0; size_index < m_size_calc_array_size; ++size_index)
 544     {
 545         if(major_axis == wxHORIZONTAL)
 546         {
 547             available_space -= m_size_calc_array[size_index].GetWidth();
 548             m_size_calc_array[size_index].SetHeight(minor_axis_size);
 549         }
 550         else
 551         {
 552             available_space -= m_size_calc_array[size_index].GetHeight();
 553             m_size_calc_array[size_index].SetWidth(minor_axis_size);
 554         }
 555         if(size_index != 0)
 556             available_space -= gap;
 557     }
 558     bool todo_hide_scroll_buttons = false;
 559     bool todo_show_scroll_buttons = false;
 560     if(available_space >= 0)
 561     {
 562         if(m_scroll_buttons_visible)
 563             todo_hide_scroll_buttons = true;
 564         if(available_space > 0)
 565             ExpandPanels(major_axis, available_space);
 566     }
 567     else
 568     {
 569         if(m_scroll_buttons_visible)
 570         {
 571             // Scroll buttons already visible - not going to be able to downsize any more
 572             m_scroll_amount_limit = -available_space;
 573             if(m_scroll_amount > m_scroll_amount_limit)
 574             {
 575                 m_scroll_amount = m_scroll_amount_limit;
 576                 todo_show_scroll_buttons = true;
 577             }
 578         }
 579         else
 580         {
 581             if(!CollapsePanels(major_axis, -available_space))
 582             {
 583                 m_scroll_amount = 0;
 584                 m_scroll_amount_limit = -available_space;
 585                 todo_show_scroll_buttons = true;
 586             }
 587         }
 588     }
 589     if(m_scroll_buttons_visible)
 590     {
 591         if(major_axis == wxHORIZONTAL)
 592         {
 593             origin.x -= m_scroll_amount;
 594             if(m_scroll_left_btn)
 595                 origin.x -= m_scroll_left_btn->GetSize().GetWidth();
 596         }
 597         else
 598         {
 599             origin.y -= m_scroll_amount;
 600             if(m_scroll_left_btn)
 601                 origin.y -= m_scroll_left_btn->GetSize().GetHeight();
 602         }
 603     }
 604     size_index = 0;
 605     for(wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 606         node;
 607         node = node->GetNext(), ++size_index )
 608     {
 609         wxWindow* child = node->GetData();
 610         int w = m_size_calc_array[size_index].GetWidth();
 611         int h = m_size_calc_array[size_index].GetHeight();
 612         child->SetSize(origin.x, origin.y, w, h);
 613         if(major_axis == wxHORIZONTAL)
 614         {
 615             origin.x += w + gap;
 616         }
 617         else
 618         {
 619             origin.y += h + gap;
 620         }
 621     }
 622
 623     if(todo_show_scroll_buttons)
 624         ShowScrollButtons();
 625     else if(todo_hide_scroll_buttons)
 626         HideScrollButtons();
 627
 628     Refresh();
 629     return true;
 630 }
 631
 632 bool wxRibbonPage::Show(bool show)
 633 {
 634     if(m_scroll_left_btn)
 635         m_scroll_left_btn->Show(show);
 636     if(m_scroll_right_btn)
 637         m_scroll_right_btn->Show(show);
 638     return wxRibbonControl::Show(show);
 639 }
 640
 641 void wxRibbonPage::HideScrollButtons()
 642 {
 643     m_scroll_amount = 0;
 644     m_scroll_amount_limit = 0;
 645     ShowScrollButtons();
 646 }
 647
 648 void wxRibbonPage::ShowScrollButtons()
 649 {
 650     bool show_left = true;
 651     bool show_right = true;
 652     bool reposition = false;
 653     if(m_scroll_amount == 0)
 654     {
 655         show_left = false;
 656     }
 657     if(m_scroll_amount >= m_scroll_amount_limit)
 658     {
 659         show_right = false;
 660         m_scroll_amount = m_scroll_amount_limit;
 661     }
 662     m_scroll_buttons_visible = show_left || show_right;
 663
 664     if(show_left)
 665     {
 666         if(m_scroll_left_btn == NULL)
 667         {
 668             wxMemoryDC temp_dc;
 669             wxSize size;
 670             long direction;
 671             if(GetMajorAxis() == wxHORIZONTAL)
 672             {
 673                 direction = wxRIBBON_SCROLL_BTN_LEFT;
 674                 size = m_art->GetScrollButtonMinimumSize(temp_dc, GetParent(), direction);
 675                 size.SetHeight(GetSize().GetHeight());
 676             }
 677             else
 678             {
 679                 direction = wxRIBBON_SCROLL_BTN_UP;
 680                 size = m_art->GetScrollButtonMinimumSize(temp_dc, GetParent(), direction);
 681                 size.SetWidth(GetSize().GetWidth());
 682             }
 683             m_scroll_left_btn = new wxRibbonPageScrollButton(this, wxID_ANY, GetPosition(), size, direction);
 684             if(!IsShown())
 685             {
 686                 m_scroll_left_btn->Hide();
 687             }
 688             reposition = true;
 689         }
 690     }
 691     else
 692     {
 693         if(m_scroll_left_btn != NULL)
 694         {
 695             m_scroll_left_btn->Destroy();
 696             m_scroll_left_btn = NULL;
 697             reposition = true;
 698         }
 699     }
 700
 701     if(show_right)
 702     {
 703         if(m_scroll_right_btn == NULL)
 704         {
 705             wxMemoryDC temp_dc;
 706             wxSize size;
 707             long direction;
 708             if(GetMajorAxis() == wxHORIZONTAL)
 709             {
 710                 direction = wxRIBBON_SCROLL_BTN_RIGHT;
 711                 size = m_art->GetScrollButtonMinimumSize(temp_dc, GetParent(), direction);
 712                 size.SetHeight(GetSize().GetHeight());
 713             }
 714             else
 715             {
 716                 direction = wxRIBBON_SCROLL_BTN_DOWN;
 717                 size = m_art->GetScrollButtonMinimumSize(temp_dc, GetParent(), direction);
 718                 size.SetWidth(GetSize().GetWidth());
 719             }
 720             wxPoint initial_pos = GetPosition() + GetSize() - size;
 721             m_scroll_right_btn = new wxRibbonPageScrollButton(this, wxID_ANY, initial_pos, size, direction);
 722             if(!IsShown())
 723             {
 724                 m_scroll_right_btn->Hide();
 725             }
 726             reposition = true;
 727         }
 728     }
 729     else
 730     {
 731         if(m_scroll_right_btn != NULL)
 732         {
 733             m_scroll_right_btn->Destroy();
 734             m_scroll_right_btn = NULL;
 735             reposition = true;
 736         }
 737     }
 738
 739     if(reposition)
 740     {
 741         wxDynamicCast(GetParent(), wxRibbonBar)->RepositionPage(this);
 742     }
 743 }
 744
 745 static int GetSizeInOrientation(wxSize size, wxOrientation orientation)
 746 {
 747     switch(orientation)
 748     {
 749     case wxHORIZONTAL: return size.GetWidth();
 750     case wxVERTICAL: return size.GetHeight();
 751     case wxBOTH: return size.GetWidth() * size.GetHeight();
 752     default: return 0;
 753     }
 754 }
 755
 756 bool wxRibbonPage::ExpandPanels(wxOrientation direction, int maximum_amount)
 757 {
 758     bool expanded_something = false;
 759     while(maximum_amount > 0)
 760     {
 761         int smallest_size = INT_MAX;
 762         wxRibbonPanel* smallest_panel = NULL;
 763         wxSize* smallest_panel_size = NULL;
 764         wxSize* panel_size = m_size_calc_array;
 765         for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 766                   node;
 767                   node = node->GetNext(), ++panel_size )
 768         {
 769             wxRibbonPanel* panel = wxDynamicCast(node->GetData(), wxRibbonPanel);
 770             if(panel == NULL)
 771             {
 772                 continue;
 773             }
 774             if(panel->IsSizingContinuous())
 775             {
 776                 int size = GetSizeInOrientation(*panel_size, direction);
 777                 if(size < smallest_size)
 778                 {
 779                     smallest_size = size;
 780                     smallest_panel = panel;
 781                     smallest_panel_size = panel_size;
 782                 }
 783             }
 784             else
 785             {
 786                 int size = GetSizeInOrientation(*panel_size, direction);
 787                 if(size < smallest_size)
 788                 {
 789                     wxSize larger = panel->GetNextLargerSize(direction, *panel_size);
 790                     if(larger != (*panel_size) && GetSizeInOrientation(larger, direction) > size)
 791                     {
 792                         smallest_size = size;
 793                         smallest_panel = panel;
 794                         smallest_panel_size = panel_size;
 795                     }
 796                 }
 797             }
 798         }
 799         if(smallest_panel != NULL)
 800         {
 801             if(smallest_panel->IsSizingContinuous())
 802             {
 803                 int amount = maximum_amount;
 804                 if(amount > 32)
 805                 {
 806                     // For "large" growth, grow this panel a bit, and then re-allocate
 807                     // the remainder (which may come to this panel again anyway)
 808                     amount = 32;
 809                 }
 810                 if(direction & wxHORIZONTAL)
 811                 {
 812                     smallest_panel_size->x += amount;
 813                 }
 814                 if(direction & wxVERTICAL)
 815                 {
 816                     smallest_panel_size->y += amount;
 817                 }
 818                 maximum_amount -= amount;
 819                 m_collapse_stack.Add(smallest_panel);
 820                 expanded_something = true;
 821             }
 822             else
 823             {
 824                 wxSize larger = smallest_panel->GetNextLargerSize(direction, *smallest_panel_size);
 825                 wxSize delta = larger - (*smallest_panel_size);
 826                 if(GetSizeInOrientation(delta, direction) <= maximum_amount)
 827                 {
 828                     *smallest_panel_size = larger;
 829                     maximum_amount -= GetSizeInOrientation(delta, direction);
 830                     m_collapse_stack.Add(smallest_panel);
 831                     expanded_something = true;
 832                 }
 833                 else
 834                 {
 835                     break;
 836                 }
 837             }
 838         }
 839         else
 840         {
 841             break;
 842         }
 843     }
 844     return expanded_something;
 845 }
 846
 847 bool wxRibbonPage::CollapsePanels(wxOrientation direction, int minimum_amount)
 848 {
 849     bool collapsed_something = false;
 850     while(minimum_amount > 0)
 851     {
 852         int largest_size = 0;
 853         wxRibbonPanel* largest_panel = NULL;
 854         wxSize* largest_panel_size = NULL;
 855         wxSize* panel_size = m_size_calc_array;
 856         if(!m_collapse_stack.IsEmpty())
 857         {
 858             // For a more consistent panel layout, try to collapse panels which
 859             // were recently expanded.
 860             largest_panel = wxDynamicCast(m_collapse_stack.Last(), wxRibbonPanel);
 861             m_collapse_stack.RemoveAt(m_collapse_stack.GetCount() - 1);
 862             for(wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 863                       node;
 864                       node = node->GetNext(), ++panel_size )
 865             {
 866                 wxRibbonPanel* panel = wxDynamicCast(node->GetData(), wxRibbonPanel);
 867                 if(panel == largest_panel)
 868                 {
 869                     largest_panel_size = panel_size;
 870                     break;
 871                 }
 872             }
 873         }
 874         else
 875         {
 876             for(wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 877                       node;
 878                       node = node->GetNext(), ++panel_size )
 879             {
 880                 wxRibbonPanel* panel = wxDynamicCast(node->GetData(), wxRibbonPanel);
 881                 if(panel == NULL)
 882                 {
 883                     continue;
 884                 }
 885                 if(panel->IsSizingContinuous())
 886                 {
 887                     int size = GetSizeInOrientation(*panel_size, direction);
 888                     if(size > largest_size)
 889                     {
 890                         largest_size = size;
 891                         largest_panel = panel;
 892                         largest_panel_size = panel_size;
 893                     }
 894                 }
 895                 else
 896                 {
 897                     int size = GetSizeInOrientation(*panel_size, direction);
 898                     if(size > largest_size)
 899                     {
 900                         wxSize smaller = panel->GetNextSmallerSize(direction, *panel_size);
 901                         if(smaller != (*panel_size) &&
 902                             GetSizeInOrientation(smaller, direction) < size)
 903                         {
 904                             largest_size = size;
 905                             largest_panel = panel;
 906                             largest_panel_size = panel_size;
 907                         }
 908                     }
 909                 }
 910             }
 911         }
 912         if(largest_panel != NULL)
 913         {
 914             if(largest_panel->IsSizingContinuous())
 915             {
 916                 int amount = minimum_amount;
 917                 if(amount > 32)
 918                 {
 919                     // For "large" contraction, reduce this panel a bit, and
 920                     // then re-allocate the remainder of the quota (which may
 921                     // come to this panel again anyway)
 922                     amount = 32;
 923                 }
 924                 if(direction & wxHORIZONTAL)
 925                 {
 926                     largest_panel_size->x -= amount;
 927                 }
 928                 if(direction & wxVERTICAL)
 929                 {
 930                     largest_panel_size->y -= amount;
 931                 }
 932                 minimum_amount -= amount;
 933                 collapsed_something = true;
 934             }
 935             else
 936             {
 937                 wxSize smaller = largest_panel->GetNextSmallerSize(direction, *largest_panel_size);
 938                 wxSize delta = (*largest_panel_size) - smaller;
 939                 *largest_panel_size = smaller;
 940                 minimum_amount -= GetSizeInOrientation(delta, direction);
 941                 collapsed_something = true;
 942             }
 943         }
 944         else
 945         {
 946             break;
 947         }
 948     }
 949     return collapsed_something;
 950 }
 951
 952 bool wxRibbonPage::DismissExpandedPanel()
 953 {
 954     for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 955               node;
 956               node = node->GetNext() )
 957     {
 958         wxRibbonPanel* panel = wxDynamicCast(node->GetData(), wxRibbonPanel);
 959         if(panel == NULL)
 960         {
 961             continue;
 962         }
 963         if(panel->GetExpandedPanel() != NULL)
 964         {
 965             return panel->HideExpanded();
 966         }
 967     }
 968     return false;
 969 }
 970
 971 wxSize wxRibbonPage::GetMinSize() const
 972 {
 973     wxSize min(wxDefaultCoord, wxDefaultCoord);
 974
 975     for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
 976           node;
 977           node = node->GetNext() )
 978     {
 979         wxWindow* child = node->GetData();
 980         wxSize child_min(child->GetMinSize());
 981
 982         min.x = wxMax(min.x, child_min.x);
 983         min.y = wxMax(min.y, child_min.y);
 984     }
 985
 986     if(GetMajorAxis() == wxHORIZONTAL)
 987     {
 988         min.x = wxDefaultCoord;
 989         if(min.y != wxDefaultCoord)
 990         {
 991             min.y += m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_TOP_SIZE) + m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_BOTTOM_SIZE);
 992         }
 993     }
 994     else
 995     {
 996         if(min.x != wxDefaultCoord)
 997         {
 998             min.x += m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_LEFT_SIZE) + m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_RIGHT_SIZE);
 999         }
1000         min.y = wxDefaultCoord;
1001     }
1002
1003     return min;
1004 }
1005
1006 wxSize wxRibbonPage::DoGetBestSize() const
1007 {
1008     wxSize best(0, 0);
1009     size_t count = 0;
1010
1011     if(GetMajorAxis() == wxHORIZONTAL)
1012     {
1013         best.y = wxDefaultCoord;
1014
1015         for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
1016           node;
1017           node = node->GetNext() )
1018         {
1019             wxWindow* child = node->GetData();
1020             wxSize child_best(child->GetBestSize());
1021
1022             if(child_best.x != wxDefaultCoord)
1023             {
1024                 best.IncBy(child_best.x, 0);
1025             }
1026             best.y = wxMax(best.y, child_best.y);
1027
1028             ++count;
1029         }
1030
1031         if(count > 1)
1032         {
1033             best.IncBy((count - 1) * m_art->GetMetric(wxRIBBON_ART_PANEL_X_SEPARATION_SIZE), 0);
1034         }
1035     }
1036     else
1037     {
1038         best.x = wxDefaultCoord;
1039
1040         for ( wxWindowList::compatibility_iterator node = GetChildren().GetFirst();
1041           node;
1042           node = node->GetNext() )
1043         {
1044             wxWindow* child = node->GetData();
1045             wxSize child_best(child->GetBestSize());
1046
1047             best.x = wxMax(best.x, child_best.x);
1048             if(child_best.y != wxDefaultCoord)
1049             {
1050                 best.IncBy(0, child_best.y);
1051             }
1052
1053             ++count;
1054         }
1055
1056         if(count > 1)
1057         {
1058             best.IncBy(0, (count - 1) * m_art->GetMetric(wxRIBBON_ART_PANEL_Y_SEPARATION_SIZE));
1059         }
1060     }
1061
1062     if(best.x != wxDefaultCoord)
1063     {
1064         best.x += m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_LEFT_SIZE) + m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_RIGHT_SIZE);
1065     }
1066     if(best.y != wxDefaultCoord)
1067     {
1068         best.y += m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_TOP_SIZE) + m_art->GetMetric(wxRIBBON_ART_PAGE_BORDER_BOTTOM_SIZE);
1069     }
1070     return best;
1071 }
1072
1073 #endif // wxUSE_RIBBON