include/wx/ribbon/page.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/ribbon/page.h
   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
  12 #ifndef _WX_RIBBON_PAGE_H_
  13 #define _WX_RIBBON_PAGE_H_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_RIBBON
  18
  19 #include "wx/ribbon/control.h"
  20 #include "wx/ribbon/panel.h"
  21 #include "wx/bitmap.h"
  22
  23 class wxRibbonBar;
  24 class wxRibbonPageScrollButton;
  25
  26 class WXDLLIMPEXP_RIBBON wxRibbonPage : public wxRibbonControl
  27 {
  28 public:
  29     wxRibbonPage();
  30
  31     wxRibbonPage(wxRibbonBar* parent,
  32                  wxWindowID id = wxID_ANY,
  33                  const wxString& label = wxEmptyString,
  34                  const wxBitmap& icon = wxNullBitmap,
  35                  long style = 0);
  36
  37     virtual ~wxRibbonPage();
  38
  39     bool Create(wxRibbonBar* parent,
  40                 wxWindowID id = wxID_ANY,
  41                 const wxString& label = wxEmptyString,
  42                 const wxBitmap& icon = wxNullBitmap,
  43                 long style = 0);
  44
  45     void SetArtProvider(wxRibbonArtProvider* art);
  46
  47     wxBitmap& GetIcon() {return m_icon;}
  48     virtual wxSize GetMinSize() const;
  49     void SetSizeWithScrollButtonAdjustment(int x, int y, int width, int height);
  50     void AdjustRectToIncludeScrollButtons(wxRect* rect) const;
  51
  52     bool DismissExpandedPanel();
  53
  54     virtual bool Realize();
  55     virtual bool Show(bool show = true);
  56     virtual bool Layout();
  57     virtual bool ScrollLines(int lines);
  58     bool ScrollPixels(int pixels);
  59
  60     wxOrientation GetMajorAxis() const;
  61
  62     virtual void RemoveChild(wxWindowBase *child);
  63
  64     void HideIfExpanded();
  65
  66 protected:
  67     virtual wxSize DoGetBestSize() const;
  68     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
  69
  70     void DoSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
  71     bool DoActualLayout();
  72     void OnEraseBackground(wxEraseEvent& evt);
  73     void OnPaint(wxPaintEvent& evt);
  74     void OnSize(wxSizeEvent& evt);
  75
  76     bool ExpandPanels(wxOrientation direction, int maximum_amount);
  77     bool CollapsePanels(wxOrientation direction, int minimum_amount);
  78     void ShowScrollButtons();
  79     void HideScrollButtons();
  80
  81     void CommonInit(const wxString& label, const wxBitmap& icon);
  82     void PopulateSizeCalcArray(wxSize (wxWindow::*get_size)(void) const);
  83
  84     wxArrayRibbonControl m_collapse_stack;
  85     wxBitmap m_icon;
  86     wxSize m_old_size;
  87     // NB: Scroll button windows are siblings rather than children (to get correct clipping of children)
  88     wxRibbonPageScrollButton* m_scroll_left_btn;
  89     wxRibbonPageScrollButton* m_scroll_right_btn;
  90     wxSize* m_size_calc_array;
  91     size_t m_size_calc_array_size;
  92     int m_scroll_amount;
  93     int m_scroll_amount_limit;
  94     int m_size_in_major_axis_for_children;
  95     bool m_scroll_buttons_visible;
  96
  97 #ifndef SWIG
  98     DECLARE_CLASS(wxRibbonPage)
  99     DECLARE_EVENT_TABLE()
 100 #endif
 101 };
 102
 103 #endif // wxUSE_RIBBON
 104
 105 #endif // _WX_RIBBON_PAGE_H_