]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/tbarbase.cpp
fix dereferencing end() iterator in ParseFormat() and constructing out of bound itera...
[wxWidgets.git] / src / common / tbarbase.cpp
index fd1e4d2bdd4dfd9fe532ff7a7fc17622fd2c0d24..97fe65f63142988dcc7a132be923b9948e0f51d8 100644 (file)
@@ -1,8 +1,8 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////
-// Name:        common/tbarbase.cpp
+// Name:        src/common/tbarbase.cpp
 // Purpose:     wxToolBarBase implementation
 // Author:      Julian Smart
 // 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
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "tbarbase.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 
 #if wxUSE_TOOLBAR
 
 
 #if wxUSE_TOOLBAR
 
+#include "wx/toolbar.h"
+
 #ifndef WX_PRECOMP
     #include "wx/control.h"
 #ifndef WX_PRECOMP
     #include "wx/control.h"
-#endif
-
-#include "wx/frame.h"
-
-#if wxUSE_IMAGE
-    #include "wx/image.h"
+    #include "wx/frame.h"
     #include "wx/settings.h"
     #include "wx/settings.h"
-#endif // wxUSE_IMAGE
-
-#include "wx/toolbar.h"
+    #if WXWIN_COMPATIBILITY_2_8
+        #include "wx/image.h"
+    #endif // WXWIN_COMPATIBILITY_2_8
+    #include "wx/menu.h"
+#endif
 
 // ----------------------------------------------------------------------------
 // wxWidgets macros
 
 // ----------------------------------------------------------------------------
 // wxWidgets macros
@@ -52,7 +47,7 @@ END_EVENT_TABLE()
 
 #include "wx/listimpl.cpp"
 
 
 #include "wx/listimpl.cpp"
 
-WX_DEFINE_LIST(wxToolBarToolsList);
+WX_DEFINE_LIST(wxToolBarToolsList)
 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation
@@ -64,6 +59,14 @@ WX_DEFINE_LIST(wxToolBarToolsList);
 
 IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject)
 
+wxToolBarToolBase::~wxToolBarToolBase()
+{
+    delete m_dropdownMenu;
+    if ( IsControl() )
+        GetControl()->Destroy();
+}
+
+
 bool wxToolBarToolBase::Enable(bool enable)
 {
     if ( m_enabled == enable )
 bool wxToolBarToolBase::Enable(bool enable)
 {
     if ( m_enabled == enable )
@@ -117,29 +120,13 @@ bool wxToolBarToolBase::SetLongHelp(const wxString& help)
     return true;
 }
 
     return true;
 }
 
-#if WXWIN_COMPATIBILITY_2_2
-
-const wxBitmap& wxToolBarToolBase::GetBitmap1() const
-{
-    return GetNormalBitmap();
-}
-
-const wxBitmap& wxToolBarToolBase::GetBitmap2() const
-{
-    return GetDisabledBitmap();
-}
-
-void wxToolBarToolBase::SetBitmap1(const wxBitmap& bmp)
-{
-    SetNormalBitmap(bmp);
-}
 
 
-void wxToolBarToolBase::SetBitmap2(const wxBitmap& bmp)
+void wxToolBarToolBase::SetDropdownMenu(wxMenu* menu)
 {
 {
-    SetDisabledBitmap(bmp);
+    delete m_dropdownMenu;
+    m_dropdownMenu = menu;
 }
 
 }
 
-#endif // WXWIN_COMPATIBILITY_2_2
 
 // ----------------------------------------------------------------------------
 // wxToolBarBase adding/deleting items
 
 // ----------------------------------------------------------------------------
 // wxToolBarBase adding/deleting items
@@ -155,6 +142,15 @@ wxToolBarBase::wxToolBarBase()
     m_defaultHeight = 15;
 }
 
     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,
                                             const wxString& label,
                                             const wxBitmap& bitmap,
 wxToolBarToolBase *wxToolBarBase::DoAddTool(int id,
                                             const wxString& label,
                                             const wxBitmap& bitmap,
@@ -181,7 +177,7 @@ wxToolBarToolBase *wxToolBarBase::InsertTool(size_t pos,
                                              const wxString& longHelp,
                                              wxObject *clientData)
 {
                                              const wxString& longHelp,
                                              wxObject *clientData)
 {
-    wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
+    wxCHECK_MSG( pos <= GetToolsCount(), NULL,
                  _T("invalid position in wxToolBar::InsertTool()") );
 
     wxToolBarToolBase *tool = CreateTool(id, label, bitmap, bmpDisabled, kind,
                  _T("invalid position in wxToolBar::InsertTool()") );
 
     wxToolBarToolBase *tool = CreateTool(id, label, bitmap, bmpDisabled, kind,
@@ -205,7 +201,7 @@ wxToolBarToolBase *wxToolBarBase::AddTool(wxToolBarToolBase *tool)
 wxToolBarToolBase *
 wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool)
 {
 wxToolBarToolBase *
 wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool)
 {
-    wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
+    wxCHECK_MSG( pos <= GetToolsCount(), NULL,
                  _T("invalid position in wxToolBar::InsertTool()") );
 
     if ( !tool || !DoInsertTool(pos, tool) )
                  _T("invalid position in wxToolBar::InsertTool()") );
 
     if ( !tool || !DoInsertTool(pos, tool) )
@@ -214,27 +210,32 @@ wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool)
     }
 
     m_tools.Insert(pos, tool);
     }
 
     m_tools.Insert(pos, tool);
+    tool->Attach(this);
 
     return tool;
 }
 
 
     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,
+    wxCHECK_MSG( control, NULL,
                  _T("toolbar: can't insert NULL control") );
 
                  _T("toolbar: can't insert NULL control") );
 
-    wxCHECK_MSG( control->GetParent() == this, (wxToolBarToolBase *)NULL,
+    wxCHECK_MSG( control->GetParent() == this, NULL,
                  _T("control must have toolbar as parent") );
 
                  _T("control must have toolbar as parent") );
 
-    wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
+    wxCHECK_MSG( pos <= GetToolsCount(), NULL,
                  _T("invalid position in wxToolBar::InsertControl()") );
 
                  _T("invalid position in wxToolBar::InsertControl()") );
 
-    wxToolBarToolBase *tool = CreateTool(control);
+    wxToolBarToolBase *tool = CreateTool(control, label);
 
     if ( !InsertTool(pos, tool) )
     {
 
     if ( !InsertTool(pos, tool) )
     {
@@ -279,13 +280,13 @@ wxToolBarToolBase *wxToolBarBase::AddSeparator()
 
 wxToolBarToolBase *wxToolBarBase::InsertSeparator(size_t pos)
 {
 
 wxToolBarToolBase *wxToolBarBase::InsertSeparator(size_t pos)
 {
-    wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
+    wxCHECK_MSG( pos <= GetToolsCount(), NULL,
                  _T("invalid position in wxToolBar::InsertSeparator()") );
 
     wxToolBarToolBase *tool = CreateTool(wxID_SEPARATOR,
                                          wxEmptyString,
                                          wxNullBitmap, wxNullBitmap,
                  _T("invalid position in wxToolBar::InsertSeparator()") );
 
     wxToolBarToolBase *tool = CreateTool(wxID_SEPARATOR,
                                          wxEmptyString,
                                          wxNullBitmap, wxNullBitmap,
-                                         wxITEM_SEPARATOR, (wxObject *)NULL,
+                                         wxITEM_SEPARATOR, NULL,
                                          wxEmptyString, wxEmptyString);
 
     if ( !tool || !DoInsertTool(pos, tool) )
                                          wxEmptyString, wxEmptyString);
 
     if ( !tool || !DoInsertTool(pos, tool) )
@@ -316,17 +317,19 @@ 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
     {
         // 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();
     }
 
     wxToolBarToolBase *tool = node->GetData();
+    wxCHECK_MSG( tool, NULL, "NULL tool in the tools list?" );
+
     if ( !DoDeleteTool(pos, tool) )
     if ( !DoDeleteTool(pos, tool) )
-    {
-        return (wxToolBarToolBase *)NULL;
-    }
+        return NULL;
 
     m_tools.Erase(node);
 
 
     m_tools.Erase(node);
 
+    tool->Detach();
+
     return tool;
 }
 
     return tool;
 }
 
@@ -373,7 +376,7 @@ bool wxToolBarBase::DeleteTool(int id)
 
 wxToolBarToolBase *wxToolBarBase::FindById(int id) const
 {
 
 wxToolBarToolBase *wxToolBarBase::FindById(int id) const
 {
-    wxToolBarToolBase *tool = (wxToolBarToolBase *)NULL;
+    wxToolBarToolBase *tool = NULL;
 
     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
           node;
 
     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
           node;
@@ -405,14 +408,14 @@ void wxToolBarBase::UnToggleRadioGroup(wxToolBarToolBase *tool)
     wxToolBarToolsList::compatibility_iterator nodeNext = node->GetNext();
     while ( nodeNext )
     {
     wxToolBarToolsList::compatibility_iterator nodeNext = node->GetNext();
     while ( nodeNext )
     {
-        wxToolBarToolBase *tool = nodeNext->GetData();
+        wxToolBarToolBase *toolNext = nodeNext->GetData();
 
 
-        if ( !tool->IsButton() || tool->GetKind() != wxITEM_RADIO )
+        if ( !toolNext->IsButton() || toolNext->GetKind() != wxITEM_RADIO )
             break;
 
             break;
 
-        if ( tool->Toggle(false) )
+        if ( toolNext->Toggle(false) )
         {
         {
-            DoToggleTool(tool, false);
+            DoToggleTool(toolNext, false);
         }
 
         nodeNext = nodeNext->GetNext();
         }
 
         nodeNext = nodeNext->GetNext();
@@ -421,14 +424,14 @@ void wxToolBarBase::UnToggleRadioGroup(wxToolBarToolBase *tool)
     wxToolBarToolsList::compatibility_iterator nodePrev = node->GetPrevious();
     while ( nodePrev )
     {
     wxToolBarToolsList::compatibility_iterator nodePrev = node->GetPrevious();
     while ( nodePrev )
     {
-        wxToolBarToolBase *tool = nodePrev->GetData();
+        wxToolBarToolBase *toolNext = nodePrev->GetData();
 
 
-        if ( !tool->IsButton() || tool->GetKind() != wxITEM_RADIO )
+        if ( !toolNext->IsButton() || toolNext->GetKind() != wxITEM_RADIO )
             break;
 
             break;
 
-        if ( tool->Toggle(false) )
+        if ( toolNext->Toggle(false) )
         {
         {
-            DoToggleTool(tool, false);
+            DoToggleTool(toolNext, false);
         }
 
         nodePrev = nodePrev->GetPrevious();
         }
 
         nodePrev = nodePrev->GetPrevious();
@@ -437,7 +440,10 @@ void wxToolBarBase::UnToggleRadioGroup(wxToolBarToolBase *tool)
 
 void wxToolBarBase::ClearTools()
 {
 
 void wxToolBarBase::ClearTools()
 {
-    WX_CLEAR_LIST(wxToolBarToolsList, m_tools);
+    while ( GetToolsCount() )
+    {
+        DeleteToolByPos(0);
+    }
 }
 
 bool wxToolBarBase::Realize()
 }
 
 bool wxToolBarBase::Realize()
@@ -521,7 +527,7 @@ wxObject *wxToolBarBase::GetToolClientData(int id) const
 {
     wxToolBarToolBase *tool = FindById(id);
 
 {
     wxToolBarToolBase *tool = FindById(id);
 
-    return tool ? tool->GetClientData() : (wxObject *)NULL;
+    return tool ? tool->GetClientData() : NULL;
 }
 
 void wxToolBarBase::SetToolClientData(int id, wxObject *clientData)
 }
 
 void wxToolBarBase::SetToolClientData(int id, wxObject *clientData)
@@ -596,6 +602,12 @@ void wxToolBarBase::SetRows(int WXUNUSED(nRows))
     // nothing
 }
 
     // nothing
 }
 
+bool wxToolBarBase::IsVertical() const
+{
+    return HasFlag(wxTB_LEFT | wxTB_RIGHT);
+}
+
+
 // ----------------------------------------------------------------------------
 // event processing
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // event processing
 // ----------------------------------------------------------------------------
@@ -613,7 +625,7 @@ bool wxToolBarBase::OnLeftClick(int id, bool toggleDown)
     event.SetExtraLong((long)toggleDown);
 
     // Send events to this toolbar instead (and thence up the window hierarchy)
     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;
 }
@@ -642,13 +654,19 @@ void wxToolBarBase::OnMouseEnter(int id)
     event.SetInt(id);
 
     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
     event.SetInt(id);
 
     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
-    if( frame )
+    if ( frame )
     {
         wxString help;
     {
         wxString help;
-        wxToolBarToolBase* tool = id == wxID_ANY ? (wxToolBarToolBase*)NULL : FindById(id);
-        if(tool)
-            help = tool->GetLongHelp();
-        frame->DoGiveHelp( help, id != wxID_ANY );
+        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);
     }
 
     (void)GetEventHandler()->ProcessEvent(event);
@@ -663,6 +681,10 @@ void wxToolBarBase::UpdateWindowUI(long flags)
 {
     wxWindowBase::UpdateWindowUI(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 );
     // There is no sense in updating the toolbar UI
     // if the parent window is about to get destroyed
     wxWindow *tlw = wxGetTopLevelParent( this );
@@ -675,7 +697,11 @@ void wxToolBarBase::UpdateWindowUI(long flags)
           node;
           node = node->GetNext() )
     {
           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);
 
         wxUpdateUIEvent event(id);
         event.SetEventObject(this);
@@ -694,73 +720,31 @@ void wxToolBarBase::UpdateWindowUI(long flags)
     }
 }
 
     }
 }
 
-#if wxUSE_IMAGE
-
-/*
- * Make a greyed-out image suitable for disabled buttons.
- * This code is adapted from wxNewBitmapButton in FL.
- */
-
-bool wxCreateGreyedImage(const wxImage& src, wxImage& dst)
+bool wxToolBarBase::SetDropdownMenu(int toolid, wxMenu* menu)
 {
 {
-    dst = src.Copy();
-
-    unsigned char rBg, gBg, bBg;
-    if ( src.HasMask() )
-    {
-        src.GetOrFindMaskColour(&rBg, &gBg, &bBg);
-        dst.SetMaskColour(rBg, gBg, bBg);
-    }
-    else // assuming the pixels along the edges are of the background color
-    {
-        rBg = src.GetRed(0, 0);
-        gBg = src.GetGreen(0, 0);
-        bBg = src.GetBlue(0, 0);
-    }
+    wxToolBarToolBase * const tool = FindById(toolid);
+    wxCHECK_MSG( tool, false, _T("invalid tool id") );
 
 
-    const wxColour colBg(rBg, gBg, bBg);
+    wxCHECK_MSG( tool->GetKind() == wxITEM_DROPDOWN, false,
+                    _T("menu can be only associated with drop down tools") );
 
 
-    const wxColour colDark = wxSystemSettings::GetColour(wxSYS_COLOUR_3DSHADOW);
-    const wxColour colLight = wxSystemSettings::GetColour(wxSYS_COLOUR_3DHIGHLIGHT);
-
-    // Second attempt, just making things monochrome
-    const int width = src.GetWidth();
-    const int height = src.GetHeight();
-
-    for ( int x = 0; x < width; x++ )
-    {
-        for ( int y = 0; y < height; y++ )
-        {
-            const int r = src.GetRed(x, y);
-            const int g = src.GetGreen(x, y);
-            const int b = src.GetBlue(x, y);
-
-            if ( r == rBg && g == gBg && b == bBg )
-            {
-                // Leave the background colour as-is
-                continue;
-            }
-
-            // Change light things to the background colour
-            wxColour col;
-            if ( r >= (colLight.Red() - 50) &&
-                    g >= (colLight.Green() - 50) &&
-                        b >= (colLight.Blue() - 50) )
-            {
-                col = colBg;
-            }
-            else // Change dark things to really dark
-            {
-                col = colDark;
-            }
-
-            dst.SetRGB(x, y, col.Red(), col.Green(), col.Blue());
-        }
-    }
+    tool->SetDropdownMenu(menu);
 
     return true;
 }
 
 
     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
 #endif // wxUSE_IMAGE
+    return false;
+}
+
+#endif // WXWIN_COMPATIBILITY_2_8
 
 #endif // wxUSE_TOOLBAR
 
 #endif // wxUSE_TOOLBAR