]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/tbarbase.cpp
Incomplete wxUSE_* warning fix.
[wxWidgets.git] / src / common / tbarbase.cpp
index d904ff91949b1412732f40df617a08c293fc47f7..f944cdd209f9d6659c79ae02b8d6908338b952c4 100644 (file)
@@ -5,8 +5,8 @@
 // Modified by: VZ at 11.12.99 (wxScrollableToolBar splitted 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,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma implementation "tbarbase.h"
 #endif
 
     #pragma hdrstop
 #endif
 
+#if wxUSE_TOOLBAR
+
 #ifndef WX_PRECOMP
-    #include "wx/wx.h"
+    #include "wx/control.h"
 #endif
 
 #include "wx/frame.h"
+#include "wx/image.h"
+#include "wx/settings.h"
 
-// For ::UpdateWindow
-#ifdef __WXMSW__
-#include <windows.h>
-#endif
-
-#if wxUSE_TOOLBAR
-
-#include "wx/tbarbase.h"
+#include "wx/toolbar.h"
 
 // ----------------------------------------------------------------------------
-// wxWindows macros
+// wxWidgets macros
 // ----------------------------------------------------------------------------
 
-#if !USE_SHARED_LIBRARY
-    BEGIN_EVENT_TABLE(wxToolBarBase, wxControl)
-        EVT_IDLE(wxToolBarBase::OnIdle)
-    END_EVENT_TABLE()
-#endif
-
-IMPLEMENT_CLASS(wxToolBarBase, wxControl)
+BEGIN_EVENT_TABLE(wxToolBarBase, wxControl)
+END_EVENT_TABLE()
 
 #include "wx/listimpl.cpp"
 
@@ -67,62 +59,85 @@ WX_DEFINE_LIST(wxToolBarToolsList);
 // wxToolBarToolBase
 // ----------------------------------------------------------------------------
 
+IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject)
+
 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;
+}
+
+#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);
 }
 
-wxToolBarToolBase::~wxToolBarToolBase()
+void wxToolBarToolBase::SetBitmap2(const wxBitmap& bmp)
 {
+    SetDisabledBitmap(bmp);
 }
 
+#endif // WXWIN_COMPATIBILITY_2_2
+
 // ----------------------------------------------------------------------------
 // wxToolBarBase adding/deleting items
 // ----------------------------------------------------------------------------
@@ -130,49 +145,69 @@ wxToolBarToolBase::~wxToolBarToolBase()
 wxToolBarBase::wxToolBarBase()
 {
     // the list owns the pointers
-    m_tools.DeleteContents(TRUE);
-
     m_xMargin = m_yMargin = 0;
 
     m_maxRows = m_maxCols = 0;
 }
 
-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;
@@ -196,18 +231,42 @@ wxToolBarToolBase *wxToolBarBase::InsertControl(size_t pos, wxControl *control)
 
     wxToolBarToolBase *tool = CreateTool(control);
 
-    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());
@@ -219,8 +278,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) )
@@ -238,7 +298,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 )
@@ -260,35 +320,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 )
@@ -299,19 +357,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() )
     {
@@ -321,23 +380,77 @@ 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 *tool = nodeNext->GetData();
+
+        if ( !tool->IsButton() || tool->GetKind() != wxITEM_RADIO )
+            break;
+
+        if ( tool->Toggle(false) )
+        {
+            DoToggleTool(tool, false);
+        }
+
+        nodeNext = nodeNext->GetNext();
+    }
+
+    wxToolBarToolsList::compatibility_iterator nodePrev = node->GetPrevious();
+    while ( nodePrev )
+    {
+        wxToolBarToolBase *tool = nodePrev->GetData();
+
+        if ( !tool->IsButton() || tool->GetKind() != wxITEM_RADIO )
+            break;
+
+        if ( tool->Toggle(false) )
+        {
+            DoToggleTool(tool, false);
+        }
+
+        nodePrev = nodePrev->GetPrevious();
+    }
+}
+
 void wxToolBarBase::ClearTools()
 {
-    m_tools.Clear();
+    WX_CLEAR_LIST(wxToolBarToolsList, m_tools);
 }
 
 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
+    wxFrameBase *frame = wxDynamicCast(GetParent(), wxFrameBase);
+    if ( frame && frame->GetToolBar() == this )
+    {
+        frame->SetToolBar(NULL);
+    }
 }
 
 // ----------------------------------------------------------------------------
@@ -363,6 +476,7 @@ void wxToolBarBase::ToggleTool(int id, bool toggle)
     {
         if ( tool->Toggle(toggle) )
         {
+            UnToggleRadioGroup(tool);
             DoToggleTool(tool, toggle);
         }
     }
@@ -414,10 +528,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();
 }
@@ -425,7 +555,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();
 }
@@ -433,7 +563,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();
 }
@@ -441,7 +571,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();
 }
@@ -465,17 +595,22 @@ 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);
     event.SetEventObject(this);
-    event.SetExtraLong((long) toggleDown);
+
+    // we use SetInt() to make wxCommandEvent::IsChecked() return toggleDown
+    event.SetInt((int)toggleDown);
+
+    // and SetExtraLong() for backwards compatibility
+    event.SetExtraLong((long)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.
@@ -491,7 +626,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.
@@ -501,46 +636,37 @@ 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;
+        wxToolBarToolBase* tool = id == wxID_ANY ? (wxToolBarToolBase*)NULL : FindById(id);
+        if(tool)
+            help = tool->GetLongHelp();
+        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
+    // 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() )
     {
@@ -563,4 +689,64 @@ void wxToolBarBase::DoToolbarUpdates()
     }
 }
 
+// Helper function, used by wxCreateGreyedImage
+
+static void wxGreyOutImage( const wxImage& src,
+                            wxImage& dest,
+                            const wxColour& darkCol,
+                            const wxColour& lightCol,
+                            const wxColour& bgCol )
+{
+    // Second attempt, just making things monochrome
+    int width = src.GetWidth();
+    int height = src.GetHeight();
+
+    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);
+
+            // 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());
+            }
+        }
+    }
+}
+
+/*
+ * Make a greyed-out image suitable for disabled buttons.
+ * This code is adapted from wxNewBitmapButton in FL.
+ */
+
+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;
+}
+
 #endif // wxUSE_TOOLBAR