X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/04dbb6467be8f564f380bd9a1106fbdecbd26a98..198be845897a79ba350ae7f93db536ddb2eccfb2:/src/common/tbarbase.cpp

diff --git a/src/common/tbarbase.cpp b/src/common/tbarbase.cpp
index dbce9ffff6..071dac26d3 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"
 
@@ -30,31 +26,28 @@
 
 #if wxUSE_TOOLBAR
 
-#ifndef WX_PRECOMP
-#endif
-
-#include "wx/frame.h"
+#include "wx/toolbar.h"
 
-// For ::UpdateWindow
-#ifdef __WXMSW__
-#include <windows.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/tbarbase.h"
-
 // ----------------------------------------------------------------------------
-// wxWindows macros
+// wxWidgets macros
 // ----------------------------------------------------------------------------
 
-IMPLEMENT_CLASS(wxToolBarBase, wxControl)
-
 BEGIN_EVENT_TABLE(wxToolBarBase, wxControl)
-    EVT_IDLE(wxToolBarBase::OnIdle)
 END_EVENT_TABLE()
 
 #include "wx/listimpl.cpp"
 
-WX_DEFINE_LIST(wxToolBarToolsList);
+WX_DEFINE_LIST(wxToolBarToolsList)
 
 // ============================================================================
 // implementation
@@ -64,60 +57,72 @@ WX_DEFINE_LIST(wxToolBarToolsList);
 // wxToolBarToolBase
 // ----------------------------------------------------------------------------
 
+IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject)
+
+wxToolBarToolBase::~wxToolBarToolBase()
+{
+    delete m_dropdownMenu;
+}
+
+
 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(), _T("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;
 }
 
 // ----------------------------------------------------------------------------
@@ -127,60 +132,95 @@ 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()") );
 
-    wxToolBarToolBase *tool = CreateTool(id, bitmap, pushedBitmap, toggle,
-                                         clientData, helpString1, helpString2);
+    wxToolBarToolBase *tool = CreateTool(id, label, bitmap, bmpDisabled, kind,
+                                         clientData, shortHelp, longHelp);
 
-    if ( !tool || !DoInsertTool(pos, tool) )
+    if ( !InsertTool(pos, tool) )
     {
         delete tool;
 
         return NULL;
     }
 
+    return tool;
+}
+
+wxToolBarToolBase *wxToolBarBase::AddTool(wxToolBarToolBase *tool)
+{
+    return InsertTool(GetToolsCount(), tool);
+}
+
+wxToolBarToolBase *
+wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool)
+{
+    wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
+                 _T("invalid position in wxToolBar::InsertTool()") );
+
+    if ( !tool || !DoInsertTool(pos, tool) )
+    {
+        return NULL;
+    }
+
     m_tools.Insert(pos, 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,
                  _T("toolbar: can't insert NULL control") );
@@ -191,20 +231,44 @@ wxToolBarToolBase *wxToolBarBase::InsertControl(size_t pos, wxControl *control)
     wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
                  _T("invalid position in wxToolBar::InsertControl()") );
 
-    wxToolBarToolBase *tool = CreateTool(control);
+    wxToolBarToolBase *tool = CreateTool(control, label);
 
-    if ( !tool || !DoInsertTool(pos, tool) )
+    if ( !InsertTool(pos, tool) )
     {
         delete tool;
 
         return NULL;
     }
 
-    m_tools.Insert(pos, tool);
-
     return tool;
 }
 
+wxControl *wxToolBarBase::FindControl( int id )
+{
+    for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
+          node;
+          node = node->GetNext() )
+    {
+        const wxToolBarToolBase * const tool = node->GetData();
+        if ( tool->IsControl() )
+        {
+            wxControl * const control = tool->GetControl();
+
+            if ( !control )
+            {
+                wxFAIL_MSG( _T("NULL control in toolbar?") );
+            }
+            else if ( control->GetId() == id )
+            {
+                // found
+                return control;
+            }
+        }
+    }
+
+   return NULL;
+}
+
 wxToolBarToolBase *wxToolBarBase::AddSeparator()
 {
     return InsertSeparator(GetToolsCount());
@@ -216,8 +280,9 @@ wxToolBarToolBase *wxToolBarBase::InsertSeparator(size_t pos)
                  _T("invalid position in wxToolBar::InsertSeparator()") );
 
     wxToolBarToolBase *tool = CreateTool(wxID_SEPARATOR,
+                                         wxEmptyString,
                                          wxNullBitmap, wxNullBitmap,
-                                         FALSE, (wxObject *)NULL,
+                                         wxITEM_SEPARATOR, (wxObject *)NULL,
                                          wxEmptyString, wxEmptyString);
 
     if ( !tool || !DoInsertTool(pos, tool) )
@@ -235,7 +300,7 @@ wxToolBarToolBase *wxToolBarBase::InsertSeparator(size_t pos)
 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 )
@@ -257,35 +322,33 @@ wxToolBarToolBase *wxToolBarBase::RemoveTool(int id)
         return (wxToolBarToolBase *)NULL;
     }
 
-    // the node would delete the data, so set it to NULL to avoid this
-    node->SetData(NULL);
-
-    m_tools.DeleteNode(node);
+    m_tools.Erase(node);
 
     return tool;
 }
 
 bool wxToolBarBase::DeleteToolByPos(size_t pos)
 {
-    wxCHECK_MSG( pos < GetToolsCount(), FALSE,
+    wxCHECK_MSG( pos < GetToolsCount(), false,
                  _T("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 )
@@ -296,19 +359,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;
 
-    for ( wxToolBarToolsList::Node *node = m_tools.GetFirst();
+    for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
           node;
           node = node->GetNext() )
     {
@@ -318,23 +382,80 @@ wxToolBarToolBase *wxToolBarBase::FindById(int id) const
             // found
             break;
         }
+
+        tool = NULL;
     }
 
     return tool;
 }
 
+void wxToolBarBase::UnToggleRadioGroup(wxToolBarToolBase *tool)
+{
+    wxCHECK_RET( tool, _T("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") );
+
+    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);
+    }
 }
 
 bool wxToolBarBase::Realize()
 {
-    return TRUE;
+    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);
+    }
 }
 
 // ----------------------------------------------------------------------------
@@ -360,6 +481,7 @@ void wxToolBarBase::ToggleTool(int id, bool toggle)
     {
         if ( tool->Toggle(toggle) )
         {
+            UnToggleRadioGroup(tool);
             DoToggleTool(tool, toggle);
         }
     }
@@ -411,10 +533,26 @@ void wxToolBarBase::SetToolClientData(int id, wxObject *clientData)
     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, _T("no such tool") );
 
     return tool->IsToggled();
 }
@@ -422,7 +560,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, _T("no such tool") );
 
     return tool->IsEnabled();
 }
@@ -430,7 +568,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, _T("no such tool") );
 
     return tool->GetShortHelp();
 }
@@ -438,7 +576,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, _T("no such tool") );
 
     return tool->GetLongHelp();
 }
@@ -462,7 +600,7 @@ void wxToolBarBase::SetRows(int WXUNUSED(nRows))
 // 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);
@@ -477,7 +615,7 @@ bool wxToolBarBase::OnLeftClick(int id, bool toggleDown)
     // Send events to this toolbar instead (and thence up the window hierarchy)
     GetEventHandler()->ProcessEvent(event);
 
-    return TRUE;
+    return true;
 }
 
 // Call when right button down.
@@ -493,7 +631,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.
@@ -503,46 +641,47 @@ 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();
+        }
+
+        // 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);
+    }
 
-    frame->SetStatusText(tool->GetLongHelp());
+    (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;
+
+    // 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 = focusWin ? focusWin->GetEventHandler() : GetEventHandler() ;
+    wxEvtHandler* evtHandler = GetEventHandler() ;
 
-    for ( wxToolBarToolsList::Node* node = m_tools.GetFirst();
+    for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
           node;
           node = node->GetNext() )
     {
@@ -565,4 +704,31 @@ void wxToolBarBase::DoToolbarUpdates()
     }
 }
 
+bool wxToolBarBase::SetDropdownMenu(int toolid, wxMenu* menu)
+{
+    wxToolBarToolBase * const tool = FindById(toolid);
+    wxCHECK_MSG( tool, false, _T("invalid tool id") );
+
+    wxCHECK_MSG( tool->GetKind() == wxITEM_DROPDOWN, false,
+                    _T("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