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 // Id:          $Id$
   8 // Copyright:   (c) Julian Smart, Robert Roebling, Vadim Zeitlin,
   9 //              SciTech Software, Inc.
  10 // Licence:     wxWindows licence
  11 ///////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_BUTTONBAR_H_
  14 #define _WX_BUTTONBAR_H_
  15
  16 #include "wx/bmpbuttn.h"
  17 #include "wx/toolbar.h"
  18
  19 class WXDLLEXPORT wxButtonToolBarTool;
  20
  21 // ----------------------------------------------------------------------------
  22 // wxButtonToolBar
  23 // ----------------------------------------------------------------------------
  24
  25 class WXDLLEXPORT wxButtonToolBar : public wxToolBarBase
  26 {
  27 public:
  28     // construction/destruction
  29     wxButtonToolBar() { Init(); }
  30     wxButtonToolBar(wxWindow *parent,
  31               wxWindowID id,
  32               const wxPoint& pos = wxDefaultPosition,
  33               const wxSize& size = wxDefaultSize,
  34               long style = 0,
  35               const wxString& name = wxToolBarNameStr)
  36     {
  37         Init();
  38
  39         Create(parent, id, pos, size, style, name);
  40     }
  41
  42     bool Create( wxWindow *parent,
  43                  wxWindowID id,
  44                  const wxPoint& pos = wxDefaultPosition,
  45                  const wxSize& size = wxDefaultSize,
  46                  long style = 0,
  47                  const wxString& name = wxToolBarNameStr );
  48
  49     virtual ~wxButtonToolBar();
  50
  51     virtual bool Realize();
  52
  53     virtual void SetToolShortHelp(int id, const wxString& helpString);
  54     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y) const;
  55
  56 protected:
  57     // common part of all ctors
  58     void Init();
  59
  60     // implement base class pure virtuals
  61     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool);
  62     virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool);
  63
  64     virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable);
  65     virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle);
  66     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
  67
  68     virtual wxToolBarToolBase *CreateTool(int id,
  69                                           const wxString& label,
  70                                           const wxBitmap& bmpNormal,
  71                                           const wxBitmap& bmpDisabled,
  72                                           wxItemKind kind,
  73                                           wxObject *clientData,
  74                                           const wxString& shortHelp,
  75                                           const wxString& longHelp);
  76     virtual wxToolBarToolBase *CreateTool(wxControl *control);
  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