removed C++ comment added by last commit
[wxWidgets.git] / include / wx / univ / toolbar.h
CommitLineData
c08a4f00
RR
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
65571936 9// Licence: wxWindows licence
c08a4f00
RR
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_UNIV_TOOLBAR_H_
13#define _WX_UNIV_TOOLBAR_H_
14
12028905 15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
c08a4f00
RR
16 #pragma interface "univtoolbar.h"
17#endif
18
3216dbf5
VZ
19#include "wx/button.h" // for wxStdButtonInputHandler
20
21class WXDLLEXPORT wxToolBarTool;
c08a4f00
RR
22
23// ----------------------------------------------------------------------------
3216dbf5 24// the actions supported by this control
c08a4f00
RR
25// ----------------------------------------------------------------------------
26
3216dbf5
VZ
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
c08a4f00 33
3216dbf5
VZ
34// ----------------------------------------------------------------------------
35// wxToolBar
36// ----------------------------------------------------------------------------
c08a4f00 37
3216dbf5 38class WXDLLEXPORT wxToolBar : public wxToolBarBase
c08a4f00
RR
39{
40public:
41 // construction/destruction
6463b9f5 42 wxToolBar() { Init(); }
3216dbf5
VZ
43 wxToolBar(wxWindow *parent,
44 wxWindowID id,
45 const wxPoint& pos = wxDefaultPosition,
46 const wxSize& size = wxDefaultSize,
47 long style = 0,
6463b9f5
JS
48 const wxString& name = wxToolBarNameStr)
49 {
50 Init();
51
52 Create(parent, id, pos, size, style, name);
53 }
c08a4f00
RR
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
3216dbf5 62 virtual ~wxToolBar();
c08a4f00
RR
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
34d26f42
RR
70 virtual void SetMargins(int x, int y);
71 void SetMargins(const wxSize& size)
72 { SetMargins((int) size.x, (int) size.y); }
73
c08a4f00
RR
74protected:
75 // common part of all ctors
76 void Init();
77
78 // implement base class pure virtuals
79 virtual bool DoInsertTool(size_t pos, wxToolBarToolBase *tool);
80 virtual bool DoDeleteTool(size_t pos, wxToolBarToolBase *tool);
81
82 virtual void DoEnableTool(wxToolBarToolBase *tool, bool enable);
83 virtual void DoToggleTool(wxToolBarToolBase *tool, bool toggle);
84 virtual void DoSetToggle(wxToolBarToolBase *tool, bool toggle);
85
86 virtual wxToolBarToolBase *CreateTool(int id,
d448aec3
VZ
87 const wxString& label,
88 const wxBitmap& bmpNormal,
89 const wxBitmap& bmpDisabled,
90 wxItemKind kind,
c08a4f00 91 wxObject *clientData,
d448aec3
VZ
92 const wxString& shortHelp,
93 const wxString& longHelp);
c08a4f00 94 virtual wxToolBarToolBase *CreateTool(wxControl *control);
16c9a425 95
3216dbf5
VZ
96 // implement wxUniversal methods
97 virtual bool PerformAction(const wxControlAction& action,
98 long numArg = -1,
99 const wxString& strArg = wxEmptyString);
100 virtual wxSize DoGetBestClientSize() const;
dda4f6c0
JS
101 virtual void DoSetSize(int x, int y,
102 int width, int height,
103 int sizeFlags = wxSIZE_AUTO);
3216dbf5
VZ
104 virtual void DoDraw(wxControlRenderer *renderer);
105
106 // get the bounding rect for the given tool
107 wxRect GetToolRect(wxToolBarToolBase *tool) const;
108
109 // redraw the given tool
110 void RefreshTool(wxToolBarToolBase *tool);
111
112 // (re)calculate the tool positions, should only be called if it is
a290fa5a 113 // necessary to do it, i.e. m_needsLayout == true
3216dbf5 114 void DoLayout();
c08a4f00 115
3216dbf5
VZ
116 // get the rect limits depending on the orientation: top/bottom for a
117 // vertical toolbar, left/right for a horizontal one
118 void GetRectLimits(const wxRect& rect, wxCoord *start, wxCoord *end) const;
119
c08a4f00 120private:
3216dbf5
VZ
121 // have we calculated the positions of our tools?
122 bool m_needsLayout;
123
124 // the width of a separator
125 wxCoord m_widthSeparator;
126
127 // the total size of all toolbar elements
128 wxCoord m_maxWidth,
129 m_maxHeight;
3216dbf5 130
34d26f42 131private:
3216dbf5
VZ
132 DECLARE_DYNAMIC_CLASS(wxToolBar)
133};
134
135// ----------------------------------------------------------------------------
136// wxStdToolbarInputHandler: translates SPACE and ENTER keys and the left mouse
137// click into button press/release actions
138// ----------------------------------------------------------------------------
139
34d26f42 140class WXDLLEXPORT wxStdToolbarInputHandler : public wxStdInputHandler
3216dbf5
VZ
141{
142public:
143 wxStdToolbarInputHandler(wxInputHandler *inphand);
144
145 virtual bool HandleKey(wxInputConsumer *consumer,
146 const wxKeyEvent& event,
147 bool pressed);
4e89ceb1
VZ
148 virtual bool HandleMouse(wxInputConsumer *consumer,
149 const wxMouseEvent& event);
3216dbf5
VZ
150 virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
151 virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
152 virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
34d26f42
RR
153
154private:
155 wxWindow *m_winCapture;
156 wxToolBarToolBase *m_toolCapture;
157 wxToolBarToolBase *m_toolLast;
c08a4f00
RR
158};
159
160#endif // _WX_UNIV_TOOLBAR_H_