Applied patch [ 1701723 ] wxAUI: Added event for doubleclicks on the tabbar bg

[wxWidgets.git] / src / common / tbarbase.cpp

diff --git a/src/common/tbarbase.cpp b/src/common/tbarbase.cpp
index 1438c9f3c6e6c5b215fb7f1e22a1d2ad82efcda1..071dac26d3558a0953d1efcfffd357c39108e316 100644 (file)
--- 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
 // 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


@@ -17,10 +17,6 @@
 // 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"
 


@@ -30,18 +26,20 @@
 
 #if wxUSE_TOOLBAR
 
 
 #if wxUSE_TOOLBAR
 

+#include "wx/toolbar.h"
+

 #ifndef WX_PRECOMP
     #include "wx/control.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
 
 #endif
 

-#include "wx/frame.h"
-#include "wx/image.h"
-#include "wx/settings.h"
-
-#include "wx/toolbar.h"
-

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// wxWindows macros
+// wxWidgets macros

 // ----------------------------------------------------------------------------
 
 BEGIN_EVENT_TABLE(wxToolBarBase, wxControl)
 // ----------------------------------------------------------------------------
 
 BEGIN_EVENT_TABLE(wxToolBarBase, wxControl)


@@ -49,7 +47,7 @@ END_EVENT_TABLE()
 
 #include "wx/listimpl.cpp"
 
 
 #include "wx/listimpl.cpp"
 

-WX_DEFINE_LIST(wxToolBarToolsList);
+WX_DEFINE_LIST(wxToolBarToolsList)

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -59,14 +57,22 @@ WX_DEFINE_LIST(wxToolBarToolsList);
 // wxToolBarToolBase
 // ----------------------------------------------------------------------------
 
 // wxToolBarToolBase
 // ----------------------------------------------------------------------------
 

+IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject)
+
+wxToolBarToolBase::~wxToolBarToolBase()
+{
+    delete m_dropdownMenu;
+}
+
+

 bool wxToolBarToolBase::Enable(bool enable)
 {
     if ( m_enabled == enable )
 bool wxToolBarToolBase::Enable(bool enable)
 {
     if ( m_enabled == enable )

-        return FALSE;
+        return false;

 
     m_enabled = enable;
 
 
     m_enabled = enable;
 

-    return TRUE;
+    return true;

 }
 
 bool wxToolBarToolBase::Toggle(bool toggle)
 }
 
 bool wxToolBarToolBase::Toggle(bool toggle)


@@ -74,46 +80,49 @@ bool wxToolBarToolBase::Toggle(bool toggle)
     wxASSERT_MSG( CanBeToggled(), _T("can't toggle this tool") );
 
     if ( m_toggled == toggle )
     wxASSERT_MSG( CanBeToggled(), _T("can't toggle this tool") );
 
     if ( m_toggled == toggle )

-        return FALSE;
+        return false;

 
     m_toggled = toggle;
 
 
     m_toggled = toggle;
 

-    return TRUE;
+    return true;

 }
 
 bool wxToolBarToolBase::SetToggle(bool toggle)
 {
     wxItemKind kind = toggle ? wxITEM_CHECK : wxITEM_NORMAL;
     if ( m_kind == kind )
 }
 
 bool wxToolBarToolBase::SetToggle(bool toggle)
 {
     wxItemKind kind = toggle ? wxITEM_CHECK : wxITEM_NORMAL;
     if ( m_kind == kind )

-        return FALSE;
+        return false;

 
     m_kind = kind;
 
 
     m_kind = kind;
 

-    return TRUE;
+    return true;

 }
 
 bool wxToolBarToolBase::SetShortHelp(const wxString& help)
 {
     if ( m_shortHelpString == help )
 }
 
 bool wxToolBarToolBase::SetShortHelp(const wxString& help)
 {
     if ( m_shortHelpString == help )

-        return FALSE;
+        return false;

 
     m_shortHelpString = help;
 
 
     m_shortHelpString = help;
 

-    return TRUE;
+    return true;

 }
 
 bool wxToolBarToolBase::SetLongHelp(const wxString& help)
 {
     if ( m_longHelpString == help )
 }
 
 bool wxToolBarToolBase::SetLongHelp(const wxString& help)
 {
     if ( m_longHelpString == help )

-        return FALSE;
+        return false;

 
     m_longHelpString = help;
 
 
     m_longHelpString = help;
 

-    return TRUE;
+    return true;

 }
 
 }
 

-wxToolBarToolBase::~wxToolBarToolBase()
+
+void wxToolBarToolBase::SetDropdownMenu(wxMenu* menu)

 {
 {

+    delete m_dropdownMenu;
+    m_dropdownMenu = menu;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -124,8 +133,19 @@ wxToolBarBase::wxToolBarBase()
 {
     // the list owns the pointers
     m_xMargin = m_yMargin = 0;
 {
     // the list owns the pointers
     m_xMargin = m_yMargin = 0;

-

     m_maxRows = m_maxCols = 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,
 }
 
 wxToolBarToolBase *wxToolBarBase::DoAddTool(int id,


@@ -139,6 +159,7 @@ wxToolBarToolBase *wxToolBarBase::DoAddTool(int id,
                                             wxCoord WXUNUSED(xPos),
                                             wxCoord WXUNUSED(yPos))
 {
                                             wxCoord WXUNUSED(xPos),
                                             wxCoord WXUNUSED(yPos))
 {

+    InvalidateBestSize();

     return InsertTool(GetToolsCount(), id, label, bitmap, bmpDisabled,
                       kind, shortHelp, longHelp, clientData);
 }
     return InsertTool(GetToolsCount(), id, label, bitmap, bmpDisabled,
                       kind, shortHelp, longHelp, clientData);
 }


@@ -190,12 +211,16 @@ wxToolBarBase::InsertTool(size_t pos, wxToolBarToolBase *tool)
     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,
                  _T("toolbar: can't insert NULL control") );
 {
     wxCHECK_MSG( control, (wxToolBarToolBase *)NULL,
                  _T("toolbar: can't insert NULL control") );


@@ -206,7 +231,7 @@ wxToolBarToolBase *wxToolBarBase::InsertControl(size_t pos, wxControl *control)
     wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
                  _T("invalid position in wxToolBar::InsertControl()") );
 
     wxCHECK_MSG( pos <= GetToolsCount(), (wxToolBarToolBase *)NULL,
                  _T("invalid position in wxToolBar::InsertControl()") );
 

-    wxToolBarToolBase *tool = CreateTool(control);
+    wxToolBarToolBase *tool = CreateTool(control, label);

 
     if ( !InsertTool(pos, tool) )
     {
 
     if ( !InsertTool(pos, tool) )
     {


@@ -304,20 +329,20 @@ wxToolBarToolBase *wxToolBarBase::RemoveTool(int id)
 
 bool wxToolBarBase::DeleteToolByPos(size_t pos)
 {
 
 bool wxToolBarBase::DeleteToolByPos(size_t pos)
 {

-    wxCHECK_MSG( pos < GetToolsCount(), FALSE,
+    wxCHECK_MSG( pos < GetToolsCount(), false,

                  _T("invalid position in wxToolBar::DeleteToolByPos()") );
 
     wxToolBarToolsList::compatibility_iterator node = m_tools.Item(pos);
 
     if ( !DoDeleteTool(pos, node->GetData()) )
     {
                  _T("invalid position in wxToolBar::DeleteToolByPos()") );
 
     wxToolBarToolsList::compatibility_iterator node = m_tools.Item(pos);
 
     if ( !DoDeleteTool(pos, node->GetData()) )
     {

-        return FALSE;
+        return false;

     }
 
     delete node->GetData();
     m_tools.Erase(node);
 
     }
 
     delete node->GetData();
     m_tools.Erase(node);
 

-    return TRUE;
+    return true;

 }
 
 bool wxToolBarBase::DeleteTool(int id)
 }
 
 bool wxToolBarBase::DeleteTool(int id)


@@ -334,13 +359,13 @@ bool wxToolBarBase::DeleteTool(int id)
 
     if ( !node || !DoDeleteTool(pos, node->GetData()) )
     {
 
     if ( !node || !DoDeleteTool(pos, node->GetData()) )
     {

-        return FALSE;
+        return false;

     }
 
     delete node->GetData();
     m_tools.Erase(node);
 
     }
 
     delete node->GetData();
     m_tools.Erase(node);
 

-    return TRUE;
+    return true;

 }
 
 wxToolBarToolBase *wxToolBarBase::FindById(int id) const
 }
 
 wxToolBarToolBase *wxToolBarBase::FindById(int id) const


@@ -364,19 +389,73 @@ wxToolBarToolBase *wxToolBarBase::FindById(int id) const
     return tool;
 }
 
     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()
 {
 void wxToolBarBase::ClearTools()
 {

-    WX_CLEAR_LIST(wxToolBarToolsList, m_tools);
+    while ( GetToolsCount() )
+    {
+        DeleteToolByPos(0);
+    }

 }
 
 bool wxToolBarBase::Realize()
 {
 }
 
 bool wxToolBarBase::Realize()
 {

-    return TRUE;
+    return true;

 }
 
 wxToolBarBase::~wxToolBarBase()
 {
     WX_CLEAR_LIST(wxToolBarToolsList, m_tools);
 }
 
 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);
+    }

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -402,6 +481,7 @@ void wxToolBarBase::ToggleTool(int id, bool toggle)
     {
         if ( tool->Toggle(toggle) )
         {
     {
         if ( tool->Toggle(toggle) )
         {

+            UnToggleRadioGroup(tool);

             DoToggleTool(tool, toggle);
         }
     }
             DoToggleTool(tool, toggle);
         }
     }


@@ -472,7 +552,7 @@ int wxToolBarBase::GetToolPos(int id) const
 bool wxToolBarBase::GetToolState(int id) const
 {
     wxToolBarToolBase *tool = FindById(id);
 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();
 }
 
     return tool->IsToggled();
 }


@@ -480,7 +560,7 @@ bool wxToolBarBase::GetToolState(int id) const
 bool wxToolBarBase::GetToolEnabled(int id) const
 {
     wxToolBarToolBase *tool = FindById(id);
 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();
 }
 
     return tool->IsEnabled();
 }


@@ -488,7 +568,7 @@ bool wxToolBarBase::GetToolEnabled(int id) const
 wxString wxToolBarBase::GetToolShortHelp(int id) const
 {
     wxToolBarToolBase *tool = FindById(id);
 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();
 }
 
     return tool->GetShortHelp();
 }


@@ -496,7 +576,7 @@ wxString wxToolBarBase::GetToolShortHelp(int id) const
 wxString wxToolBarBase::GetToolLongHelp(int id) const
 {
     wxToolBarToolBase *tool = FindById(id);
 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();
 }
 
     return tool->GetLongHelp();
 }


@@ -520,7 +600,7 @@ void wxToolBarBase::SetRows(int WXUNUSED(nRows))
 // event processing
 // ----------------------------------------------------------------------------
 
 // 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);
 bool wxToolBarBase::OnLeftClick(int id, bool toggleDown)
 {
     wxCommandEvent event(wxEVT_COMMAND_TOOL_CLICKED, id);


@@ -535,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);
 
     // Send events to this toolbar instead (and thence up the window hierarchy)
     GetEventHandler()->ProcessEvent(event);
 

-    return TRUE;
+    return true;

 }
 
 // Call when right button down.
 }
 
 // Call when right button down.


@@ -551,7 +631,7 @@ void wxToolBarBase::OnRightClick(int id,
 }
 
 // Called when the mouse cursor enters a tool bitmap (no button pressed).
 }
 
 // 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.
 // 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.


@@ -562,11 +642,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 )

     {
     {

-        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);
     }
 
     (void)GetEventHandler()->ProcessEvent(event);


@@ -581,6 +669,16 @@ 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 );
+    if (tlw && wxPendingDelete.Member( tlw ))
+        return;
+

     wxEvtHandler* evtHandler = GetEventHandler() ;
 
     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
     wxEvtHandler* evtHandler = GetEventHandler() ;
 
     for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();


@@ -606,64 +704,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, _T("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,
+                    _T("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)
 {
 
 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
 #endif // wxUSE_TOOLBAR