X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e39af974ef7846e26686ae39d74e4696c1fef0c3..d08504dfa577c3510b150d19b9539fea3df24fce:/src/common/tbarbase.cpp diff --git a/src/common/tbarbase.cpp b/src/common/tbarbase.cpp index 9b03daccee..f6bc3617dc 100644 --- a/src/common/tbarbase.cpp +++ b/src/common/tbarbase.cpp @@ -1,8 +1,8 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "tbarbase.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -30,28 +26,28 @@ #if wxUSE_TOOLBAR +#include "wx/toolbar.h" + #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 -#include "wx/frame.h" -#include "wx/image.h" -#include "wx/settings.h" - -#include "wx/tbarbase.h" - // ---------------------------------------------------------------------------- -// wxWindows macros +// wxWidgets macros // ---------------------------------------------------------------------------- -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 @@ -61,63 +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( CanBeToggled(), _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) { wxItemKind kind = toggle ? wxITEM_CHECK : wxITEM_NORMAL; if ( m_kind == kind ) - return FALSE; + return false; 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 // ---------------------------------------------------------------------------- @@ -125,11 +135,20 @@ 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::DoAddTool(int id, @@ -143,6 +162,7 @@ wxToolBarToolBase *wxToolBarBase::DoAddTool(int id, wxCoord WXUNUSED(xPos), wxCoord WXUNUSED(yPos)) { + InvalidateBestSize(); return InsertTool(GetToolsCount(), id, label, bitmap, bmpDisabled, kind, shortHelp, longHelp, clientData); } @@ -157,20 +177,11 @@ wxToolBarToolBase *wxToolBarBase::InsertTool(size_t pos, 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, label, bitmap, bmpDisabled, kind, - clientData, shortHelp, longHelp); - - if ( !InsertTool(pos, tool) ) - { - delete tool; - - return NULL; - } - - return tool; + return DoInsertNewTool(pos, CreateTool(id, label, bitmap, bmpDisabled, kind, + clientData, shortHelp, longHelp)); } wxToolBarToolBase *wxToolBarBase::AddTool(wxToolBarToolBase *tool) @@ -181,8 +192,8 @@ wxToolBarToolBase *wxToolBarBase::AddTool(wxToolBarToolBase *tool) wxToolBarToolBase * wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool) { - wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL, - _T("invalid position in wxToolBar::InsertTool()") ); + wxCHECK_MSG( pos <= GetToolsCount(), NULL, + wxT("invalid position in wxToolBar::InsertTool()") ); if ( !tool || !DoInsertTool(pos, tool) ) { @@ -190,41 +201,34 @@ wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool) } 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, NULL, + wxT("toolbar: can't insert NULL control") ); - wxCHECK_MSG( control->GetParent() == this, (wxToolBarToolBase *)NULL, - _T("control must have toolbar as parent") ); + wxCHECK_MSG( control->GetParent() == this, NULL, + wxT("control must have toolbar as parent") ); - wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL, - _T("invalid position in wxToolBar::InsertControl()") ); - - wxToolBarToolBase *tool = CreateTool(control); - - if ( !InsertTool(pos, tool) ) - { - delete tool; - - return NULL; - } - - return tool; + return DoInsertNewTool(pos, CreateTool(control, label)); } wxControl *wxToolBarBase::FindControl( int id ) { - for ( wxToolBarToolsList::Node* node = m_tools.GetFirst(); + for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst(); node; node = node->GetNext() ) { @@ -235,7 +239,7 @@ wxControl *wxToolBarBase::FindControl( int id ) if ( !control ) { - wxFAIL_MSG( _T("NULL control in toolbar?") ); + wxFAIL_MSG( wxT("NULL control in toolbar?") ); } else if ( control->GetId() == id ) { @@ -255,31 +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, - wxEmptyString, - wxNullBitmap, wxNullBitmap, - wxITEM_SEPARATOR, (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 ) @@ -292,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 ) @@ -340,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() ) { @@ -369,18 +378,99 @@ wxToolBarToolBase *wxToolBarBase::FindById(int id) const 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); + } } // ---------------------------------------------------------------------------- @@ -406,6 +496,7 @@ void wxToolBarBase::ToggleTool(int id, bool toggle) { if ( tool->Toggle(toggle) ) { + UnToggleRadioGroup(tool); DoToggleTool(tool, toggle); } } @@ -445,14 +536,14 @@ 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); } @@ -460,7 +551,7 @@ void wxToolBarBase::SetToolClientData(int id, wxObject *clientData) int wxToolBarBase::GetToolPos(int id) const { size_t pos = 0; - wxToolBarToolsList::Node *node; + wxToolBarToolsList::compatibility_iterator node; for ( node = m_tools.GetFirst(); node; node = node->GetNext() ) { @@ -476,7 +567,7 @@ int wxToolBarBase::GetToolPos(int id) const 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(); } @@ -484,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(); } @@ -492,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(); } @@ -500,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(); } @@ -520,11 +611,17 @@ 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); @@ -537,9 +634,9 @@ bool wxToolBarBase::OnLeftClick(int id, bool toggleDown) 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. @@ -555,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. @@ -566,11 +663,19 @@ void wxToolBarBase::OnMouseEnter(int id) event.SetInt(id); wxFrame *frame = wxDynamicCast(GetParent(), wxFrame); - if( frame ) + if ( frame ) { - wxToolBarToolBase* tool = id == -1 ? (wxToolBarToolBase*)0 : FindById(id); - wxString help = tool ? tool->GetLongHelp() : wxString(); - frame->DoGiveHelp( help, id != -1 ); + wxString help; + if ( id != wxID_ANY ) + { + const wxToolBarToolBase * const tool = FindById(id); + if ( tool ) + help = 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); @@ -585,13 +690,27 @@ void wxToolBarBase::UpdateWindowUI(long flags) { wxWindowBase::UpdateWindowUI(flags); + // don't waste time updating state of tools in a hidden toolbar + if ( !IsShown() ) + return; + + // 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); @@ -610,64 +729,31 @@ void wxToolBarBase::UpdateWindowUI(long flags) } } -// Helper function, used by wxCreateGreyedImage - -static void wxGreyOutImage( const wxImage& src, - wxImage& dest, - const wxColour& darkCol, - const wxColour& lightCol, - const wxColour& bgCol ) +bool wxToolBarBase::SetDropdownMenu(int toolid, wxMenu* menu) { - // Second attempt, just making things monochrome - int width = src.GetWidth(); - int height = src.GetHeight(); + wxToolBarToolBase * const tool = FindById(toolid); + wxCHECK_MSG( tool, false, wxT("invalid tool id") ); - int redCur, greenCur, blueCur; - for ( int x = 0; x < width; x++ ) - { - for ( int y = 1; y < height; y++ ) - { - redCur = src.GetRed(x, y); - greenCur = src.GetGreen(x, y); - blueCur = src.GetBlue(x, y); + wxCHECK_MSG( tool->GetKind() == wxITEM_DROPDOWN, false, + wxT("menu can be only associated with drop down tools") ); - // Change light things to the background colour - if ( redCur >= (lightCol.Red() - 50) && greenCur >= (lightCol.Green() - 50) && blueCur >= (lightCol.Blue() - 50) ) - { - dest.SetRGB(x,y, bgCol.Red(), bgCol.Green(), bgCol.Blue()); - } - else if ( redCur == bgCol.Red() && greenCur == bgCol.Green() && blueCur == bgCol.Blue() ) - { - // Leave the background colour as-is - // dest.SetRGB(x,y, bgCol.Red(), bgCol.Green(), bgCol.Blue()); - } - else // if ( redCur <= darkCol.Red() && greenCur <= darkCol.Green() && blueCur <= darkCol.Blue() ) - { - // Change dark things to really dark - dest.SetRGB(x,y, darkCol.Red(), darkCol.Green(), darkCol.Blue()); - } - } - } + tool->SetDropdownMenu(menu); + + return true; } -/* - * Make a greyed-out image suitable for disabled buttons. - * This code is adapted from wxNewBitmapButton in FL. - */ +#if WXWIN_COMPATIBILITY_2_8 bool wxCreateGreyedImage(const wxImage& in, wxImage& out) { - out = in.Copy(); - - // assuming the pixels along the edges are of the background color - wxColour bgCol(in.GetRed(0, 0), in.GetGreen(0, 0), in.GetBlue(0, 0)); - - wxColour darkCol = wxSystemSettings::GetColour(wxSYS_COLOUR_3DSHADOW) ; - wxColour lightCol = wxSystemSettings::GetColour(wxSYS_COLOUR_3DHIGHLIGHT) ; - - wxGreyOutImage(in, out, darkCol, lightCol, bgCol); - - return TRUE; +#if wxUSE_IMAGE + out = in.ConvertToGreyscale(); + if ( out.Ok() ) + return true; +#endif // wxUSE_IMAGE + return false; } +#endif // WXWIN_COMPATIBILITY_2_8 + #endif // wxUSE_TOOLBAR