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