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 // Copyright:   (c) Robert Roebling
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_UNIV_TOOLBAR_H_
  12 #define _WX_UNIV_TOOLBAR_H_
  13
  14 #include "wx/button.h"      // for wxStdButtonInputHandler
  15
  16 class WXDLLIMPEXP_FWD_CORE wxToolBarTool;
  17
  18 // ----------------------------------------------------------------------------
  19 // the actions supported by this control
  20 // ----------------------------------------------------------------------------
  21
  22 #define wxACTION_TOOLBAR_TOGGLE  wxACTION_BUTTON_TOGGLE
  23 #define wxACTION_TOOLBAR_PRESS   wxACTION_BUTTON_PRESS
  24 #define wxACTION_TOOLBAR_RELEASE wxACTION_BUTTON_RELEASE
  25 #define wxACTION_TOOLBAR_CLICK   wxACTION_BUTTON_CLICK
  26 #define wxACTION_TOOLBAR_ENTER   wxT("enter")     // highlight the tool
  27 #define wxACTION_TOOLBAR_LEAVE   wxT("leave")     // unhighlight the tool
  28
  29 // ----------------------------------------------------------------------------
  30 // wxToolBar
  31 // ----------------------------------------------------------------------------
  32
  33 class WXDLLIMPEXP_CORE wxToolBar : public wxToolBarBase
  34 {
  35 public:
  36     // construction/destruction
  37     wxToolBar() { Init(); }
  38     wxToolBar(wxWindow *parent,
  39               wxWindowID id,
  40               const wxPoint& pos = wxDefaultPosition,
  41               const wxSize& size = wxDefaultSize,
  42               long style = 0,
  43               const wxString& name = wxToolBarNameStr)
  44     {
  45         Init();
  46
  47         Create(parent, id, pos, size, style, name);
  48     }
  49
  50     bool Create( wxWindow *parent,
  51                  wxWindowID id,
  52                  const wxPoint& pos = wxDefaultPosition,
  53                  const wxSize& size = wxDefaultSize,
  54                  long style = 0,
  55                  const wxString& name = wxToolBarNameStr );
  56
  57     virtual ~wxToolBar();
  58
  59     virtual bool Realize();
  60
  61     virtual void SetWindowStyleFlag( long style );
  62
  63     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y) const;
  64
  65     virtual void SetToolShortHelp(int id, const wxString& helpString);
  66
  67     virtual void SetMargins(int x, int y);
  68     void SetMargins(const wxSize& size)
  69         { SetMargins((int) size.x, (int) size.y); }
  70
  71     virtual bool PerformAction(const wxControlAction& action,
  72                                long numArg = -1,
  73                                const wxString& strArg = wxEmptyString);
  74     static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
  75     virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
  76     {
  77         return GetStdInputHandler(handlerDef);
  78     }
  79
  80 protected:
  81     // common part of all ctors
  82     void Init();
  83
  84     // implement base class pure virtuals
  85     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool);
  86     virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool);
  87
  88     virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable);
  89     virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle);
  90     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
  91
  92     virtual wxToolBarToolBase *CreateTool(int id,
  93                                           const wxString& label,
  94                                           const wxBitmap& bmpNormal,
  95                                           const wxBitmap& bmpDisabled,
  96                                           wxItemKind kind,
  97                                           wxObject *clientData,
  98                                           const wxString& shortHelp,
  99                                           const wxString& longHelp);
 100     virtual wxToolBarToolBase *CreateTool(wxControl *control,
 101                                           const wxString& label);
 102
 103     virtual wxSize DoGetBestClientSize() const;
 104     virtual void DoSetSize(int x, int y,
 105                            int width, int height,
 106                            int sizeFlags = wxSIZE_AUTO);
 107     virtual void DoDraw(wxControlRenderer *renderer);
 108
 109     // get the bounding rect for the given tool
 110     wxRect GetToolRect(wxToolBarToolBase *tool) const;
 111
 112     // redraw the given tool
 113     void RefreshTool(wxToolBarToolBase *tool);
 114
 115     // (re)calculate the tool positions, should only be called if it is
 116     // necessary to do it, i.e. m_needsLayout == true
 117     void DoLayout();
 118
 119     // get the rect limits depending on the orientation: top/bottom for a
 120     // vertical toolbar, left/right for a horizontal one
 121     void GetRectLimits(const wxRect& rect, wxCoord *start, wxCoord *end) const;
 122
 123 private:
 124     // have we calculated the positions of our tools?
 125     bool m_needsLayout;
 126
 127     // the width of a separator
 128     wxCoord m_widthSeparator;
 129
 130     // the total size of all toolbar elements
 131     wxCoord m_maxWidth,
 132             m_maxHeight;
 133
 134 private:
 135     DECLARE_DYNAMIC_CLASS(wxToolBar)
 136 };
 137
 138 #endif // _WX_UNIV_TOOLBAR_H_