include/wx/univ/toolbar.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/toolbar.h
   3 // Purpose:     wxToolBar declaration
   4 // Author:      Robert Roebling
   5 // Modified by:
   6 // Created:     10.09.00
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Robert Roebling
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIV_TOOLBAR_H_
  13 #define _WX_UNIV_TOOLBAR_H_
  14
  15 #include "wx/button.h"      // for wxStdButtonInputHandler
  16
  17 class WXDLLEXPORT wxToolBarTool;
  18
  19 // ----------------------------------------------------------------------------
  20 // the actions supported by this control
  21 // ----------------------------------------------------------------------------
  22
  23 #define wxACTION_TOOLBAR_TOGGLE  wxACTION_BUTTON_TOGGLE
  24 #define wxACTION_TOOLBAR_PRESS   wxACTION_BUTTON_PRESS
  25 #define wxACTION_TOOLBAR_RELEASE wxACTION_BUTTON_RELEASE
  26 #define wxACTION_TOOLBAR_CLICK   wxACTION_BUTTON_CLICK
  27 #define wxACTION_TOOLBAR_ENTER   _T("enter")     // highlight the tool
  28 #define wxACTION_TOOLBAR_LEAVE   _T("leave")     // unhighlight the tool
  29
  30 // ----------------------------------------------------------------------------
  31 // wxToolBar
  32 // ----------------------------------------------------------------------------
  33
  34 class WXDLLEXPORT wxToolBar : public wxToolBarBase
  35 {
  36 public:
  37     // construction/destruction
  38     wxToolBar() { Init(); }
  39     wxToolBar(wxWindow *parent,
  40               wxWindowID id,
  41               const wxPoint& pos = wxDefaultPosition,
  42               const wxSize& size = wxDefaultSize,
  43               long style = 0,
  44               const wxString& name = wxToolBarNameStr)
  45     {
  46         Init();
  47
  48         Create(parent, id, pos, size, style, name);
  49     }
  50
  51     bool Create( wxWindow *parent,
  52                  wxWindowID id,
  53                  const wxPoint& pos = wxDefaultPosition,
  54                  const wxSize& size = wxDefaultSize,
  55                  long style = 0,
  56                  const wxString& name = wxToolBarNameStr );
  57
  58     virtual ~wxToolBar();
  59
  60     virtual bool Realize();
  61
  62     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y) const;
  63
  64     virtual void SetToolShortHelp(int id, const wxString& helpString);
  65
  66     virtual void SetMargins(int x, int y);
  67     void SetMargins(const wxSize& size)
  68         { SetMargins((int) size.x, (int) size.y); }
  69
  70 protected:
  71     // common part of all ctors
  72     void Init();
  73
  74     // implement base class pure virtuals
  75     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool);
  76     virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool);
  77
  78     virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable);
  79     virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle);
  80     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
  81
  82     virtual wxToolBarToolBase *CreateTool(int id,
  83                                           const wxString& label,
  84                                           const wxBitmap& bmpNormal,
  85                                           const wxBitmap& bmpDisabled,
  86                                           wxItemKind kind,
  87                                           wxObject *clientData,
  88                                           const wxString& shortHelp,
  89                                           const wxString& longHelp);
  90     virtual wxToolBarToolBase *CreateTool(wxControl *control);
  91
  92     // implement wxUniversal methods
  93     virtual bool PerformAction(const wxControlAction& action,
  94                                long numArg = -1,
  95                                const wxString& strArg = wxEmptyString);
  96     virtual wxSize DoGetBestClientSize() const;
  97     virtual void DoSetSize(int x, int y,
  98                            int width, int height,
  99                            int sizeFlags = wxSIZE_AUTO);
 100     virtual void DoDraw(wxControlRenderer *renderer);
 101
 102     // get the bounding rect for the given tool
 103     wxRect GetToolRect(wxToolBarToolBase *tool) const;
 104
 105     // redraw the given tool
 106     void RefreshTool(wxToolBarToolBase *tool);
 107
 108     // (re)calculate the tool positions, should only be called if it is
 109     // necessary to do it, i.e. m_needsLayout == true
 110     void DoLayout();
 111
 112     // get the rect limits depending on the orientation: top/bottom for a
 113     // vertical toolbar, left/right for a horizontal one
 114     void GetRectLimits(const wxRect& rect, wxCoord *start, wxCoord *end) const;
 115
 116 private:
 117     // have we calculated the positions of our tools?
 118     bool m_needsLayout;
 119
 120     // the width of a separator
 121     wxCoord m_widthSeparator;
 122
 123     // the total size of all toolbar elements
 124     wxCoord m_maxWidth,
 125             m_maxHeight;
 126
 127 private:
 128     DECLARE_DYNAMIC_CLASS(wxToolBar)
 129 };
 130
 131 // ----------------------------------------------------------------------------
 132 // wxStdToolbarInputHandler: translates SPACE and ENTER keys and the left mouse
 133 // click into button press/release actions
 134 // ----------------------------------------------------------------------------
 135
 136 class WXDLLEXPORT wxStdToolbarInputHandler : public wxStdInputHandler
 137 {
 138 public:
 139     wxStdToolbarInputHandler(wxInputHandler *inphand);
 140
 141     virtual bool HandleKey(wxInputConsumer *consumer,
 142                            const wxKeyEvent& event,
 143                            bool pressed);
 144     virtual bool HandleMouse(wxInputConsumer *consumer,
 145                              const wxMouseEvent& event);
 146     virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
 147     virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
 148     virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
 149
 150 private:
 151     wxWindow            *m_winCapture;
 152     wxToolBarToolBase   *m_toolCapture;
 153     wxToolBarToolBase   *m_toolLast;
 154 };
 155
 156 #endif // _WX_UNIV_TOOLBAR_H_