include/wx/msw/toolbar.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/toolbar.h
   3 // Purpose:     wxToolBar (Windows 95 toolbar) class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // Copyright:   (c) Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_MSW_TBAR95_H_
  12 #define _WX_MSW_TBAR95_H_
  13
  14 #if wxUSE_TOOLBAR
  15
  16 #include "wx/dynarray.h"
  17 #include "wx/imaglist.h"
  18
  19 class WXDLLIMPEXP_CORE wxToolBar : public wxToolBarBase
  20 {
  21 public:
  22     // ctors and dtor
  23     wxToolBar() { Init(); }
  24
  25     wxToolBar(wxWindow *parent,
  26                 wxWindowID id,
  27                 const wxPoint& pos = wxDefaultPosition,
  28                 const wxSize& size = wxDefaultSize,
  29                 long style = wxTB_HORIZONTAL,
  30                 const wxString& name = wxToolBarNameStr)
  31     {
  32         Init();
  33
  34         Create(parent, id, pos, size, style, name);
  35     }
  36
  37     bool Create(wxWindow *parent,
  38                 wxWindowID id,
  39                 const wxPoint& pos = wxDefaultPosition,
  40                 const wxSize& size = wxDefaultSize,
  41                 long style = wxTB_HORIZONTAL,
  42                 const wxString& name = wxToolBarNameStr);
  43
  44     virtual ~wxToolBar();
  45
  46     // override/implement base class virtuals
  47     virtual wxToolBarToolBase *FindToolForPosition(wxCoord x, wxCoord y) const;
  48
  49     virtual bool Realize();
  50
  51     virtual void SetToolBitmapSize(const wxSize& size);
  52     virtual wxSize GetToolSize() const;
  53
  54     virtual void SetRows(int nRows);
  55
  56     virtual void SetToolNormalBitmap(int id, const wxBitmap& bitmap);
  57     virtual void SetToolDisabledBitmap(int id, const wxBitmap& bitmap);
  58
  59     // implementation only from now on
  60     // -------------------------------
  61
  62     virtual void SetWindowStyleFlag(long style);
  63
  64     virtual bool MSWCommand(WXUINT param, WXWORD id);
  65     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
  66
  67     void OnMouseEvent(wxMouseEvent& event);
  68     void OnSysColourChanged(wxSysColourChangedEvent& event);
  69     void OnEraseBackground(wxEraseEvent& event);
  70
  71     void SetFocus() {}
  72
  73     static WXHBITMAP MapBitmap(WXHBITMAP bitmap, int width, int height);
  74
  75     // override WndProc mainly to process WM_SIZE
  76     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  77
  78     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
  79
  80     // returns true if the platform should explicitly apply a theme border
  81     virtual bool CanApplyThemeBorder() const { return false; }
  82
  83 #ifdef wxHAS_MSW_BACKGROUND_ERASE_HOOK
  84     virtual bool MSWEraseBgHook(WXHDC hDC);
  85     virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC hDC, wxWindowMSW *child);
  86 #endif // wxHAS_MSW_BACKGROUND_ERASE_HOOK
  87
  88     virtual wxToolBarToolBase *CreateTool(int id,
  89                                           const wxString& label,
  90                                           const wxBitmap& bmpNormal,
  91                                           const wxBitmap& bmpDisabled = wxNullBitmap,
  92                                           wxItemKind kind = wxITEM_NORMAL,
  93                                           wxObject *clientData = NULL,
  94                                           const wxString& shortHelp = wxEmptyString,
  95                                           const wxString& longHelp = wxEmptyString);
  96
  97     virtual wxToolBarToolBase *CreateTool(wxControl *control,
  98                                           const wxString& label);
  99 protected:
 100     // common part of all ctors
 101     void Init();
 102
 103     // create the native toolbar control
 104     bool MSWCreateToolbar(const wxPoint& pos, const wxSize& size);
 105
 106     // recreate the control completely
 107     void Recreate();
 108
 109     // implement base class pure virtuals
 110     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool);
 111     virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool);
 112
 113     virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable);
 114     virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle);
 115     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
 116
 117     // return the appropriate size and flags for the toolbar control
 118     virtual wxSize DoGetBestSize() const;
 119
 120     // handlers for various events
 121     bool HandleSize(WXWPARAM wParam, WXLPARAM lParam);
 122 #ifdef wxHAS_MSW_BACKGROUND_ERASE_HOOK
 123     bool HandlePaint(WXWPARAM wParam, WXLPARAM lParam);
 124 #endif // wxHAS_MSW_BACKGROUND_ERASE_HOOK
 125     void HandleMouseMove(WXWPARAM wParam, WXLPARAM lParam);
 126
 127     // should be called whenever the toolbar size changes
 128     void UpdateSize();
 129
 130     // create m_disabledImgList (but doesn't fill it), set it to NULL if it is
 131     // unneeded
 132     void CreateDisabledImageList();
 133
 134     // get the Windows toolbar style of this control
 135     long GetMSWToolbarStyle() const;
 136
 137
 138     // the big bitmap containing all bitmaps of the toolbar buttons
 139     WXHBITMAP m_hBitmap;
 140
 141     // the image list with disabled images, may be NULL if we use
 142     // system-provided versions of them
 143     wxImageList *m_disabledImgList;
 144
 145     // the total number of toolbar elements
 146     size_t m_nButtons;
 147
 148     // the sum of the sizes of the fixed items (i.e. excluding stretchable
 149     // spaces) in the toolbar direction
 150     int m_totalFixedSize;
 151
 152     // the tool the cursor is in
 153     wxToolBarToolBase *m_pInTool;
 154
 155 private:
 156     // makes sure tool bitmap size is sufficient for all tools
 157     void AdjustToolBitmapSize();
 158
 159     // update the sizes of stretchable spacers to consume all extra space we
 160     // have
 161     void UpdateStretchableSpacersSize();
 162
 163 #ifdef wxHAS_MSW_BACKGROUND_ERASE_HOOK
 164     // do erase the toolbar background, always do it for the entire control as
 165     // the caller sets the clipping region correctly to exclude parts which
 166     // should not be erased
 167     void MSWDoEraseBackground(WXHDC hDC);
 168
 169     // return the brush to use for erasing the toolbar background
 170     WXHBRUSH MSWGetToolbarBgBrush();
 171 #endif // wxHAS_MSW_BACKGROUND_ERASE_HOOK
 172
 173     DECLARE_EVENT_TABLE()
 174     DECLARE_DYNAMIC_CLASS(wxToolBar)
 175     wxDECLARE_NO_COPY_CLASS(wxToolBar);
 176 };
 177
 178 #endif // wxUSE_TOOLBAR
 179
 180 #endif // _WX_MSW_TBAR95_H_
 181