include/wx/ribbon/buttonbar.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/ribbon/buttonbar.h
   3 // Purpose:     Ribbon control similar to a tool bar
   4 // Author:      Peter Cawley
   5 // Modified by:
   6 // Created:     2009-07-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (C) Peter Cawley
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11 #ifndef _WX_RIBBON_BUTTON_BAR_H_
  12 #define _WX_RIBBON_BUTTON_BAR_H_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_RIBBON
  17
  18 #include "wx/ribbon/art.h"
  19 #include "wx/ribbon/control.h"
  20 #include "wx/dynarray.h"
  21
  22 class wxRibbonButtonBarButtonBase;
  23 class wxRibbonButtonBarLayout;
  24 class wxRibbonButtonBarButtonInstance;
  25
  26 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxRibbonButtonBarLayout*, wxArrayRibbonButtonBarLayout, class WXDLLIMPEXP_RIBBON);
  27 WX_DEFINE_USER_EXPORTED_ARRAY_PTR(wxRibbonButtonBarButtonBase*, wxArrayRibbonButtonBarButtonBase, class WXDLLIMPEXP_RIBBON);
  28
  29 class WXDLLIMPEXP_RIBBON wxRibbonButtonBar : public wxRibbonControl
  30 {
  31 public:
  32     wxRibbonButtonBar();
  33
  34     wxRibbonButtonBar(wxWindow* parent,
  35                   wxWindowID id = wxID_ANY,
  36                   const wxPoint& pos = wxDefaultPosition,
  37                   const wxSize& size = wxDefaultSize,
  38                   long style = 0);
  39
  40     virtual ~wxRibbonButtonBar();
  41
  42     bool Create(wxWindow* parent,
  43                 wxWindowID id = wxID_ANY,
  44                 const wxPoint& pos = wxDefaultPosition,
  45                 const wxSize& size = wxDefaultSize,
  46                 long style = 0);
  47
  48     virtual wxRibbonButtonBarButtonBase* AddButton(
  49                 int button_id,
  50                 const wxString& label,
  51                 const wxBitmap& bitmap,
  52                 const wxString& help_string,
  53                 wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL);
  54     // NB: help_string cannot be optional as that would cause the signature
  55     // to be identical to the full version of AddButton when 3 arguments are
  56     // given.
  57
  58     virtual wxRibbonButtonBarButtonBase* AddDropdownButton(
  59                 int button_id,
  60                 const wxString& label,
  61                 const wxBitmap& bitmap,
  62                 const wxString& help_string = wxEmptyString);
  63
  64     virtual wxRibbonButtonBarButtonBase* AddHybridButton(
  65                 int button_id,
  66                 const wxString& label,
  67                 const wxBitmap& bitmap,
  68                 const wxString& help_string = wxEmptyString);
  69
  70     virtual wxRibbonButtonBarButtonBase* AddToggleButton(
  71                 int button_id,
  72                 const wxString& label,
  73                 const wxBitmap& bitmap,
  74                 const wxString& help_string = wxEmptyString);
  75
  76     virtual wxRibbonButtonBarButtonBase* AddButton(
  77                 int button_id,
  78                 const wxString& label,
  79                 const wxBitmap& bitmap,
  80                 const wxBitmap& bitmap_small = wxNullBitmap,
  81                 const wxBitmap& bitmap_disabled = wxNullBitmap,
  82                 const wxBitmap& bitmap_small_disabled = wxNullBitmap,
  83                 wxRibbonButtonKind kind = wxRIBBON_BUTTON_NORMAL,
  84                 const wxString& help_string = wxEmptyString,
  85                 wxObject* client_data = NULL);
  86
  87     virtual bool Realize();
  88     virtual void ClearButtons();
  89     virtual bool DeleteButton(int button_id);
  90     virtual void EnableButton(int button_id, bool enable = true);
  91     virtual void ToggleButton(int button_id, bool checked);
  92
  93     virtual void SetArtProvider(wxRibbonArtProvider* art);
  94     virtual bool IsSizingContinuous() const;
  95
  96     virtual wxSize GetMinSize() const;
  97 protected:
  98     friend class wxRibbonButtonBarEvent;
  99     virtual wxSize DoGetBestSize() const;
 100     wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
 101
 102     void OnEraseBackground(wxEraseEvent& evt);
 103     void OnPaint(wxPaintEvent& evt);
 104     void OnSize(wxSizeEvent& evt);
 105     void OnMouseMove(wxMouseEvent& evt);
 106     void OnMouseEnter(wxMouseEvent& evt);
 107     void OnMouseLeave(wxMouseEvent& evt);
 108     void OnMouseDown(wxMouseEvent& evt);
 109     void OnMouseUp(wxMouseEvent& evt);
 110
 111     virtual wxSize DoGetNextSmallerSize(wxOrientation direction,
 112                                       wxSize relative_to) const;
 113     virtual wxSize DoGetNextLargerSize(wxOrientation direction,
 114                                      wxSize relative_to) const;
 115
 116     void CommonInit(long style);
 117     void MakeLayouts();
 118     bool TryCollapseLayout(wxRibbonButtonBarLayout* original, size_t first_btn, size_t* last_button);
 119     static wxBitmap MakeResizedBitmap(const wxBitmap& original, wxSize size);
 120     static wxBitmap MakeDisabledBitmap(const wxBitmap& original);
 121     void FetchButtonSizeInfo(wxRibbonButtonBarButtonBase* button,
 122         wxRibbonButtonBarButtonState size, wxDC& dc);
 123     virtual void UpdateWindowUI(long flags);
 124
 125     wxArrayRibbonButtonBarLayout m_layouts;
 126     wxArrayRibbonButtonBarButtonBase m_buttons;
 127     wxRibbonButtonBarButtonInstance* m_hovered_button;
 128     wxRibbonButtonBarButtonInstance* m_active_button;
 129
 130     wxPoint m_layout_offset;
 131     wxSize m_bitmap_size_large;
 132     wxSize m_bitmap_size_small;
 133     int m_current_layout;
 134     bool m_layouts_valid;
 135     bool m_lock_active_state;
 136
 137 #ifndef SWIG
 138     DECLARE_CLASS(wxRibbonButtonBar)
 139     DECLARE_EVENT_TABLE()
 140 #endif
 141 };
 142
 143 class WXDLLIMPEXP_RIBBON wxRibbonButtonBarEvent : public wxCommandEvent
 144 {
 145 public:
 146     wxRibbonButtonBarEvent(wxEventType command_type = wxEVT_NULL,
 147                        int win_id = 0,
 148                        wxRibbonButtonBar* bar = NULL)
 149         : wxCommandEvent(command_type, win_id)
 150         , m_bar(bar)
 151     {
 152     }
 153 #ifndef SWIG
 154     wxRibbonButtonBarEvent(const wxRibbonButtonBarEvent& e) : wxCommandEvent(e)
 155     {
 156         m_bar = e.m_bar;
 157     }
 158 #endif
 159     wxEvent *Clone() const { return new wxRibbonButtonBarEvent(*this); }
 160
 161     wxRibbonButtonBar* GetBar() {return m_bar;}
 162     void SetBar(wxRibbonButtonBar* bar) {m_bar = bar;}
 163     bool PopupMenu(wxMenu* menu);
 164
 165 protected:
 166     wxRibbonButtonBar* m_bar;
 167
 168 #ifndef SWIG
 169 private:
 170     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxRibbonButtonBarEvent)
 171 #endif
 172 };
 173
 174 #ifndef SWIG
 175
 176 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBUTTON_CLICKED, wxRibbonButtonBarEvent);
 177 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_RIBBON, wxEVT_COMMAND_RIBBONBUTTON_DROPDOWN_CLICKED, wxRibbonButtonBarEvent);
 178
 179 typedef void (wxEvtHandler::*wxRibbonButtonBarEventFunction)(wxRibbonButtonBarEvent&);
 180
 181 #define wxRibbonButtonBarEventHandler(func) \
 182     wxEVENT_HANDLER_CAST(wxRibbonButtonBarEventFunction, func)
 183
 184 #define EVT_RIBBONBUTTONBAR_CLICKED(winid, fn) \
 185     wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBUTTON_CLICKED, winid, wxRibbonButtonBarEventHandler(fn))
 186 #define EVT_RIBBONBUTTONBAR_DROPDOWN_CLICKED(winid, fn) \
 187     wx__DECLARE_EVT1(wxEVT_COMMAND_RIBBONBUTTON_DROPDOWN_CLICKED, winid, wxRibbonButtonBarEventHandler(fn))
 188 #else
 189
 190 // wxpython/swig event work
 191 %constant wxEventType wxEVT_COMMAND_RIBBONBUTTON_CLICKED;
 192 %constant wxEventType wxEVT_COMMAND_RIBBONBUTTON_DROPDOWN_CLICKED;
 193
 194 %pythoncode {
 195     EVT_RIBBONBUTTONBAR_CLICKED = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBUTTON_CLICKED, 1 )
 196     EVT_RIBBONBUTTONBAR_DROPDOWN_CLICKED = wx.PyEventBinder( wxEVT_COMMAND_RIBBONBUTTON_DROPDOWN_CLICKED, 1 )
 197 }
 198 #endif
 199
 200 #endif // wxUSE_RIBBON
 201
 202 #endif // _WX_RIBBON_BUTTON_BAR_H_