1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Base class for toolbar classes
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_TBARBASE_H_
13 #define _WX_TBARBASE_H_
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 #if defined(__GNUG__) && !defined(__APPLE__)
20 #pragma interface "tbarbase.h"
27 #include "wx/bitmap.h"
29 #include "wx/control.h"
31 class WXDLLEXPORT wxToolBarBase
;
32 class WXDLLEXPORT wxToolBarToolBase
;
33 class WXDLLEXPORT wxImage
;
35 // ----------------------------------------------------------------------------
37 // ----------------------------------------------------------------------------
39 WXDLLEXPORT_DATA(extern const wxChar
*) wxToolBarNameStr
;
40 WXDLLEXPORT_DATA(extern const wxSize
) wxDefaultSize
;
41 WXDLLEXPORT_DATA(extern const wxPoint
) wxDefaultPosition
;
43 enum wxToolBarToolStyle
45 wxTOOL_STYLE_BUTTON
= 1,
46 wxTOOL_STYLE_SEPARATOR
= 2,
50 // ----------------------------------------------------------------------------
51 // wxToolBarTool is a toolbar element.
53 // It has a unique id (except for the separators which always have id -1), the
54 // style (telling whether it is a normal button, separator or a control), the
55 // state (toggled or not, enabled or not) and short and long help strings. The
56 // default implementations use the short help string for the tooltip text which
57 // is popped up when the mouse pointer enters the tool and the long help string
58 // for the applications status bar.
59 // ----------------------------------------------------------------------------
61 class WXDLLEXPORT wxToolBarToolBase
: public wxObject
67 wxToolBarToolBase(wxToolBarBase
*tbar
= (wxToolBarBase
*)NULL
,
68 int toolid
= wxID_SEPARATOR
,
69 const wxString
& label
= wxEmptyString
,
70 const wxBitmap
& bmpNormal
= wxNullBitmap
,
71 const wxBitmap
& bmpDisabled
= wxNullBitmap
,
72 wxItemKind kind
= wxITEM_NORMAL
,
73 wxObject
*clientData
= (wxObject
*) NULL
,
74 const wxString
& shortHelpString
= wxEmptyString
,
75 const wxString
& longHelpString
= wxEmptyString
)
77 m_shortHelpString(shortHelpString
),
78 m_longHelpString(longHelpString
)
82 m_clientData
= clientData
;
84 m_bmpNormal
= bmpNormal
;
85 m_bmpDisabled
= bmpDisabled
;
92 m_toolStyle
= toolid
== wxID_SEPARATOR
? wxTOOL_STYLE_SEPARATOR
93 : wxTOOL_STYLE_BUTTON
;
96 wxToolBarToolBase(wxToolBarBase
*tbar
, wxControl
*control
)
100 m_id
= control
->GetId();
102 m_kind
= wxITEM_MAX
; // invalid value
107 m_toolStyle
= wxTOOL_STYLE_CONTROL
;
110 ~wxToolBarToolBase();
116 int GetId() const { return m_id
; }
118 wxControl
*GetControl() const
120 wxASSERT_MSG( IsControl(), _T("this toolbar tool is not a control") );
125 wxToolBarBase
*GetToolBar() const { return m_tbar
; }
128 bool IsButton() const { return m_toolStyle
== wxTOOL_STYLE_BUTTON
; }
129 bool IsControl() const { return m_toolStyle
== wxTOOL_STYLE_CONTROL
; }
130 bool IsSeparator() const { return m_toolStyle
== wxTOOL_STYLE_SEPARATOR
; }
131 int GetStyle() const { return m_toolStyle
; }
132 wxItemKind
GetKind() const
134 wxASSERT_MSG( IsButton(), _T("only makes sense for buttons") );
140 bool IsEnabled() const { return m_enabled
; }
141 bool IsToggled() const { return m_toggled
; }
142 bool CanBeToggled() const
143 { return m_kind
== wxITEM_CHECK
|| m_kind
== wxITEM_RADIO
; }
146 const wxBitmap
& GetNormalBitmap() const { return m_bmpNormal
; }
147 const wxBitmap
& GetDisabledBitmap() const { return m_bmpDisabled
; }
149 const wxBitmap
& GetBitmap() const
150 { return IsEnabled() ? GetNormalBitmap() : GetDisabledBitmap(); }
152 wxString
GetLabel() const { return m_label
; }
154 wxString
GetShortHelp() const { return m_shortHelpString
; }
155 wxString
GetLongHelp() const { return m_longHelpString
; }
157 wxObject
*GetClientData() const
159 if ( m_toolStyle
== wxTOOL_STYLE_CONTROL
)
161 return (wxObject
*)m_control
->GetClientData();
169 // modifiers: return TRUE if the state really changed
170 bool Enable(bool enable
);
171 bool Toggle(bool toggle
);
172 bool SetToggle(bool toggle
);
173 bool SetShortHelp(const wxString
& help
);
174 bool SetLongHelp(const wxString
& help
);
176 void Toggle() { Toggle(!IsToggled()); }
178 void SetNormalBitmap(const wxBitmap
& bmp
) { m_bmpNormal
= bmp
; }
179 void SetDisabledBitmap(const wxBitmap
& bmp
) { m_bmpDisabled
= bmp
; }
181 virtual void SetLabel(const wxString
& label
) { m_label
= label
; }
183 void SetClientData(wxObject
*clientData
)
185 if ( m_toolStyle
== wxTOOL_STYLE_CONTROL
)
187 m_control
->SetClientData(clientData
);
191 m_clientData
= clientData
;
195 // add tool to/remove it from a toolbar
196 virtual void Detach() { m_tbar
= (wxToolBarBase
*)NULL
; }
197 virtual void Attach(wxToolBarBase
*tbar
) { m_tbar
= tbar
; }
199 // compatibility only, don't use
200 #if WXWIN_COMPATIBILITY_2_2
201 const wxBitmap
& GetBitmap1() const { return GetNormalBitmap(); }
202 const wxBitmap
& GetBitmap2() const { return GetDisabledBitmap(); }
204 void SetBitmap1(const wxBitmap
& bmp
) { SetNormalBitmap(bmp
); }
205 void SetBitmap2(const wxBitmap
& bmp
) { SetDisabledBitmap(bmp
); }
206 #endif // WXWIN_COMPATIBILITY_2_2
209 wxToolBarBase
*m_tbar
; // the toolbar to which we belong (may be NULL)
212 int m_toolStyle
; // see enum wxToolBarToolStyle
213 int m_id
; // the tool id, wxID_SEPARATOR for separator
214 wxItemKind m_kind
; // for normal buttons may be wxITEM_NORMAL/CHECK/RADIO
216 // as controls have their own client data, no need to waste memory
219 wxObject
*m_clientData
;
220 wxControl
*m_control
;
227 // normal and disabled bitmaps for the tool, both can be invalid
228 wxBitmap m_bmpNormal
;
229 wxBitmap m_bmpDisabled
;
234 // short and long help strings
235 wxString m_shortHelpString
;
236 wxString m_longHelpString
;
238 DECLARE_NO_COPY_CLASS(wxToolBarToolBase
)
241 // a list of toolbar tools
242 WX_DECLARE_EXPORTED_LIST(wxToolBarToolBase
, wxToolBarToolsList
);
244 // ----------------------------------------------------------------------------
245 // the base class for all toolbars
246 // ----------------------------------------------------------------------------
248 class WXDLLEXPORT wxToolBarBase
: public wxControl
252 virtual ~wxToolBarBase();
254 // toolbar construction
255 // --------------------
257 // the full AddTool() function
259 // If bmpDisabled is wxNullBitmap, a shadowed version of the normal bitmap
260 // is created and used as the disabled image.
261 wxToolBarToolBase
*AddTool(int toolid
,
262 const wxString
& label
,
263 const wxBitmap
& bitmap
,
264 const wxBitmap
& bmpDisabled
,
265 wxItemKind kind
= wxITEM_NORMAL
,
266 const wxString
& shortHelp
= wxEmptyString
,
267 const wxString
& longHelp
= wxEmptyString
,
268 wxObject
*data
= NULL
)
270 return DoAddTool(toolid
, label
, bitmap
, bmpDisabled
, kind
,
271 shortHelp
, longHelp
, data
);
274 // the most common AddTool() version
275 wxToolBarToolBase
*AddTool(int toolid
,
276 const wxString
& label
,
277 const wxBitmap
& bitmap
,
278 const wxString
& shortHelp
= wxEmptyString
,
279 wxItemKind kind
= wxITEM_NORMAL
)
281 return AddTool(toolid
, label
, bitmap
, wxNullBitmap
, kind
, shortHelp
);
284 // add a check tool, i.e. a tool which can be toggled
285 wxToolBarToolBase
*AddCheckTool(int toolid
,
286 const wxString
& label
,
287 const wxBitmap
& bitmap
,
288 const wxBitmap
& bmpDisabled
= wxNullBitmap
,
289 const wxString
& shortHelp
= wxEmptyString
,
290 const wxString
& longHelp
= wxEmptyString
,
291 wxObject
*data
= NULL
)
293 return AddTool(toolid
, label
, bitmap
, bmpDisabled
, wxITEM_CHECK
,
294 shortHelp
, longHelp
, data
);
297 // add a radio tool, i.e. a tool which can be toggled and releases any
298 // other toggled radio tools in the same group when it happens
299 wxToolBarToolBase
*AddRadioTool(int toolid
,
300 const wxString
& label
,
301 const wxBitmap
& bitmap
,
302 const wxBitmap
& bmpDisabled
= wxNullBitmap
,
303 const wxString
& shortHelp
= wxEmptyString
,
304 const wxString
& longHelp
= wxEmptyString
,
305 wxObject
*data
= NULL
)
307 return AddTool(toolid
, label
, bitmap
, bmpDisabled
, wxITEM_RADIO
,
308 shortHelp
, longHelp
, data
);
312 // insert the new tool at the given position, if pos == GetToolsCount(), it
313 // is equivalent to AddTool()
314 virtual wxToolBarToolBase
*InsertTool
318 const wxString
& label
,
319 const wxBitmap
& bitmap
,
320 const wxBitmap
& bmpDisabled
= wxNullBitmap
,
321 wxItemKind kind
= wxITEM_NORMAL
,
322 const wxString
& shortHelp
= wxEmptyString
,
323 const wxString
& longHelp
= wxEmptyString
,
324 wxObject
*clientData
= NULL
327 virtual wxToolBarToolBase
*AddTool (wxToolBarToolBase
*tool
);
328 virtual wxToolBarToolBase
*InsertTool (size_t pos
, wxToolBarToolBase
*tool
);
330 // add an arbitrary control to the toolbar, return TRUE if ok (notice that
331 // the control will be deleted by the toolbar and that it will also adjust
332 // its position/size)
334 // NB: the control should have toolbar as its parent
335 virtual wxToolBarToolBase
*AddControl(wxControl
*control
);
336 virtual wxToolBarToolBase
*InsertControl(size_t pos
, wxControl
*control
);
338 // get the control with the given id or return NULL
339 virtual wxControl
*FindControl( int toolid
);
341 // add a separator to the toolbar
342 virtual wxToolBarToolBase
*AddSeparator();
343 virtual wxToolBarToolBase
*InsertSeparator(size_t pos
);
345 // remove the tool from the toolbar: the caller is responsible for actually
346 // deleting the pointer
347 virtual wxToolBarToolBase
*RemoveTool(int toolid
);
349 // delete tool either by index or by position
350 virtual bool DeleteToolByPos(size_t pos
);
351 virtual bool DeleteTool(int toolid
);
354 virtual void ClearTools();
356 // must be called after all buttons have been created to finish toolbar
358 virtual bool Realize();
363 virtual void EnableTool(int toolid
, bool enable
);
364 virtual void ToggleTool(int toolid
, bool toggle
);
366 // Set this to be togglable (or not)
367 virtual void SetToggle(int toolid
, bool toggle
);
369 // set/get tools client data (not for controls)
370 virtual wxObject
*GetToolClientData(int toolid
) const;
371 virtual void SetToolClientData(int toolid
, wxObject
*clientData
);
373 // returns tool pos, or wxNOT_FOUND if tool isn't found
374 virtual int GetToolPos(int id
) const;
376 // return TRUE if the tool is toggled
377 virtual bool GetToolState(int toolid
) const;
379 virtual bool GetToolEnabled(int toolid
) const;
381 virtual void SetToolShortHelp(int toolid
, const wxString
& helpString
);
382 virtual wxString
GetToolShortHelp(int toolid
) const;
383 virtual void SetToolLongHelp(int toolid
, const wxString
& helpString
);
384 virtual wxString
GetToolLongHelp(int toolid
) const;
386 // margins/packing/separation
387 // --------------------------
389 virtual void SetMargins(int x
, int y
);
390 void SetMargins(const wxSize
& size
)
391 { SetMargins((int) size
.x
, (int) size
.y
); }
392 virtual void SetToolPacking(int packing
)
393 { m_toolPacking
= packing
; }
394 virtual void SetToolSeparation(int separation
)
395 { m_toolSeparation
= separation
; }
397 virtual wxSize
GetToolMargins() const { return wxSize(m_xMargin
, m_yMargin
); }
398 virtual int GetToolPacking() const { return m_toolPacking
; }
399 virtual int GetToolSeparation() const { return m_toolSeparation
; }
404 // set the number of toolbar rows
405 virtual void SetRows(int nRows
);
407 // the toolbar can wrap - limit the number of columns or rows it may take
408 void SetMaxRowsCols(int rows
, int cols
)
409 { m_maxRows
= rows
; m_maxCols
= cols
; }
410 int GetMaxRows() const { return m_maxRows
; }
411 int GetMaxCols() const { return m_maxCols
; }
413 // get/set the size of the bitmaps used by the toolbar: should be called
414 // before adding any tools to the toolbar
415 virtual void SetToolBitmapSize(const wxSize
& size
)
416 { m_defaultWidth
= size
.x
; m_defaultHeight
= size
.y
; };
417 virtual wxSize
GetToolBitmapSize() const
418 { return wxSize(m_defaultWidth
, m_defaultHeight
); }
420 // the button size in some implementations is bigger than the bitmap size:
421 // get the total button size (by default the same as bitmap size)
422 virtual wxSize
GetToolSize() const
423 { return GetToolBitmapSize(); } ;
425 // returns a (non separator) tool containing the point (x, y) or NULL if
426 // there is no tool at this point (corrdinates are client)
427 virtual wxToolBarToolBase
*FindToolForPosition(wxCoord x
,
428 wxCoord y
) const = 0;
430 // return TRUE if this is a vertical toolbar, otherwise FALSE
431 bool IsVertical() const { return HasFlag(wxTB_VERTICAL
); }
434 // the old versions of the various methods kept for compatibility
435 // don't use in the new code!
436 // --------------------------------------------------------------
438 wxToolBarToolBase
*AddTool(int toolid
,
439 const wxBitmap
& bitmap
,
440 const wxBitmap
& bmpDisabled
,
442 wxObject
*clientData
= NULL
,
443 const wxString
& shortHelpString
= wxEmptyString
,
444 const wxString
& longHelpString
= wxEmptyString
)
446 return AddTool(toolid
, wxEmptyString
,
448 toggle
? wxITEM_CHECK
: wxITEM_NORMAL
,
449 shortHelpString
, longHelpString
, clientData
);
452 wxToolBarToolBase
*AddTool(int toolid
,
453 const wxBitmap
& bitmap
,
454 const wxString
& shortHelpString
= wxEmptyString
,
455 const wxString
& longHelpString
= wxEmptyString
)
457 return AddTool(toolid
, wxEmptyString
,
458 bitmap
, wxNullBitmap
, wxITEM_NORMAL
,
459 shortHelpString
, longHelpString
, NULL
);
462 wxToolBarToolBase
*AddTool(int toolid
,
463 const wxBitmap
& bitmap
,
464 const wxBitmap
& bmpDisabled
,
468 wxObject
*clientData
= NULL
,
469 const wxString
& shortHelp
= wxEmptyString
,
470 const wxString
& longHelp
= wxEmptyString
)
472 return DoAddTool(toolid
, wxEmptyString
, bitmap
, bmpDisabled
,
473 toggle
? wxITEM_CHECK
: wxITEM_NORMAL
,
474 shortHelp
, longHelp
, clientData
, xPos
, yPos
);
477 wxToolBarToolBase
*InsertTool(size_t pos
,
479 const wxBitmap
& bitmap
,
480 const wxBitmap
& bmpDisabled
= wxNullBitmap
,
482 wxObject
*clientData
= NULL
,
483 const wxString
& shortHelp
= wxEmptyString
,
484 const wxString
& longHelp
= wxEmptyString
)
486 return InsertTool(pos
, toolid
, wxEmptyString
, bitmap
, bmpDisabled
,
487 toggle
? wxITEM_CHECK
: wxITEM_NORMAL
,
488 shortHelp
, longHelp
, clientData
);
494 // NB: these functions are deprecated, use EVT_TOOL_XXX() instead!
496 // Only allow toggle if returns TRUE. Call when left button up.
497 virtual bool OnLeftClick(int toolid
, bool toggleDown
);
499 // Call when right button down.
500 virtual void OnRightClick(int toolid
, long x
, long y
);
502 // Called when the mouse cursor enters a tool bitmap.
503 // Argument is -1 if mouse is exiting the toolbar.
504 virtual void OnMouseEnter(int toolid
);
506 // more deprecated functions
507 // -------------------------
509 #if WXWIN_COMPATIBILITY
510 void SetDefaultSize(int w
, int h
) { SetDefaultSize(wxSize(w
, h
)); }
511 long GetDefaultWidth() const { return m_defaultWidth
; }
512 long GetDefaultHeight() const { return m_defaultHeight
; }
513 int GetDefaultButtonWidth() const { return (int) GetDefaultButtonSize().x
; };
514 int GetDefaultButtonHeight() const { return (int) GetDefaultButtonSize().y
; };
515 virtual void SetDefaultSize(const wxSize
& size
) { SetToolBitmapSize(size
); }
516 virtual wxSize
GetDefaultSize() const { return GetToolBitmapSize(); }
517 virtual wxSize
GetDefaultButtonSize() const { return GetToolSize(); }
518 #endif // WXWIN_COMPATIBILITY
520 // use GetToolMargins() instead
521 wxSize
GetMargins() const { return GetToolMargins(); }
523 // implementation only from now on
524 // -------------------------------
526 size_t GetToolsCount() const { return m_tools
.GetCount(); }
528 // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
529 virtual void UpdateWindowUI(long flags
= wxUPDATE_UI_NONE
) ;
531 // don't want toolbars to accept the focus
532 virtual bool AcceptsFocus() const { return FALSE
; }
535 // to implement in derived classes
536 // -------------------------------
538 // create a new toolbar tool and add it to the toolbar, this is typically
539 // implemented by just calling InsertTool()
540 virtual wxToolBarToolBase
*DoAddTool
543 const wxString
& label
,
544 const wxBitmap
& bitmap
,
545 const wxBitmap
& bmpDisabled
,
547 const wxString
& shortHelp
= wxEmptyString
,
548 const wxString
& longHelp
= wxEmptyString
,
549 wxObject
*clientData
= NULL
,
554 // the tool is not yet inserted into m_tools list when this function is
555 // called and will only be added to it if this function succeeds
556 virtual bool DoInsertTool(size_t pos
, wxToolBarToolBase
*tool
) = 0;
558 // the tool is still in m_tools list when this function is called, it will
559 // only be deleted from it if it succeeds
560 virtual bool DoDeleteTool(size_t pos
, wxToolBarToolBase
*tool
) = 0;
562 // called when the tools enabled flag changes
563 virtual void DoEnableTool(wxToolBarToolBase
*tool
, bool enable
) = 0;
565 // called when the tool is toggled
566 virtual void DoToggleTool(wxToolBarToolBase
*tool
, bool toggle
) = 0;
568 // called when the tools "can be toggled" flag changes
569 virtual void DoSetToggle(wxToolBarToolBase
*tool
, bool toggle
) = 0;
571 // the functions to create toolbar tools
572 virtual wxToolBarToolBase
*CreateTool(int toolid
,
573 const wxString
& label
,
574 const wxBitmap
& bmpNormal
,
575 const wxBitmap
& bmpDisabled
,
577 wxObject
*clientData
,
578 const wxString
& shortHelp
,
579 const wxString
& longHelp
) = 0;
581 virtual wxToolBarToolBase
*CreateTool(wxControl
*control
) = 0;
586 // find the tool by id
587 wxToolBarToolBase
*FindById(int toolid
) const;
589 // the list of all our tools
590 wxToolBarToolsList m_tools
;
592 // the offset of the first tool
596 // the maximum number of toolbar rows/columns
600 // the tool packing and separation
604 // the size of the toolbar bitmaps
605 wxCoord m_defaultWidth
, m_defaultHeight
;
608 DECLARE_EVENT_TABLE()
609 DECLARE_CLASS(wxToolBarBase
)
612 // Helper function for creating the image for disabled buttons
613 bool wxCreateGreyedImage(const wxImage
& in
, wxImage
& out
) ;
615 #endif // wxUSE_TOOLBAR