X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12ed316d02733e7111a6967f6ae41e2c0ceaa57a..0bf14ab8b14d3a999fe1159d2bec33740e066a53:/src/common/tbarbase.cpp diff --git a/src/common/tbarbase.cpp b/src/common/tbarbase.cpp index d904ff9194..f6bc3617dc 100644 --- a/src/common/tbarbase.cpp +++ b/src/common/tbarbase.cpp @@ -1,12 +1,12 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: common/tbarbase.cpp +// Name: src/common/tbarbase.cpp // Purpose: wxToolBarBase implementation // Author: Julian Smart -// Modified by: VZ at 11.12.99 (wxScrollableToolBar splitted off) +// Modified by: VZ at 11.12.99 (wxScrollableToolBar split off) // Created: 04/01/98 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "tbarbase.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -28,36 +24,30 @@ #pragma hdrstop #endif -#ifndef WX_PRECOMP - #include "wx/wx.h" -#endif +#if wxUSE_TOOLBAR -#include "wx/frame.h" +#include "wx/toolbar.h" -// For ::UpdateWindow -#ifdef __WXMSW__ -#include +#ifndef WX_PRECOMP + #include "wx/control.h" + #include "wx/frame.h" + #include "wx/settings.h" + #if WXWIN_COMPATIBILITY_2_8 + #include "wx/image.h" + #endif // WXWIN_COMPATIBILITY_2_8 + #include "wx/menu.h" #endif -#if wxUSE_TOOLBAR - -#include "wx/tbarbase.h" - // ---------------------------------------------------------------------------- -// wxWindows macros +// wxWidgets macros // ---------------------------------------------------------------------------- -#if !USE_SHARED_LIBRARY - BEGIN_EVENT_TABLE(wxToolBarBase, wxControl) - EVT_IDLE(wxToolBarBase::OnIdle) - END_EVENT_TABLE() -#endif - -IMPLEMENT_CLASS(wxToolBarBase, wxControl) +BEGIN_EVENT_TABLE(wxToolBarBase, wxControl) +END_EVENT_TABLE() #include "wx/listimpl.cpp" -WX_DEFINE_LIST(wxToolBarToolsList); +WX_DEFINE_LIST(wxToolBarToolsList) // ============================================================================ // implementation @@ -67,62 +57,77 @@ WX_DEFINE_LIST(wxToolBarToolsList); // wxToolBarToolBase // ---------------------------------------------------------------------------- +IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject) + +wxToolBarToolBase::~wxToolBarToolBase() +{ + delete m_dropdownMenu; + if ( IsControl() ) + GetControl()->Destroy(); +} + + bool wxToolBarToolBase::Enable(bool enable) { if ( m_enabled == enable ) - return FALSE; + return false; m_enabled = enable; - return TRUE; + return true; } bool wxToolBarToolBase::Toggle(bool toggle) { - wxASSERT_MSG( m_isToggle, _T("can't toggle this tool") ); + wxASSERT_MSG( CanBeToggled(), wxT("can't toggle this tool") ); if ( m_toggled == toggle ) - return FALSE; + return false; m_toggled = toggle; - return TRUE; + return true; } bool wxToolBarToolBase::SetToggle(bool toggle) { - if ( m_isToggle == toggle ) - return FALSE; + wxItemKind kind = toggle ? wxITEM_CHECK : wxITEM_NORMAL; + if ( m_kind == kind ) + return false; - m_isToggle = toggle; + m_kind = kind; - return TRUE; + return true; } bool wxToolBarToolBase::SetShortHelp(const wxString& help) { if ( m_shortHelpString == help ) - return FALSE; + return false; m_shortHelpString = help; - return TRUE; + return true; } bool wxToolBarToolBase::SetLongHelp(const wxString& help) { if ( m_longHelpString == help ) - return FALSE; + return false; m_longHelpString = help; - return TRUE; + return true; } -wxToolBarToolBase::~wxToolBarToolBase() + +void wxToolBarToolBase::SetDropdownMenu(wxMenu* menu) { + delete m_dropdownMenu; + m_dropdownMenu = menu; } + // ---------------------------------------------------------------------------- // wxToolBarBase adding/deleting items // ---------------------------------------------------------------------------- @@ -130,82 +135,121 @@ wxToolBarToolBase::~wxToolBarToolBase() wxToolBarBase::wxToolBarBase() { // the list owns the pointers - m_tools.DeleteContents(TRUE); - m_xMargin = m_yMargin = 0; - m_maxRows = m_maxCols = 0; + m_toolPacking = m_toolSeparation = 0; + m_defaultWidth = 16; + m_defaultHeight = 15; +} + +void wxToolBarBase::FixupStyle() +{ + if ( !HasFlag(wxTB_TOP | wxTB_LEFT | wxTB_RIGHT | wxTB_BOTTOM) ) + { + // this is the default + m_windowStyle |= wxTB_TOP; + } } -wxToolBarToolBase *wxToolBarBase::AddTool(int id, - const wxBitmap& bitmap, - const wxBitmap& pushedBitmap, - bool toggle, - wxCoord WXUNUSED(xPos), - wxCoord WXUNUSED(yPos), - wxObject *clientData, - const wxString& helpString1, - const wxString& helpString2) +wxToolBarToolBase *wxToolBarBase::DoAddTool(int id, + const wxString& label, + const wxBitmap& bitmap, + const wxBitmap& bmpDisabled, + wxItemKind kind, + const wxString& shortHelp, + const wxString& longHelp, + wxObject *clientData, + wxCoord WXUNUSED(xPos), + wxCoord WXUNUSED(yPos)) { - return InsertTool(GetToolsCount(), id, bitmap, pushedBitmap, - toggle, clientData, helpString1, helpString2); + InvalidateBestSize(); + return InsertTool(GetToolsCount(), id, label, bitmap, bmpDisabled, + kind, shortHelp, longHelp, clientData); } wxToolBarToolBase *wxToolBarBase::InsertTool(size_t pos, int id, + const wxString& label, const wxBitmap& bitmap, - const wxBitmap& pushedBitmap, - bool toggle, - wxObject *clientData, - const wxString& helpString1, - const wxString& helpString2) + const wxBitmap& bmpDisabled, + wxItemKind kind, + const wxString& shortHelp, + const wxString& longHelp, + wxObject *clientData) { - wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL, - _T("invalid position in wxToolBar::InsertTool()") ); + wxCHECK_MSG( pos <= GetToolsCount(), NULL, + wxT("invalid position in wxToolBar::InsertTool()") ); - wxToolBarToolBase *tool = CreateTool(id, bitmap, pushedBitmap, toggle, - clientData, helpString1, helpString2); + return DoInsertNewTool(pos, CreateTool(id, label, bitmap, bmpDisabled, kind, + clientData, shortHelp, longHelp)); +} + +wxToolBarToolBase *wxToolBarBase::AddTool(wxToolBarToolBase *tool) +{ + return InsertTool(GetToolsCount(), tool); +} + +wxToolBarToolBase * +wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool) +{ + wxCHECK_MSG( pos <= GetToolsCount(), NULL, + wxT("invalid position in wxToolBar::InsertTool()") ); if ( !tool || !DoInsertTool(pos, tool) ) { - delete tool; - return NULL; } m_tools.Insert(pos, tool); + tool->Attach(this); return tool; } -wxToolBarToolBase *wxToolBarBase::AddControl(wxControl *control) +wxToolBarToolBase * +wxToolBarBase::AddControl(wxControl *control, const wxString& label) { - return InsertControl(GetToolsCount(), control); + return InsertControl(GetToolsCount(), control, label); } -wxToolBarToolBase *wxToolBarBase::InsertControl(size_t pos, wxControl *control) +wxToolBarToolBase * +wxToolBarBase::InsertControl(size_t pos, + wxControl *control, + const wxString& label) { - wxCHECK_MSG( control, (wxToolBarToolBase *)NULL, - _T("toolbar: can't insert NULL control") ); - - wxCHECK_MSG( control->GetParent() == this, (wxToolBarToolBase *)NULL, - _T("control must have toolbar as parent") ); + wxCHECK_MSG( control, NULL, + wxT("toolbar: can't insert NULL control") ); - wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL, - _T("invalid position in wxToolBar::InsertControl()") ); + wxCHECK_MSG( control->GetParent() == this, NULL, + wxT("control must have toolbar as parent") ); - wxToolBarToolBase *tool = CreateTool(control); + return DoInsertNewTool(pos, CreateTool(control, label)); +} - if ( !tool || !DoInsertTool(pos, tool) ) +wxControl *wxToolBarBase::FindControl( int id ) +{ + for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst(); + node; + node = node->GetNext() ) { - delete tool; - - return NULL; + const wxToolBarToolBase * const tool = node->GetData(); + if ( tool->IsControl() ) + { + wxControl * const control = tool->GetControl(); + + if ( !control ) + { + wxFAIL_MSG( wxT("NULL control in toolbar?") ); + } + else if ( control->GetId() == id ) + { + // found + return control; + } + } } - m_tools.Insert(pos, tool); - - return tool; + return NULL; } wxToolBarToolBase *wxToolBarBase::AddSeparator() @@ -215,30 +259,35 @@ wxToolBarToolBase *wxToolBarBase::AddSeparator() wxToolBarToolBase *wxToolBarBase::InsertSeparator(size_t pos) { - wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL, - _T("invalid position in wxToolBar::InsertSeparator()") ); + return DoInsertNewTool(pos, CreateSeparator()); +} - wxToolBarToolBase *tool = CreateTool(wxID_SEPARATOR, - wxNullBitmap, wxNullBitmap, - FALSE, (wxObject *)NULL, - wxEmptyString, wxEmptyString); +wxToolBarToolBase *wxToolBarBase::AddStretchableSpace() +{ + return InsertStretchableSpace(GetToolsCount()); +} - if ( !tool || !DoInsertTool(pos, tool) ) +wxToolBarToolBase *wxToolBarBase::InsertStretchableSpace(size_t pos) +{ + wxToolBarToolBase * const tool = CreateSeparator(); + if ( tool ) { - delete tool; - - return NULL; + // this is a hack but we know that all the current implementations + // don't really use the tool when it's created, they will do it + // InsertTool() at earliest and maybe even in Realize() much later + // + // so we can create the tool as a plain separator and mark it as being + // a stretchable space later + tool->MakeStretchable(); } - m_tools.Insert(pos, tool); - - return tool; + return DoInsertNewTool(pos, tool); } wxToolBarToolBase *wxToolBarBase::RemoveTool(int id) { size_t pos = 0; - wxToolBarToolsList::Node *node; + wxToolBarToolsList::compatibility_iterator node; for ( node = m_tools.GetFirst(); node; node = node->GetNext() ) { if ( node->GetData()->GetId() == id ) @@ -251,44 +300,44 @@ wxToolBarToolBase *wxToolBarBase::RemoveTool(int id) { // don't give any error messages - sometimes we might call RemoveTool() // without knowing whether the tool is or not in the toolbar - return (wxToolBarToolBase *)NULL; + return NULL; } wxToolBarToolBase *tool = node->GetData(); + wxCHECK_MSG( tool, NULL, "NULL tool in the tools list?" ); + if ( !DoDeleteTool(pos, tool) ) - { - return (wxToolBarToolBase *)NULL; - } + return NULL; - // the node would delete the data, so set it to NULL to avoid this - node->SetData(NULL); + m_tools.Erase(node); - m_tools.DeleteNode(node); + tool->Detach(); return tool; } bool wxToolBarBase::DeleteToolByPos(size_t pos) { - wxCHECK_MSG( pos < GetToolsCount(), FALSE, - _T("invalid position in wxToolBar::DeleteToolByPos()") ); + wxCHECK_MSG( pos < GetToolsCount(), false, + wxT("invalid position in wxToolBar::DeleteToolByPos()") ); - wxToolBarToolsList::Node *node = m_tools.Item(pos); + wxToolBarToolsList::compatibility_iterator node = m_tools.Item(pos); if ( !DoDeleteTool(pos, node->GetData()) ) { - return FALSE; + return false; } - m_tools.DeleteNode(node); + delete node->GetData(); + m_tools.Erase(node); - return TRUE; + return true; } bool wxToolBarBase::DeleteTool(int id) { size_t pos = 0; - wxToolBarToolsList::Node *node; + wxToolBarToolsList::compatibility_iterator node; for ( node = m_tools.GetFirst(); node; node = node->GetNext() ) { if ( node->GetData()->GetId() == id ) @@ -299,19 +348,20 @@ bool wxToolBarBase::DeleteTool(int id) if ( !node || !DoDeleteTool(pos, node->GetData()) ) { - return FALSE; + return false; } - m_tools.DeleteNode(node); + delete node->GetData(); + m_tools.Erase(node); - return TRUE; + return true; } wxToolBarToolBase *wxToolBarBase::FindById(int id) const { - wxToolBarToolBase *tool = (wxToolBarToolBase *)NULL; + wxToolBarToolBase *tool = NULL; - for ( wxToolBarToolsList::Node *node = m_tools.GetFirst(); + for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst(); node; node = node->GetNext() ) { @@ -321,23 +371,106 @@ wxToolBarToolBase *wxToolBarBase::FindById(int id) const // found break; } + + tool = NULL; } return tool; } +void wxToolBarBase::UnToggleRadioGroup(wxToolBarToolBase *tool) +{ + wxCHECK_RET( tool, wxT("NULL tool in wxToolBarTool::UnToggleRadioGroup") ); + + if ( !tool->IsButton() || tool->GetKind() != wxITEM_RADIO ) + return; + + wxToolBarToolsList::compatibility_iterator node = m_tools.Find(tool); + wxCHECK_RET( node, wxT("invalid tool in wxToolBarTool::UnToggleRadioGroup") ); + + wxToolBarToolsList::compatibility_iterator nodeNext = node->GetNext(); + while ( nodeNext ) + { + wxToolBarToolBase *toolNext = nodeNext->GetData(); + + if ( !toolNext->IsButton() || toolNext->GetKind() != wxITEM_RADIO ) + break; + + if ( toolNext->Toggle(false) ) + { + DoToggleTool(toolNext, false); + } + + nodeNext = nodeNext->GetNext(); + } + + wxToolBarToolsList::compatibility_iterator nodePrev = node->GetPrevious(); + while ( nodePrev ) + { + wxToolBarToolBase *toolNext = nodePrev->GetData(); + + if ( !toolNext->IsButton() || toolNext->GetKind() != wxITEM_RADIO ) + break; + + if ( toolNext->Toggle(false) ) + { + DoToggleTool(toolNext, false); + } + + nodePrev = nodePrev->GetPrevious(); + } +} + void wxToolBarBase::ClearTools() { - m_tools.Clear(); + while ( GetToolsCount() ) + { + DeleteToolByPos(0); + } +} + +void wxToolBarBase::AdjustToolBitmapSize() +{ + const wxSize sizeOrig(m_defaultWidth, m_defaultHeight); + + wxSize sizeActual(sizeOrig); + + for ( wxToolBarToolsList::const_iterator i = m_tools.begin(); + i != m_tools.end(); + ++i ) + { + const wxBitmap& bmp = (*i)->GetNormalBitmap(); + if ( bmp.IsOk() ) + sizeActual.IncTo(bmp.GetSize()); + } + + if ( sizeActual != sizeOrig ) + SetToolBitmapSize(sizeActual); } bool wxToolBarBase::Realize() { - return TRUE; + // check if we have anything to do + if ( m_tools.empty() ) + return false; + + // make sure tool size is large enough for all bitmaps to fit in + AdjustToolBitmapSize(); + + return true; } wxToolBarBase::~wxToolBarBase() { + WX_CLEAR_LIST(wxToolBarToolsList, m_tools); + + // notify the frame that it doesn't have a tool bar any longer to avoid + // dangling pointers + wxFrame *frame = wxDynamicCast(GetParent(), wxFrame); + if ( frame && frame->GetToolBar() == this ) + { + frame->SetToolBar(NULL); + } } // ---------------------------------------------------------------------------- @@ -363,6 +496,7 @@ void wxToolBarBase::ToggleTool(int id, bool toggle) { if ( tool->Toggle(toggle) ) { + UnToggleRadioGroup(tool); DoToggleTool(tool, toggle); } } @@ -402,22 +536,38 @@ wxObject *wxToolBarBase::GetToolClientData(int id) const { wxToolBarToolBase *tool = FindById(id); - return tool ? tool->GetClientData() : (wxObject *)NULL; + return tool ? tool->GetClientData() : NULL; } void wxToolBarBase::SetToolClientData(int id, wxObject *clientData) { wxToolBarToolBase *tool = FindById(id); - wxCHECK_RET( tool, _T("no such tool in wxToolBar::SetToolClientData") ); + wxCHECK_RET( tool, wxT("no such tool in wxToolBar::SetToolClientData") ); tool->SetClientData(clientData); } +int wxToolBarBase::GetToolPos(int id) const +{ + size_t pos = 0; + wxToolBarToolsList::compatibility_iterator node; + + for ( node = m_tools.GetFirst(); node; node = node->GetNext() ) + { + if ( node->GetData()->GetId() == id ) + return pos; + + pos++; + } + + return wxNOT_FOUND; +} + bool wxToolBarBase::GetToolState(int id) const { wxToolBarToolBase *tool = FindById(id); - wxCHECK_MSG( tool, FALSE, _T("no such tool") ); + wxCHECK_MSG( tool, false, wxT("no such tool") ); return tool->IsToggled(); } @@ -425,7 +575,7 @@ bool wxToolBarBase::GetToolState(int id) const bool wxToolBarBase::GetToolEnabled(int id) const { wxToolBarToolBase *tool = FindById(id); - wxCHECK_MSG( tool, FALSE, _T("no such tool") ); + wxCHECK_MSG( tool, false, wxT("no such tool") ); return tool->IsEnabled(); } @@ -433,7 +583,7 @@ bool wxToolBarBase::GetToolEnabled(int id) const wxString wxToolBarBase::GetToolShortHelp(int id) const { wxToolBarToolBase *tool = FindById(id); - wxCHECK_MSG( tool, _T(""), _T("no such tool") ); + wxCHECK_MSG( tool, wxEmptyString, wxT("no such tool") ); return tool->GetShortHelp(); } @@ -441,7 +591,7 @@ wxString wxToolBarBase::GetToolShortHelp(int id) const wxString wxToolBarBase::GetToolLongHelp(int id) const { wxToolBarToolBase *tool = FindById(id); - wxCHECK_MSG( tool, _T(""), _T("no such tool") ); + wxCHECK_MSG( tool, wxEmptyString, wxT("no such tool") ); return tool->GetLongHelp(); } @@ -461,21 +611,32 @@ void wxToolBarBase::SetRows(int WXUNUSED(nRows)) // nothing } +bool wxToolBarBase::IsVertical() const +{ + return HasFlag(wxTB_LEFT | wxTB_RIGHT); +} + + // ---------------------------------------------------------------------------- // event processing // ---------------------------------------------------------------------------- -// Only allow toggle if returns TRUE +// Only allow toggle if returns true bool wxToolBarBase::OnLeftClick(int id, bool toggleDown) { wxCommandEvent event(wxEVT_COMMAND_TOOL_CLICKED, id); event.SetEventObject(this); - event.SetExtraLong((long) toggleDown); + + // we use SetInt() to make wxCommandEvent::IsChecked() return toggleDown + event.SetInt((int)toggleDown); + + // and SetExtraLong() for backwards compatibility + event.SetExtraLong((long)toggleDown); // Send events to this toolbar instead (and thence up the window hierarchy) - GetEventHandler()->ProcessEvent(event); + HandleWindowEvent(event); - return TRUE; + return true; } // Call when right button down. @@ -491,7 +652,7 @@ void wxToolBarBase::OnRightClick(int id, } // Called when the mouse cursor enters a tool bitmap (no button pressed). -// Argument is -1 if mouse is exiting the toolbar. +// Argument is wxID_ANY if mouse is exiting the toolbar. // Note that for this event, the id of the window is used, // and the integer parameter of wxCommandEvent is used to retrieve // the tool id. @@ -501,50 +662,55 @@ void wxToolBarBase::OnMouseEnter(int id) event.SetEventObject(this); event.SetInt(id); - (void)GetEventHandler()->ProcessEvent(event); - - wxToolBarToolBase *tool = FindById(id); - if ( !tool || !tool->GetLongHelp() ) - return; - wxFrame *frame = wxDynamicCast(GetParent(), wxFrame); - if ( !frame ) - return; + if ( frame ) + { + wxString help; + if ( id != wxID_ANY ) + { + const wxToolBarToolBase * const tool = FindById(id); + if ( tool ) + help = tool->GetLongHelp(); + } - frame->SetStatusText(tool->GetLongHelp()); + // call DoGiveHelp() even if help string is empty to avoid showing the + // help for the previously selected tool when another one is selected + frame->DoGiveHelp(help, id != wxID_ANY); + } + + (void)GetEventHandler()->ProcessEvent(event); } // ---------------------------------------------------------------------------- // UI updates // ---------------------------------------------------------------------------- -void wxToolBarBase::OnIdle(wxIdleEvent& event) -{ - DoToolbarUpdates(); - - event.Skip(); -} - // Do the toolbar button updates (check for EVT_UPDATE_UI handlers) -void wxToolBarBase::DoToolbarUpdates() +void wxToolBarBase::UpdateWindowUI(long flags) { - wxWindow* parent = this; - while (parent->GetParent()) - parent = parent->GetParent(); + wxWindowBase::UpdateWindowUI(flags); -#ifdef __WXMSW__ - wxWindow* focusWin = wxFindFocusDescendant(parent); -#else - wxWindow* focusWin = (wxWindow*) NULL; -#endif + // don't waste time updating state of tools in a hidden toolbar + if ( !IsShown() ) + return; - wxEvtHandler* evtHandler = focusWin ? focusWin->GetEventHandler() : GetEventHandler() ; + // There is no sense in updating the toolbar UI + // if the parent window is about to get destroyed + wxWindow *tlw = wxGetTopLevelParent( this ); + if (tlw && wxPendingDelete.Member( tlw )) + return; + + wxEvtHandler* evtHandler = GetEventHandler() ; - for ( wxToolBarToolsList::Node* node = m_tools.GetFirst(); + for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst(); node; node = node->GetNext() ) { - int id = node->GetData()->GetId(); + wxToolBarToolBase * const tool = node->GetData(); + if ( tool->IsSeparator() ) + continue; + + int id = tool->GetId(); wxUpdateUIEvent event(id); event.SetEventObject(this); @@ -563,4 +729,31 @@ void wxToolBarBase::DoToolbarUpdates() } } +bool wxToolBarBase::SetDropdownMenu(int toolid, wxMenu* menu) +{ + wxToolBarToolBase * const tool = FindById(toolid); + wxCHECK_MSG( tool, false, wxT("invalid tool id") ); + + wxCHECK_MSG( tool->GetKind() == wxITEM_DROPDOWN, false, + wxT("menu can be only associated with drop down tools") ); + + tool->SetDropdownMenu(menu); + + return true; +} + +#if WXWIN_COMPATIBILITY_2_8 + +bool wxCreateGreyedImage(const wxImage& in, wxImage& out) +{ +#if wxUSE_IMAGE + out = in.ConvertToGreyscale(); + if ( out.Ok() ) + return true; +#endif // wxUSE_IMAGE + return false; +} + +#endif // WXWIN_COMPATIBILITY_2_8 + #endif // wxUSE_TOOLBAR