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     virtual bool PerformAction(const wxControlAction& action,
  71                                long numArg = -1,
  72                                const wxString& strArg = wxEmptyString);
  73 protected:
  74     // common part of all ctors
  75     void Init();
  76
  77     // implement base class pure virtuals
  78     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool);
  79     virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool);
  80
  81     virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable);
  82     virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle);
  83     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
  84
  85     virtual wxToolBarToolBase *CreateTool(int id,
  86                                           const wxString& label,
  87                                           const wxBitmap& bmpNormal,
  88                                           const wxBitmap& bmpDisabled,
  89                                           wxItemKind kind,
  90                                           wxObject *clientData,
  91                                           const wxString& shortHelp,
  92                                           const wxString& longHelp);
  93     virtual wxToolBarToolBase *CreateTool(wxControl *control);
  94
  95     virtual wxSize DoGetBestClientSize() const;
  96     virtual void DoSetSize(int x, int y,
  97                            int width, int height,
  98                            int sizeFlags = wxSIZE_AUTO);
  99     virtual void DoDraw(wxControlRenderer *renderer);
 100
 101     // get the bounding rect for the given tool
 102     wxRect GetToolRect(wxToolBarToolBase *tool) const;
 103
 104     // redraw the given tool
 105     void RefreshTool(wxToolBarToolBase *tool);
 106
 107     // (re)calculate the tool positions, should only be called if it is
 108     // necessary to do it, i.e. m_needsLayout == true
 109     void DoLayout();
 110
 111     // get the rect limits depending on the orientation: top/bottom for a
 112     // vertical toolbar, left/right for a horizontal one
 113     void GetRectLimits(const wxRect& rect, wxCoord *start, wxCoord *end) const;
 114
 115 private:
 116     // have we calculated the positions of our tools?
 117     bool m_needsLayout;
 118
 119     // the width of a separator
 120     wxCoord m_widthSeparator;
 121
 122     // the total size of all toolbar elements
 123     wxCoord m_maxWidth,
 124             m_maxHeight;
 125
 126 private:
 127     DECLARE_DYNAMIC_CLASS(wxToolBar)
 128 };
 129
 130 // ----------------------------------------------------------------------------
 131 // wxStdToolbarInputHandler: translates SPACE and ENTER keys and the left mouse
 132 // click into button press/release actions
 133 // ----------------------------------------------------------------------------
 134
 135 class WXDLLEXPORT wxStdToolbarInputHandler : public wxStdInputHandler
 136 {
 137 public:
 138     wxStdToolbarInputHandler(wxInputHandler *inphand);
 139
 140     virtual bool HandleKey(wxInputConsumer *consumer,
 141                            const wxKeyEvent& event,
 142                            bool pressed);
 143     virtual bool HandleMouse(wxInputConsumer *consumer,
 144                              const wxMouseEvent& event);
 145     virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
 146     virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
 147     virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
 148
 149 private:
 150     wxWindow            *m_winCapture;
 151     wxToolBarToolBase   *m_toolCapture;
 152     wxToolBarToolBase   *m_toolLast;
 153 };
 154
 155 #endif // _WX_UNIV_TOOLBAR_H_