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 license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIV_TOOLBAR_H_
  13 #define _WX_UNIV_TOOLBAR_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "univtoolbar.h"
  17 #endif
  18
  19 #include "wx/button.h"      // for wxStdButtonInputHandler
  20
  21 class WXDLLEXPORT wxToolBarTool;
  22
  23 // ----------------------------------------------------------------------------
  24 // the actions supported by this control
  25 // ----------------------------------------------------------------------------
  26
  27 #define wxACTION_TOOLBAR_TOGGLE  wxACTION_BUTTON_TOGGLE
  28 #define wxACTION_TOOLBAR_PRESS   wxACTION_BUTTON_PRESS
  29 #define wxACTION_TOOLBAR_RELEASE wxACTION_BUTTON_RELEASE
  30 #define wxACTION_TOOLBAR_CLICK   wxACTION_BUTTON_CLICK
  31 #define wxACTION_TOOLBAR_ENTER   _T("enter")     // highlight the tool
  32 #define wxACTION_TOOLBAR_LEAVE   _T("leave")     // unhighlight the tool
  33
  34 // ----------------------------------------------------------------------------
  35 // wxToolBar
  36 // ----------------------------------------------------------------------------
  37
  38 class WXDLLEXPORT wxToolBar : public wxToolBarBase
  39 {
  40 public:
  41     // construction/destruction
  42     wxToolBar() { Init(); }
  43     wxToolBar(wxWindow *parent,
  44               wxWindowID id,
  45               const wxPoint& pos = wxDefaultPosition,
  46               const wxSize& size = wxDefaultSize,
  47               long style = 0,
  48               const wxString& name = wxToolBarNameStr)
  49     {
  50         Init();
  51
  52         Create(parent, id, pos, size, style, name);
  53     }
  54
  55     bool Create( wxWindow *parent,
  56                  wxWindowID id,
  57                  const wxPoint& pos = wxDefaultPosition,
  58                  const wxSize& size = wxDefaultSize,
  59                  long style = 0,
  60                  const wxString& name = wxToolBarNameStr );
  61
  62     virtual ~wxToolBar();
  63
  64     virtual bool Realize();
  65
  66     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y) const;
  67
  68     virtual void SetToolShortHelp(int id, const wxString& helpString);
  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 DoDraw(wxControlRenderer *renderer);
  98
  99     // get the bounding rect for the given tool
 100     wxRect GetToolRect(wxToolBarToolBase *tool) const;
 101
 102     // redraw the given tool
 103     void RefreshTool(wxToolBarToolBase *tool);
 104
 105     // (re)calculate the tool positions, should only be called if it is
 106     // necessary to do it, i.e. m_needsLayout == TRUE
 107     void DoLayout();
 108
 109     // get the rect limits depending on the orientation: top/bottom for a
 110     // vertical toolbar, left/right for a horizontal one
 111     void GetRectLimits(const wxRect& rect, wxCoord *start, wxCoord *end) const;
 112
 113     // wxButton actions: all these use m_toolPressed and can only be called if
 114     // we have one
 115     void Toggle();
 116     void Press();
 117     void Release();
 118
 119     // this one used m_toolCurrent
 120     void Click();
 121
 122 private:
 123     // have we calculated the positions of our tools?
 124     bool m_needsLayout;
 125
 126     // the width of a separator
 127     wxCoord m_widthSeparator;
 128
 129     // the total size of all toolbar elements
 130     wxCoord m_maxWidth,
 131             m_maxHeight;
 132
 133     // the tool over which the mouse currently is or NULL
 134     wxToolBarToolBase *m_toolCurrent;
 135
 136     // the tool which currently has the mouse capture (i.e. the one user is
 137     // pressing) or NULL
 138     wxToolBarTool *m_toolPressed;
 139
 140     DECLARE_DYNAMIC_CLASS(wxToolBar)
 141 };
 142
 143 // ----------------------------------------------------------------------------
 144 // wxStdToolbarInputHandler: translates SPACE and ENTER keys and the left mouse
 145 // click into button press/release actions
 146 // ----------------------------------------------------------------------------
 147
 148 class WXDLLEXPORT wxStdToolbarInputHandler : public wxStdButtonInputHandler
 149 {
 150 public:
 151     wxStdToolbarInputHandler(wxInputHandler *inphand);
 152
 153     virtual bool HandleKey(wxInputConsumer *consumer,
 154                            const wxKeyEvent& event,
 155                            bool pressed);
 156     virtual bool HandleMouse(wxInputConsumer *consumer,
 157                              const wxMouseEvent& event);
 158     virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
 159     virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
 160     virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
 161 };
 162
 163 #endif // _WX_UNIV_TOOLBAR_H_