include/wx/msw/toolbar.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/tbar95.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 protected:
  85     // common part of all ctors
  86     void Init();
  87
  88     // create the native toolbar control
  89     bool MSWCreateToolbar(const wxPoint& pos, const wxSize& size);
  90
  91     // recreate the control completely
  92     void Recreate();
  93
  94     // implement base class pure virtuals
  95     virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool);
  96     virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool);
  97
  98     virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable);
  99     virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle);
 100     virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
 101
 102     virtual wxToolBarToolBase *CreateTool(int id,
 103                                           const wxString& label,
 104                                           const wxBitmap& bmpNormal,
 105                                           const wxBitmap& bmpDisabled,
 106                                           wxItemKind kind,
 107                                           wxObject *clientData,
 108                                           const wxString& shortHelp,
 109                                           const wxString& longHelp);
 110
 111     virtual wxToolBarToolBase *CreateTool(wxControl *control,
 112                                           const wxString& label);
 113
 114     // return the appropriate size and flags for the toolbar control
 115     virtual wxSize DoGetBestSize() const;
 116
 117     // handlers for various events
 118     bool HandleSize(WXWPARAM wParam, WXLPARAM lParam);
 119 #ifndef __WXWINCE__
 120     bool HandlePaint(WXWPARAM wParam, WXLPARAM lParam);
 121 #endif // __WXWINCE__
 122     void HandleMouseMove(WXWPARAM wParam, WXLPARAM lParam);
 123
 124     // should be called whenever the toolbar size changes
 125     void UpdateSize();
 126
 127     // create m_disabledImgList (but doesn't fill it), set it to NULL if it is
 128     // unneeded
 129     void CreateDisabledImageList();
 130
 131     // get the Windows toolbar style of this control
 132     long GetMSWToolbarStyle() const;
 133
 134
 135     // the big bitmap containing all bitmaps of the toolbar buttons
 136     WXHBITMAP m_hBitmap;
 137
 138     // the image list with disabled images, may be NULL if we use
 139     // system-provided versions of them
 140     wxImageList *m_disabledImgList;
 141
 142     // the total number of toolbar elements
 143     size_t m_nButtons;
 144
 145     // the sum of the sizes of the fixed items (i.e. excluding stretchable
 146     // spaces) in the toolbar direction
 147     int m_totalFixedSize;
 148
 149     // the tool the cursor is in
 150     wxToolBarToolBase *m_pInTool;
 151
 152 private:
 153     // makes sure tool bitmap size is sufficient for all tools
 154     void AdjustToolBitmapSize();
 155
 156     // update the sizes of stretchable spacers to consume all extra space we
 157     // have
 158     void UpdateStretchableSpacersSize();
 159
 160     // redraw the background of the given part of the window (or entire window
 161     // if the parameter is NULL) to erase separator drawn in it
 162     //
 163     // return true if the background was erased using DrawThemeBackground()
 164     bool MSWEraseRect(wxDC& dc, const wxRect *rectItem = NULL);
 165
 166
 167     DECLARE_EVENT_TABLE()
 168     DECLARE_DYNAMIC_CLASS(wxToolBar)
 169     wxDECLARE_NO_COPY_CLASS(wxToolBar);
 170 };
 171
 172 #endif // wxUSE_TOOLBAR
 173
 174 #endif // _WX_MSW_TBAR95_H_
 175