include/wx/generic/buttonbar.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/buttonbar.h
   3 // Purpose:     wxButtonToolBar declaration
   4 // Author:      Julian Smart, after Robert Roebling, Vadim Zeitlin, SciTech
   5 // Modified by:
   6 // Created:     2006-04-13
   7 // Copyright:   (c) Julian Smart, Robert Roebling, Vadim Zeitlin,
   8 //              SciTech Software, Inc.
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_BUTTONBAR_H_
  13 #define _WX_BUTTONBAR_H_
  14
  15 #include "wx/bmpbuttn.h"
  16 #include "wx/toolbar.h"
  17
  18 class WXDLLIMPEXP_FWD_CORE wxButtonToolBarTool;
  19
  20 // ----------------------------------------------------------------------------
  21 // wxButtonToolBar
  22 // ----------------------------------------------------------------------------
  23
  24 class WXDLLIMPEXP_CORE wxButtonToolBar : public wxToolBarBase
  25 {
  26 public:
  27     // construction/destruction
  28     wxButtonToolBar() { Init(); }
  29     wxButtonToolBar(wxWindow *parent,
  30               wxWindowID id,
  31               const wxPoint& pos = wxDefaultPosition,
  32               const wxSize& size = wxDefaultSize,
  33               long style = 0,
  34               const wxString& name = wxToolBarNameStr)
  35     {
  36         Init();
  37
  38         Create(parent, id, pos, size, style, name);
  39     }
  40
  41     bool Create( wxWindow *parent,
  42                  wxWindowID id,
  43                  const wxPoint& pos = wxDefaultPosition,
  44                  const wxSize& size = wxDefaultSize,
  45                  long style = 0,
  46                  const wxString& name = wxToolBarNameStr );
  47
  48     virtual ~wxButtonToolBar();
  49
  50     virtual bool Realize();
  51
  52     virtual void SetToolShortHelp(int id, const wxString& helpString);
  53     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y) const;
  54
  55 protected:
  56     // common part of all ctors
  57     void Init();
  58
  59     // implement base class pure virtuals
  60     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool);
  61     virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool);
  62
  63     virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable);
  64     virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle);
  65     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
  66
  67     virtual wxToolBarToolBase *CreateTool(int id,
  68                                           const wxString& label,
  69                                           const wxBitmap& bmpNormal,
  70                                           const wxBitmap& bmpDisabled,
  71                                           wxItemKind kind,
  72                                           wxObject *clientData,
  73                                           const wxString& shortHelp,
  74                                           const wxString& longHelp);
  75     virtual wxToolBarToolBase *CreateTool(wxControl *control,
  76                                           const wxString& label);
  77
  78     virtual wxSize DoGetBestClientSize() const;
  79
  80     // calculate layout
  81     void DoLayout();
  82
  83     // get the bounding rect for the given tool
  84     wxRect GetToolRect(wxToolBarToolBase *tool) const;
  85
  86     // get the rect limits depending on the orientation: top/bottom for a
  87     // vertical toolbar, left/right for a horizontal one
  88     void GetRectLimits(const wxRect& rect, wxCoord *start, wxCoord *end) const;
  89
  90     // receives button commands
  91     void OnCommand(wxCommandEvent& event);
  92
  93     // paints a border
  94     void OnPaint(wxPaintEvent& event);
  95
  96     // detects mouse clicks outside buttons
  97     void OnLeftUp(wxMouseEvent& event);
  98
  99 private:
 100     // have we calculated the positions of our tools?
 101     bool m_needsLayout;
 102
 103     // the width of a separator
 104     wxCoord m_widthSeparator;
 105
 106     // the total size of all toolbar elements
 107     wxCoord m_maxWidth,
 108             m_maxHeight;
 109
 110     // the height of a label
 111     int m_labelHeight;
 112
 113     // the space above the label
 114     int m_labelMargin;
 115
 116 private:
 117     DECLARE_DYNAMIC_CLASS(wxButtonToolBar)
 118     DECLARE_EVENT_TABLE()
 119 };
 120
 121 #endif
 122  // _WX_BUTTONBAR_H_
 123