Doc tweaks

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

diff --git a/src/common/tbarbase.cpp b/src/common/tbarbase.cpp
index caef94d252d831aee36c6cfe47fe92bd4fccb5a8..f944cdd209f9d6659c79ae02b8d6908338b952c4 100644 (file)
--- a/src/common/tbarbase.cpp
+++ b/src/common/tbarbase.cpp
@@ -17,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma implementation "tbarbase.h"
 #endif
 
     #pragma implementation "tbarbase.h"
 #endif
 


@@ -38,16 +38,13 @@
 #include "wx/image.h"
 #include "wx/settings.h"
 
 #include "wx/image.h"
 #include "wx/settings.h"
 

-#include "wx/tbarbase.h"
+#include "wx/toolbar.h"

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

-// wxWindows macros
+// wxWidgets macros

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

-IMPLEMENT_CLASS(wxToolBarBase, wxControl)
-

 BEGIN_EVENT_TABLE(wxToolBarBase, wxControl)
 BEGIN_EVENT_TABLE(wxToolBarBase, wxControl)

-    EVT_IDLE(wxToolBarBase::OnIdle)

 END_EVENT_TABLE()
 
 #include "wx/listimpl.cpp"
 END_EVENT_TABLE()
 
 #include "wx/listimpl.cpp"


@@ -62,14 +59,16 @@ WX_DEFINE_LIST(wxToolBarToolsList);
 // wxToolBarToolBase
 // ----------------------------------------------------------------------------
 
 // wxToolBarToolBase
 // ----------------------------------------------------------------------------
 

+IMPLEMENT_DYNAMIC_CLASS(wxToolBarToolBase, wxObject)
+

 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)


@@ -77,48 +76,68 @@ 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;
+}
+
+#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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxToolBarBase adding/deleting items
 // ----------------------------------------------------------------------------


@@ -126,8 +145,6 @@ wxToolBarToolBase::~wxToolBarToolBase()
 wxToolBarBase::wxToolBarBase()
 {
     // the list owns the pointers
 wxToolBarBase::wxToolBarBase()
 {
     // the list owns the pointers

-    m_tools.DeleteContents(TRUE);
-

     m_xMargin = m_yMargin = 0;
 
     m_maxRows = m_maxCols = 0;
     m_xMargin = m_yMargin = 0;
 
     m_maxRows = m_maxCols = 0;


@@ -144,6 +161,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);
 }


@@ -225,7 +243,7 @@ wxToolBarToolBase *wxToolBarBase::InsertControl(size_t pos, wxControl *control)
 
 wxControl *wxToolBarBase::FindControl( int id )
 {
 
 wxControl *wxToolBarBase::FindControl( int id )
 {

-    for ( wxToolBarToolsList::Node* node = m_tools.GetFirst();
+    for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();

           node;
           node = node->GetNext() )
     {
           node;
           node = node->GetNext() )
     {


@@ -280,7 +298,7 @@ wxToolBarToolBase *wxToolBarBase::InsertSeparator(size_t pos)
 wxToolBarToolBase *wxToolBarBase::RemoveTool(int id)
 {
     size_t pos = 0;
 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 )
     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
     {
         if ( node->GetData()->GetId() == id )


@@ -302,35 +320,33 @@ wxToolBarToolBase *wxToolBarBase::RemoveTool(int id)
         return (wxToolBarToolBase *)NULL;
     }
 
         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)
 {
 
     return tool;
 }
 
 bool wxToolBarBase::DeleteToolByPos(size_t pos)
 {

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

                  _T("invalid position in wxToolBar::DeleteToolByPos()") );
 
                  _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()) )
     {
 
     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;
 }
 
 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 )
     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
     {
         if ( node->GetData()->GetId() == id )


@@ -341,19 +357,20 @@ bool wxToolBarBase::DeleteTool(int id)
 
     if ( !node || !DoDeleteTool(pos, node->GetData()) )
     {
 
     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;
 
 }
 
 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() )
     {
           node;
           node = node->GetNext() )
     {


@@ -370,18 +387,70 @@ 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 *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()
 {
 void wxToolBarBase::ClearTools()
 {

-    m_tools.Clear();
+    WX_CLEAR_LIST(wxToolBarToolsList, m_tools);

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

-    return TRUE;
+    return true;

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

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


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

+            UnToggleRadioGroup(tool);

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


@@ -461,7 +531,7 @@ void wxToolBarBase::SetToolClientData(int id, wxObject *clientData)
 int wxToolBarBase::GetToolPos(int id) const
 {
     size_t pos = 0;
 int wxToolBarBase::GetToolPos(int id) const
 {
     size_t pos = 0;

-    wxToolBarToolsList::Node *node;
+    wxToolBarToolsList::compatibility_iterator node;

 
     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
     {
 
     for ( node = m_tools.GetFirst(); node; node = node->GetNext() )
     {


@@ -477,7 +547,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();
 }


@@ -485,7 +555,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();
 }


@@ -493,7 +563,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();
 }


@@ -501,7 +571,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();
 }


@@ -525,7 +595,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);


@@ -540,7 +610,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.


@@ -556,7 +626,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.


@@ -569,9 +639,11 @@ void wxToolBarBase::OnMouseEnter(int id)
     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
     if( frame )
     {
     wxFrame *frame = wxDynamicCast(GetParent(), wxFrame);
     if( frame )
     {

-        wxToolBarToolBase* tool = id == -1 ? (wxToolBarToolBase*)0 : FindById(id);
-        wxString help = tool ? tool->GetLongHelp() : wxString();
-        frame->DoGiveHelp( help, id != -1 );
+        wxString help;
+        wxToolBarToolBase* tool = id == wxID_ANY ? (wxToolBarToolBase*)NULL : FindById(id);
+        if(tool)
+            help = tool->GetLongHelp();
+        frame->DoGiveHelp( help, id != wxID_ANY );

     }
 
     (void)GetEventHandler()->ProcessEvent(event);
     }
 
     (void)GetEventHandler()->ProcessEvent(event);


@@ -581,19 +653,20 @@ void wxToolBarBase::OnMouseEnter(int id)
 // UI updates
 // ----------------------------------------------------------------------------
 
 // UI updates
 // ----------------------------------------------------------------------------
 

-void wxToolBarBase::OnIdle(wxIdleEvent& event)
+// Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
+void wxToolBarBase::UpdateWindowUI(long flags)

 {
 {

-    DoToolbarUpdates();
+    wxWindowBase::UpdateWindowUI(flags);

 
 

-    event.Skip();
-}
+    // 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;

 
 

-// Do the toolbar button updates (check for EVT_UPDATE_UI handlers)
-void wxToolBarBase::DoToolbarUpdates()
-{

     wxEvtHandler* evtHandler = GetEventHandler() ;
 
     wxEvtHandler* evtHandler = GetEventHandler() ;
 

-    for ( wxToolBarToolsList::Node* node = m_tools.GetFirst();
+    for ( wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();

           node;
           node = node->GetNext() )
     {
           node;
           node = node->GetNext() )
     {


@@ -673,7 +746,7 @@ bool wxCreateGreyedImage(const wxImage& in, wxImage& out)
 
     wxGreyOutImage(in, out, darkCol, lightCol, bgCol);
 
 
     wxGreyOutImage(in, out, darkCol, lightCol, bgCol);
 

-    return TRUE;
+    return true;

 }
 
 #endif // wxUSE_TOOLBAR
 }
 
 #endif // wxUSE_TOOLBAR