]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/tbarbase.cpp
fix memory leak in wxScreenDC, fixes #13249
[wxWidgets.git] / src / common / tbarbase.cpp
index a8ada3fa9bc144ddf2150fcb57102e6934c69345..ced3746df2c433c407c95437c24a7ded2bac50f3 100644 (file)
     #if WXWIN_COMPATIBILITY_2_8
         #include "wx/image.h"
     #endif // WXWIN_COMPATIBILITY_2_8
+    #include "wx/menu.h"
 #endif
 
+extern WXDLLEXPORT_DATA(const char) wxToolBarNameStr[] = "toolbar";
+
 // ----------------------------------------------------------------------------
 // wxWidgets macros
 // ----------------------------------------------------------------------------
@@ -58,6 +61,17 @@ WX_DEFINE_LIST(wxToolBarToolsList)
 
 IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject)
 
+wxToolBarToolBase::~wxToolBarToolBase()
+{
+#if wxUSE_MENUS
+    delete m_dropdownMenu;
+#endif
+
+    if ( IsControl() )
+        GetControl()->Destroy();
+}
+
+
 bool wxToolBarToolBase::Enable(bool enable)
 {
     if ( m_enabled == enable )
@@ -70,7 +84,7 @@ bool wxToolBarToolBase::Enable(bool enable)
 
 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;
@@ -111,6 +125,16 @@ bool wxToolBarToolBase::SetLongHelp(const wxString& help)
     return true;
 }
 
+
+#if wxUSE_MENUS
+void wxToolBarToolBase::SetDropdownMenu(wxMenu* menu)
+{
+    delete m_dropdownMenu;
+    m_dropdownMenu = menu;
+}
+#endif
+
+
 // ----------------------------------------------------------------------------
 // wxToolBarBase adding/deleting items
 // ----------------------------------------------------------------------------
@@ -134,7 +158,7 @@ void wxToolBarBase::FixupStyle()
     }
 }
 
-wxToolBarToolBase *wxToolBarBase::DoAddTool(int id,
+wxToolBarToolBase *wxToolBarBase::DoAddTool(int toolid,
                                             const wxString& label,
                                             const wxBitmap& bitmap,
                                             const wxBitmap& bmpDisabled,
@@ -146,12 +170,12 @@ wxToolBarToolBase *wxToolBarBase::DoAddTool(int id,
                                             wxCoord WXUNUSED(yPos))
 {
     InvalidateBestSize();
-    return InsertTool(GetToolsCount(), id, label, bitmap, bmpDisabled,
+    return InsertTool(GetToolsCount(), toolid, label, bitmap, bmpDisabled,
                       kind, shortHelp, longHelp, clientData);
 }
 
 wxToolBarToolBase *wxToolBarBase::InsertTool(size_t pos,
-                                             int id,
+                                             int toolid,
                                              const wxString& label,
                                              const wxBitmap& bitmap,
                                              const wxBitmap& bmpDisabled,
@@ -160,20 +184,11 @@ wxToolBarToolBase *wxToolBarBase::InsertTool(size_t pos,
                                              const wxString& longHelp,
                                              wxObject *clientData)
 {
-    wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
-                 _T("invalid position in wxToolBar::InsertTool()") );
-
-    wxToolBarToolBase *tool = CreateTool(id, label, bitmap, bmpDisabled, kind,
-                                         clientData, shortHelp, longHelp);
-
-    if ( !InsertTool(pos, tool) )
-    {
-        delete tool;
-
-        return NULL;
-    }
+    wxCHECK_MSG( pos <= GetToolsCount(), NULL,
+                 wxT("invalid position in wxToolBar::InsertTool()") );
 
-    return tool;
+    return DoInsertNewTool(pos, CreateTool(toolid, label, bitmap, bmpDisabled, kind,
+                                           clientData, shortHelp, longHelp));
 }
 
 wxToolBarToolBase *wxToolBarBase::AddTool(wxToolBarToolBase *tool)
@@ -184,8 +199,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) )
     {
@@ -193,6 +208,7 @@ wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool)
     }
 
     m_tools.Insert(pos, tool);
+    tool->Attach(this);
 
     return tool;
 }
@@ -208,28 +224,16 @@ 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( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
-                 _T("invalid position in wxToolBar::InsertControl()") );
+    wxCHECK_MSG( control, NULL,
+                 wxT("toolbar: can't insert NULL control") );
 
-    wxToolBarToolBase *tool = CreateTool(control, label);
-
-    if ( !InsertTool(pos, tool) )
-    {
-        delete tool;
+    wxCHECK_MSG( control->GetParent() == this, NULL,
+                 wxT("control must have toolbar as parent") );
 
-        return NULL;
-    }
-
-    return tool;
+    return DoInsertNewTool(pos, CreateTool(control, label));
 }
 
-wxControl *wxToolBarBase::FindControl( int id )
+wxControl *wxToolBarBase::FindControl( int toolid )
 {
     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
           node;
@@ -242,9 +246,9 @@ 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 )
+            else if ( control->GetId() == toolid )
             {
                 // found
                 return control;
@@ -262,34 +266,38 @@ 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)
+wxToolBarToolBase *wxToolBarBase::RemoveTool(int toolid)
 {
     size_t pos = 0;
     wxToolBarToolsList::compatibility_iterator node;
     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
     {
-        if ( node->GetData()->GetId() == id )
+        if ( node->GetData()->GetId() == toolid )
             break;
 
         pos++;
@@ -299,24 +307,26 @@ 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;
 
     m_tools.Erase(node);
 
+    tool->Detach();
+
     return tool;
 }
 
 bool wxToolBarBase::DeleteToolByPos(size_t pos)
 {
     wxCHECK_MSG( pos < GetToolsCount(), false,
-                 _T("invalid position in wxToolBar::DeleteToolByPos()") );
+                 wxT("invalid position in wxToolBar::DeleteToolByPos()") );
 
     wxToolBarToolsList::compatibility_iterator node = m_tools.Item(pos);
 
@@ -331,13 +341,13 @@ bool wxToolBarBase::DeleteToolByPos(size_t pos)
     return true;
 }
 
-bool wxToolBarBase::DeleteTool(int id)
+bool wxToolBarBase::DeleteTool(int toolid)
 {
     size_t pos = 0;
     wxToolBarToolsList::compatibility_iterator node;
     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
     {
-        if ( node->GetData()->GetId() == id )
+        if ( node->GetData()->GetId() == toolid )
             break;
 
         pos++;
@@ -354,16 +364,16 @@ bool wxToolBarBase::DeleteTool(int id)
     return true;
 }
 
-wxToolBarToolBase *wxToolBarBase::FindById(int id) const
+wxToolBarToolBase *wxToolBarBase::FindById(int toolid) const
 {
-    wxToolBarToolBase *tool = (wxToolBarToolBase *)NULL;
+    wxToolBarToolBase *tool = NULL;
 
     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
           node;
           node = node->GetNext() )
     {
         tool = node->GetData();
-        if ( tool->GetId() == id )
+        if ( tool->GetId() == toolid )
         {
             // found
             break;
@@ -377,13 +387,13 @@ wxToolBarToolBase *wxToolBarBase::FindById(int id) const
 
 void wxToolBarBase::UnToggleRadioGroup(wxToolBarToolBase *tool)
 {
-    wxCHECK_RET( tool, _T("NULL tool in wxToolBarTool::UnToggleRadioGroup") );
+    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, _T("invalid tool in wxToolBarTool::UnToggleRadioGroup") );
+    wxCHECK_RET( node, wxT("invalid tool in wxToolBarTool::UnToggleRadioGroup") );
 
     wxToolBarToolsList::compatibility_iterator nodeNext = node->GetNext();
     while ( nodeNext )
@@ -426,8 +436,34 @@ void wxToolBarBase::ClearTools()
     }
 }
 
+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()
 {
+    // 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;
 }
 
@@ -448,9 +484,9 @@ wxToolBarBase::~wxToolBarBase()
 // wxToolBarBase tools state
 // ----------------------------------------------------------------------------
 
-void wxToolBarBase::EnableTool(int id, bool enable)
+void wxToolBarBase::EnableTool(int toolid, bool enable)
 {
-    wxToolBarToolBase *tool = FindById(id);
+    wxToolBarToolBase *tool = FindById(toolid);
     if ( tool )
     {
         if ( tool->Enable(enable) )
@@ -460,9 +496,9 @@ void wxToolBarBase::EnableTool(int id, bool enable)
     }
 }
 
-void wxToolBarBase::ToggleTool(int id, bool toggle)
+void wxToolBarBase::ToggleTool(int toolid, bool toggle)
 {
-    wxToolBarToolBase *tool = FindById(id);
+    wxToolBarToolBase *tool = FindById(toolid);
     if ( tool && tool->CanBeToggled() )
     {
         if ( tool->Toggle(toggle) )
@@ -473,9 +509,9 @@ void wxToolBarBase::ToggleTool(int id, bool toggle)
     }
 }
 
-void wxToolBarBase::SetToggle(int id, bool toggle)
+void wxToolBarBase::SetToggle(int toolid, bool toggle)
 {
-    wxToolBarToolBase *tool = FindById(id);
+    wxToolBarToolBase *tool = FindById(toolid);
     if ( tool )
     {
         if ( tool->SetToggle(toggle) )
@@ -485,48 +521,48 @@ void wxToolBarBase::SetToggle(int id, bool toggle)
     }
 }
 
-void wxToolBarBase::SetToolShortHelp(int id, const wxString& help)
+void wxToolBarBase::SetToolShortHelp(int toolid, const wxString& help)
 {
-    wxToolBarToolBase *tool = FindById(id);
+    wxToolBarToolBase *tool = FindById(toolid);
     if ( tool )
     {
         (void)tool->SetShortHelp(help);
     }
 }
 
-void wxToolBarBase::SetToolLongHelp(int id, const wxString& help)
+void wxToolBarBase::SetToolLongHelp(int toolid, const wxString& help)
 {
-    wxToolBarToolBase *tool = FindById(id);
+    wxToolBarToolBase *tool = FindById(toolid);
     if ( tool )
     {
         (void)tool->SetLongHelp(help);
     }
 }
 
-wxObject *wxToolBarBase::GetToolClientData(int id) const
+wxObject *wxToolBarBase::GetToolClientData(int toolid) const
 {
-    wxToolBarToolBase *tool = FindById(id);
+    wxToolBarToolBase *tool = FindById(toolid);
 
-    return tool ? tool->GetClientData() : (wxObject *)NULL;
+    return tool ? tool->GetClientData() : NULL;
 }
 
-void wxToolBarBase::SetToolClientData(int id, wxObject *clientData)
+void wxToolBarBase::SetToolClientData(int toolid, wxObject *clientData)
 {
-    wxToolBarToolBase *tool = FindById(id);
+    wxToolBarToolBase *tool = FindById(toolid);
 
-    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
+int wxToolBarBase::GetToolPos(int toolid) const
 {
     size_t pos = 0;
     wxToolBarToolsList::compatibility_iterator node;
 
     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
     {
-        if ( node->GetData()->GetId() == id )
+        if ( node->GetData()->GetId() == toolid )
             return pos;
 
         pos++;
@@ -535,34 +571,34 @@ int wxToolBarBase::GetToolPos(int id) const
     return wxNOT_FOUND;
 }
 
-bool wxToolBarBase::GetToolState(int id) const
+bool wxToolBarBase::GetToolState(int toolid) const
 {
-    wxToolBarToolBase *tool = FindById(id);
-    wxCHECK_MSG( tool, false, _T("no such tool") );
+    wxToolBarToolBase *tool = FindById(toolid);
+    wxCHECK_MSG( tool, false, wxT("no such tool") );
 
     return tool->IsToggled();
 }
 
-bool wxToolBarBase::GetToolEnabled(int id) const
+bool wxToolBarBase::GetToolEnabled(int toolid) const
 {
-    wxToolBarToolBase *tool = FindById(id);
-    wxCHECK_MSG( tool, false, _T("no such tool") );
+    wxToolBarToolBase *tool = FindById(toolid);
+    wxCHECK_MSG( tool, false, wxT("no such tool") );
 
     return tool->IsEnabled();
 }
 
-wxString wxToolBarBase::GetToolShortHelp(int id) const
+wxString wxToolBarBase::GetToolShortHelp(int toolid) const
 {
-    wxToolBarToolBase *tool = FindById(id);
-    wxCHECK_MSG( tool, wxEmptyString, _T("no such tool") );
+    wxToolBarToolBase *tool = FindById(toolid);
+    wxCHECK_MSG( tool, wxEmptyString, wxT("no such tool") );
 
     return tool->GetShortHelp();
 }
 
-wxString wxToolBarBase::GetToolLongHelp(int id) const
+wxString wxToolBarBase::GetToolLongHelp(int toolid) const
 {
-    wxToolBarToolBase *tool = FindById(id);
-    wxCHECK_MSG( tool, wxEmptyString, _T("no such tool") );
+    wxToolBarToolBase *tool = FindById(toolid);
+    wxCHECK_MSG( tool, wxEmptyString, wxT("no such tool") );
 
     return tool->GetLongHelp();
 }
@@ -582,14 +618,20 @@ 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
-bool wxToolBarBase::OnLeftClick(int id, bool toggleDown)
+bool wxToolBarBase::OnLeftClick(int toolid, bool toggleDown)
 {
-    wxCommandEvent event(wxEVT_COMMAND_TOOL_CLICKED, id);
+    wxCommandEvent event(wxEVT_COMMAND_TOOL_CLICKED, toolid);
     event.SetEventObject(this);
 
     // we use SetInt() to make wxCommandEvent::IsChecked() return toggleDown
@@ -599,42 +641,48 @@ 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;
 }
 
 // Call when right button down.
-void wxToolBarBase::OnRightClick(int id,
+void wxToolBarBase::OnRightClick(int toolid,
                                  long WXUNUSED(x),
                                  long WXUNUSED(y))
 {
-    wxCommandEvent event(wxEVT_COMMAND_TOOL_RCLICKED, id);
+    wxCommandEvent event(wxEVT_COMMAND_TOOL_RCLICKED, toolid);
     event.SetEventObject(this);
-    event.SetInt(id);
+    event.SetInt(toolid);
 
     GetEventHandler()->ProcessEvent(event);
 }
 
 // Called when the mouse cursor enters a tool bitmap (no button pressed).
 // Argument is wxID_ANY if mouse is exiting the toolbar.
-// Note that for this event, the id of the window is used,
+// Note that for this event, the toolid of the window is used,
 // and the integer parameter of wxCommandEvent is used to retrieve
-// the tool id.
-void wxToolBarBase::OnMouseEnter(int id)
+// the tool toolid.
+void wxToolBarBase::OnMouseEnter(int toolid)
 {
     wxCommandEvent event(wxEVT_COMMAND_TOOL_ENTER, GetId());
     event.SetEventObject(this);
-    event.SetInt(id);
+    event.SetInt(toolid);
 
     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
-    if( frame )
+    if ( frame )
     {
         wxString help;
-        wxToolBarToolBase* tool = id == wxID_ANY ? (wxToolBarToolBase*)NULL : FindById(id);
-        if(tool)
-            help = tool->GetLongHelp();
-        frame->DoGiveHelp( help, id != wxID_ANY );
+        if ( toolid != wxID_ANY )
+        {
+           const wxToolBarToolBase * const tool = FindById(toolid);
+           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, toolid != wxID_ANY);
     }
 
     (void)GetEventHandler()->ProcessEvent(event);
@@ -665,17 +713,21 @@ void wxToolBarBase::UpdateWindowUI(long flags)
           node;
           node = node->GetNext() )
     {
-        int id = node->GetData()->GetId();
+        wxToolBarToolBase * const tool = node->GetData();
+        if ( tool->IsSeparator() )
+            continue;
+
+        int toolid = tool->GetId();
 
-        wxUpdateUIEvent event(id);
+        wxUpdateUIEvent event(toolid);
         event.SetEventObject(this);
 
         if ( evtHandler->ProcessEvent(event) )
         {
             if ( event.GetSetEnabled() )
-                EnableTool(id, event.GetEnabled());
+                EnableTool(toolid, event.GetEnabled());
             if ( event.GetSetChecked() )
-                ToggleTool(id, event.GetChecked());
+                ToggleTool(toolid, event.GetChecked());
 #if 0
             if ( event.GetSetText() )
                 // Set tooltip?
@@ -684,16 +736,30 @@ void wxToolBarBase::UpdateWindowUI(long flags)
     }
 }
 
+#if wxUSE_MENUS
+bool wxToolBarBase::SetDropdownMenu(int toolid, wxMenu* menu)
+{
+    wxToolBarToolBase * const tool = FindById(toolid);
+    wxCHECK_MSG( tool, false, wxT("invalid tool toolid") );
+
+    wxCHECK_MSG( tool->GetKind() == wxITEM_DROPDOWN, false,
+                    wxT("menu can be only associated with drop down tools") );
+
+    tool->SetDropdownMenu(menu);
+
+    return true;
+}
+#endif
+
 #if WXWIN_COMPATIBILITY_2_8
 
 bool wxCreateGreyedImage(const wxImage& in, wxImage& out)
 {
 #if wxUSE_IMAGE
     out = in.ConvertToGreyscale();
-    if ( out.Ok() )
+    if ( out.IsOk() )
         return true;
 #endif // wxUSE_IMAGE
-
     return false;
 }