1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/tbarbase.cpp
3 // Purpose: wxToolBarBase implementation
4 // Author: Julian Smart
5 // Modified by: VZ at 11.12.99 (wxScrollableToolBar split off)
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #include "wx/toolbar.h"
32 #include "wx/control.h"
34 #include "wx/settings.h"
35 #if WXWIN_COMPATIBILITY_2_8
37 #endif // WXWIN_COMPATIBILITY_2_8
41 // ----------------------------------------------------------------------------
43 // ----------------------------------------------------------------------------
45 BEGIN_EVENT_TABLE(wxToolBarBase
, wxControl
)
48 #include "wx/listimpl.cpp"
50 WX_DEFINE_LIST(wxToolBarToolsList
)
52 // ============================================================================
54 // ============================================================================
56 // ----------------------------------------------------------------------------
58 // ----------------------------------------------------------------------------
60 IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase
, wxObject
)
62 wxToolBarToolBase::~wxToolBarToolBase()
64 delete m_dropdownMenu
;
66 GetControl()->Destroy();
70 bool wxToolBarToolBase::Enable(bool enable
)
72 if ( m_enabled
== enable
)
80 bool wxToolBarToolBase::Toggle(bool toggle
)
82 wxASSERT_MSG( CanBeToggled(), wxT("can't toggle this tool") );
84 if ( m_toggled
== toggle
)
92 bool wxToolBarToolBase::SetToggle(bool toggle
)
94 wxItemKind kind
= toggle
? wxITEM_CHECK
: wxITEM_NORMAL
;
103 bool wxToolBarToolBase::SetShortHelp(const wxString
& help
)
105 if ( m_shortHelpString
== help
)
108 m_shortHelpString
= help
;
113 bool wxToolBarToolBase::SetLongHelp(const wxString
& help
)
115 if ( m_longHelpString
== help
)
118 m_longHelpString
= help
;
124 void wxToolBarToolBase::SetDropdownMenu(wxMenu
* menu
)
126 delete m_dropdownMenu
;
127 m_dropdownMenu
= menu
;
131 // ----------------------------------------------------------------------------
132 // wxToolBarBase adding/deleting items
133 // ----------------------------------------------------------------------------
135 wxToolBarBase::wxToolBarBase()
137 // the list owns the pointers
138 m_xMargin
= m_yMargin
= 0;
139 m_maxRows
= m_maxCols
= 0;
140 m_toolPacking
= m_toolSeparation
= 0;
142 m_defaultHeight
= 15;
145 void wxToolBarBase::FixupStyle()
147 if ( !HasFlag(wxTB_TOP
| wxTB_LEFT
| wxTB_RIGHT
| wxTB_BOTTOM
) )
149 // this is the default
150 m_windowStyle
|= wxTB_TOP
;
154 wxToolBarToolBase
*wxToolBarBase::DoAddTool(int id
,
155 const wxString
& label
,
156 const wxBitmap
& bitmap
,
157 const wxBitmap
& bmpDisabled
,
159 const wxString
& shortHelp
,
160 const wxString
& longHelp
,
161 wxObject
*clientData
,
162 wxCoord
WXUNUSED(xPos
),
163 wxCoord
WXUNUSED(yPos
))
165 InvalidateBestSize();
166 return InsertTool(GetToolsCount(), id
, label
, bitmap
, bmpDisabled
,
167 kind
, shortHelp
, longHelp
, clientData
);
170 wxToolBarToolBase
*wxToolBarBase::InsertTool(size_t pos
,
172 const wxString
& label
,
173 const wxBitmap
& bitmap
,
174 const wxBitmap
& bmpDisabled
,
176 const wxString
& shortHelp
,
177 const wxString
& longHelp
,
178 wxObject
*clientData
)
180 wxCHECK_MSG( pos
<= GetToolsCount(), NULL
,
181 wxT("invalid position in wxToolBar::InsertTool()") );
183 return DoInsertNewTool(pos
, CreateTool(id
, label
, bitmap
, bmpDisabled
, kind
,
184 clientData
, shortHelp
, longHelp
));
187 wxToolBarToolBase
*wxToolBarBase::AddTool(wxToolBarToolBase
*tool
)
189 return InsertTool(GetToolsCount(), tool
);
193 wxToolBarBase::InsertTool(size_t pos
, wxToolBarToolBase
*tool
)
195 wxCHECK_MSG( pos
<= GetToolsCount(), NULL
,
196 wxT("invalid position in wxToolBar::InsertTool()") );
198 if ( !tool
|| !DoInsertTool(pos
, tool
) )
203 m_tools
.Insert(pos
, tool
);
210 wxToolBarBase::AddControl(wxControl
*control
, const wxString
& label
)
212 return InsertControl(GetToolsCount(), control
, label
);
216 wxToolBarBase::InsertControl(size_t pos
,
218 const wxString
& label
)
220 wxCHECK_MSG( control
, NULL
,
221 wxT("toolbar: can't insert NULL control") );
223 wxCHECK_MSG( control
->GetParent() == this, NULL
,
224 wxT("control must have toolbar as parent") );
226 return DoInsertNewTool(pos
, CreateTool(control
, label
));
229 wxControl
*wxToolBarBase::FindControl( int id
)
231 for ( wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
233 node
= node
->GetNext() )
235 const wxToolBarToolBase
* const tool
= node
->GetData();
236 if ( tool
->IsControl() )
238 wxControl
* const control
= tool
->GetControl();
242 wxFAIL_MSG( wxT("NULL control in toolbar?") );
244 else if ( control
->GetId() == id
)
255 wxToolBarToolBase
*wxToolBarBase::AddSeparator()
257 return InsertSeparator(GetToolsCount());
260 wxToolBarToolBase
*wxToolBarBase::InsertSeparator(size_t pos
)
262 return DoInsertNewTool(pos
, CreateTool(wxID_SEPARATOR
,
264 wxNullBitmap
, wxNullBitmap
,
265 wxITEM_SEPARATOR
, NULL
,
266 wxEmptyString
, wxEmptyString
));
269 wxToolBarToolBase
*wxToolBarBase::RemoveTool(int id
)
272 wxToolBarToolsList::compatibility_iterator node
;
273 for ( node
= m_tools
.GetFirst(); node
; node
= node
->GetNext() )
275 if ( node
->GetData()->GetId() == id
)
283 // don't give any error messages - sometimes we might call RemoveTool()
284 // without knowing whether the tool is or not in the toolbar
288 wxToolBarToolBase
*tool
= node
->GetData();
289 wxCHECK_MSG( tool
, NULL
, "NULL tool in the tools list?" );
291 if ( !DoDeleteTool(pos
, tool
) )
301 bool wxToolBarBase::DeleteToolByPos(size_t pos
)
303 wxCHECK_MSG( pos
< GetToolsCount(), false,
304 wxT("invalid position in wxToolBar::DeleteToolByPos()") );
306 wxToolBarToolsList::compatibility_iterator node
= m_tools
.Item(pos
);
308 if ( !DoDeleteTool(pos
, node
->GetData()) )
313 delete node
->GetData();
319 bool wxToolBarBase::DeleteTool(int id
)
322 wxToolBarToolsList::compatibility_iterator node
;
323 for ( node
= m_tools
.GetFirst(); node
; node
= node
->GetNext() )
325 if ( node
->GetData()->GetId() == id
)
331 if ( !node
|| !DoDeleteTool(pos
, node
->GetData()) )
336 delete node
->GetData();
342 wxToolBarToolBase
*wxToolBarBase::FindById(int id
) const
344 wxToolBarToolBase
*tool
= NULL
;
346 for ( wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
348 node
= node
->GetNext() )
350 tool
= node
->GetData();
351 if ( tool
->GetId() == id
)
363 void wxToolBarBase::UnToggleRadioGroup(wxToolBarToolBase
*tool
)
365 wxCHECK_RET( tool
, wxT("NULL tool in wxToolBarTool::UnToggleRadioGroup") );
367 if ( !tool
->IsButton() || tool
->GetKind() != wxITEM_RADIO
)
370 wxToolBarToolsList::compatibility_iterator node
= m_tools
.Find(tool
);
371 wxCHECK_RET( node
, wxT("invalid tool in wxToolBarTool::UnToggleRadioGroup") );
373 wxToolBarToolsList::compatibility_iterator nodeNext
= node
->GetNext();
376 wxToolBarToolBase
*toolNext
= nodeNext
->GetData();
378 if ( !toolNext
->IsButton() || toolNext
->GetKind() != wxITEM_RADIO
)
381 if ( toolNext
->Toggle(false) )
383 DoToggleTool(toolNext
, false);
386 nodeNext
= nodeNext
->GetNext();
389 wxToolBarToolsList::compatibility_iterator nodePrev
= node
->GetPrevious();
392 wxToolBarToolBase
*toolNext
= nodePrev
->GetData();
394 if ( !toolNext
->IsButton() || toolNext
->GetKind() != wxITEM_RADIO
)
397 if ( toolNext
->Toggle(false) )
399 DoToggleTool(toolNext
, false);
402 nodePrev
= nodePrev
->GetPrevious();
406 void wxToolBarBase::ClearTools()
408 while ( GetToolsCount() )
414 void wxToolBarBase::AdjustToolBitmapSize()
416 const wxSize
sizeOrig(m_defaultWidth
, m_defaultHeight
);
418 wxSize
sizeActual(sizeOrig
);
420 for ( wxToolBarToolsList::const_iterator i
= m_tools
.begin();
424 const wxBitmap
& bmp
= (*i
)->GetNormalBitmap();
426 sizeActual
.IncTo(bmp
.GetSize());
429 if ( sizeActual
!= sizeOrig
)
430 SetToolBitmapSize(sizeActual
);
433 bool wxToolBarBase::Realize()
435 // check if we have anything to do
436 if ( m_tools
.empty() )
439 // make sure tool size is larger enough for all all bitmaps to fit in
440 // (this is consistent with what other ports do):
441 AdjustToolBitmapSize();
446 wxToolBarBase::~wxToolBarBase()
448 WX_CLEAR_LIST(wxToolBarToolsList
, m_tools
);
450 // notify the frame that it doesn't have a tool bar any longer to avoid
452 wxFrame
*frame
= wxDynamicCast(GetParent(), wxFrame
);
453 if ( frame
&& frame
->GetToolBar() == this )
455 frame
->SetToolBar(NULL
);
459 // ----------------------------------------------------------------------------
460 // wxToolBarBase tools state
461 // ----------------------------------------------------------------------------
463 void wxToolBarBase::EnableTool(int id
, bool enable
)
465 wxToolBarToolBase
*tool
= FindById(id
);
468 if ( tool
->Enable(enable
) )
470 DoEnableTool(tool
, enable
);
475 void wxToolBarBase::ToggleTool(int id
, bool toggle
)
477 wxToolBarToolBase
*tool
= FindById(id
);
478 if ( tool
&& tool
->CanBeToggled() )
480 if ( tool
->Toggle(toggle
) )
482 UnToggleRadioGroup(tool
);
483 DoToggleTool(tool
, toggle
);
488 void wxToolBarBase::SetToggle(int id
, bool toggle
)
490 wxToolBarToolBase
*tool
= FindById(id
);
493 if ( tool
->SetToggle(toggle
) )
495 DoSetToggle(tool
, toggle
);
500 void wxToolBarBase::SetToolShortHelp(int id
, const wxString
& help
)
502 wxToolBarToolBase
*tool
= FindById(id
);
505 (void)tool
->SetShortHelp(help
);
509 void wxToolBarBase::SetToolLongHelp(int id
, const wxString
& help
)
511 wxToolBarToolBase
*tool
= FindById(id
);
514 (void)tool
->SetLongHelp(help
);
518 wxObject
*wxToolBarBase::GetToolClientData(int id
) const
520 wxToolBarToolBase
*tool
= FindById(id
);
522 return tool
? tool
->GetClientData() : NULL
;
525 void wxToolBarBase::SetToolClientData(int id
, wxObject
*clientData
)
527 wxToolBarToolBase
*tool
= FindById(id
);
529 wxCHECK_RET( tool
, wxT("no such tool in wxToolBar::SetToolClientData") );
531 tool
->SetClientData(clientData
);
534 int wxToolBarBase::GetToolPos(int id
) const
537 wxToolBarToolsList::compatibility_iterator node
;
539 for ( node
= m_tools
.GetFirst(); node
; node
= node
->GetNext() )
541 if ( node
->GetData()->GetId() == id
)
550 bool wxToolBarBase::GetToolState(int id
) const
552 wxToolBarToolBase
*tool
= FindById(id
);
553 wxCHECK_MSG( tool
, false, wxT("no such tool") );
555 return tool
->IsToggled();
558 bool wxToolBarBase::GetToolEnabled(int id
) const
560 wxToolBarToolBase
*tool
= FindById(id
);
561 wxCHECK_MSG( tool
, false, wxT("no such tool") );
563 return tool
->IsEnabled();
566 wxString
wxToolBarBase::GetToolShortHelp(int id
) const
568 wxToolBarToolBase
*tool
= FindById(id
);
569 wxCHECK_MSG( tool
, wxEmptyString
, wxT("no such tool") );
571 return tool
->GetShortHelp();
574 wxString
wxToolBarBase::GetToolLongHelp(int id
) const
576 wxToolBarToolBase
*tool
= FindById(id
);
577 wxCHECK_MSG( tool
, wxEmptyString
, wxT("no such tool") );
579 return tool
->GetLongHelp();
582 // ----------------------------------------------------------------------------
583 // wxToolBarBase geometry
584 // ----------------------------------------------------------------------------
586 void wxToolBarBase::SetMargins(int x
, int y
)
592 void wxToolBarBase::SetRows(int WXUNUSED(nRows
))
597 bool wxToolBarBase::IsVertical() const
599 return HasFlag(wxTB_LEFT
| wxTB_RIGHT
);
603 // ----------------------------------------------------------------------------
605 // ----------------------------------------------------------------------------
607 // Only allow toggle if returns true
608 bool wxToolBarBase::OnLeftClick(int id
, bool toggleDown
)
610 wxCommandEvent
event(wxEVT_COMMAND_TOOL_CLICKED
, id
);
611 event
.SetEventObject(this);
613 // we use SetInt() to make wxCommandEvent::IsChecked() return toggleDown
614 event
.SetInt((int)toggleDown
);
616 // and SetExtraLong() for backwards compatibility
617 event
.SetExtraLong((long)toggleDown
);
619 // Send events to this toolbar instead (and thence up the window hierarchy)
620 HandleWindowEvent(event
);
625 // Call when right button down.
626 void wxToolBarBase::OnRightClick(int id
,
630 wxCommandEvent
event(wxEVT_COMMAND_TOOL_RCLICKED
, id
);
631 event
.SetEventObject(this);
634 GetEventHandler()->ProcessEvent(event
);
637 // Called when the mouse cursor enters a tool bitmap (no button pressed).
638 // Argument is wxID_ANY if mouse is exiting the toolbar.
639 // Note that for this event, the id of the window is used,
640 // and the integer parameter of wxCommandEvent is used to retrieve
642 void wxToolBarBase::OnMouseEnter(int id
)
644 wxCommandEvent
event(wxEVT_COMMAND_TOOL_ENTER
, GetId());
645 event
.SetEventObject(this);
648 wxFrame
*frame
= wxDynamicCast(GetParent(), wxFrame
);
652 if ( id
!= wxID_ANY
)
654 const wxToolBarToolBase
* const tool
= FindById(id
);
656 help
= tool
->GetLongHelp();
659 // call DoGiveHelp() even if help string is empty to avoid showing the
660 // help for the previously selected tool when another one is selected
661 frame
->DoGiveHelp(help
, id
!= wxID_ANY
);
664 (void)GetEventHandler()->ProcessEvent(event
);
667 // ----------------------------------------------------------------------------
669 // ----------------------------------------------------------------------------
671 // Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
672 void wxToolBarBase::UpdateWindowUI(long flags
)
674 wxWindowBase::UpdateWindowUI(flags
);
676 // don't waste time updating state of tools in a hidden toolbar
680 // There is no sense in updating the toolbar UI
681 // if the parent window is about to get destroyed
682 wxWindow
*tlw
= wxGetTopLevelParent( this );
683 if (tlw
&& wxPendingDelete
.Member( tlw
))
686 wxEvtHandler
* evtHandler
= GetEventHandler() ;
688 for ( wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
690 node
= node
->GetNext() )
692 wxToolBarToolBase
* const tool
= node
->GetData();
693 if ( tool
->IsSeparator() )
696 int id
= tool
->GetId();
698 wxUpdateUIEvent
event(id
);
699 event
.SetEventObject(this);
701 if ( evtHandler
->ProcessEvent(event
) )
703 if ( event
.GetSetEnabled() )
704 EnableTool(id
, event
.GetEnabled());
705 if ( event
.GetSetChecked() )
706 ToggleTool(id
, event
.GetChecked());
708 if ( event
.GetSetText() )
715 bool wxToolBarBase::SetDropdownMenu(int toolid
, wxMenu
* menu
)
717 wxToolBarToolBase
* const tool
= FindById(toolid
);
718 wxCHECK_MSG( tool
, false, wxT("invalid tool id") );
720 wxCHECK_MSG( tool
->GetKind() == wxITEM_DROPDOWN
, false,
721 wxT("menu can be only associated with drop down tools") );
723 tool
->SetDropdownMenu(menu
);
728 #if WXWIN_COMPATIBILITY_2_8
730 bool wxCreateGreyedImage(const wxImage
& in
, wxImage
& out
)
733 out
= in
.ConvertToGreyscale();
736 #endif // wxUSE_IMAGE
740 #endif // WXWIN_COMPATIBILITY_2_8
742 #endif // wxUSE_TOOLBAR