Remove identic implementations of wxDir::Exists from platform-specific files and...

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

diff --git a/src/common/cshelp.cpp b/src/common/cshelp.cpp
index 60e595f156e3e4ae7127ca9c24478c796aad3140..5bbdd65f524842f20d1956823d5deb5e569d7ca1 100644 (file)
--- a/src/common/cshelp.cpp
+++ b/src/common/cshelp.cpp
@@ -6,17 +6,13 @@
 // Created:     08/09/2000
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Julian Smart, Vadim Zeitlin
 // Created:     08/09/2000
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Julian Smart, Vadim Zeitlin

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // declarations
 // ============================================================================
 
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // declarations
 // ============================================================================
 

-#ifdef __GNUG__
-    #pragma implementation "cshelp.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -31,13 +27,18 @@
 #if wxUSE_HELP
 
 #ifndef WX_PRECOMP
 #if wxUSE_HELP
 
 #ifndef WX_PRECOMP

+    #include "wx/app.h"
+    #include "wx/module.h"

 #endif
 
 #include "wx/tipwin.h"
 #endif
 
 #include "wx/tipwin.h"

-#include "wx/app.h"
-#include "wx/module.h"

 #include "wx/cshelp.h"
 
 #include "wx/cshelp.h"
 

+#if wxUSE_MS_HTML_HELP
+    #include "wx/msw/helpchm.h"     // for ShowContextHelpPopup
+    #include "wx/utils.h"           // for wxGetMousePosition()
+#endif
+

 // ----------------------------------------------------------------------------
 // wxContextHelpEvtHandler private class
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxContextHelpEvtHandler private class
 // ----------------------------------------------------------------------------


@@ -56,6 +57,8 @@ public:
 
 //// Data
     wxContextHelp* m_contextHelp;
 
 //// Data
     wxContextHelp* m_contextHelp;

+
+    wxDECLARE_NO_COPY_CLASS(wxContextHelpEvtHandler);

 };
 
 // ============================================================================
 };
 
 // ============================================================================


@@ -75,7 +78,7 @@ IMPLEMENT_DYNAMIC_CLASS(wxContextHelp, wxObject)
 
 wxContextHelp::wxContextHelp(wxWindow* win, bool beginHelp)
 {
 
 wxContextHelp::wxContextHelp(wxWindow* win, bool beginHelp)
 {

-    m_inHelp = FALSE;
+    m_inHelp = false;

 
     if (beginHelp)
         BeginContextHelp(win);
 
     if (beginHelp)
         BeginContextHelp(win);


@@ -87,23 +90,50 @@ wxContextHelp::~wxContextHelp()
         EndContextHelp();
 }
 
         EndContextHelp();
 }
 

+// Not currently needed, but on some systems capture may not work as
+// expected so we'll leave it here for now.
+#ifdef __WXMOTIF__
+static void wxPushOrPopEventHandlers(wxContextHelp* help, wxWindow* win, bool push)
+{
+    if (push)
+        win->PushEventHandler(new wxContextHelpEvtHandler(help));
+    else
+        win->PopEventHandler(true);
+
+    wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst();
+    while (node)
+    {
+        wxWindow* child = node->GetData();
+        wxPushOrPopEventHandlers(help, child, push);
+
+        node = node->GetNext();
+    }
+}
+#endif
+

 // Begin 'context help mode'
 bool wxContextHelp::BeginContextHelp(wxWindow* win)
 {
     if (!win)
         win = wxTheApp->GetTopWindow();
     if (!win)
 // Begin 'context help mode'
 bool wxContextHelp::BeginContextHelp(wxWindow* win)
 {
     if (!win)
         win = wxTheApp->GetTopWindow();
     if (!win)

-        return FALSE;
+        return false;

 
     wxCursor cursor(wxCURSOR_QUESTION_ARROW);
     wxCursor oldCursor = win->GetCursor();
     win->SetCursor(cursor);
 
 
     wxCursor cursor(wxCURSOR_QUESTION_ARROW);
     wxCursor oldCursor = win->GetCursor();
     win->SetCursor(cursor);
 

-#ifdef __WXMSW__
-    //    wxSetCursor(cursor);
+#ifdef __WXMAC__
+    wxSetCursor(cursor);

 #endif
 
 #endif
 

+    m_status = false;
+
+#ifdef __WXMOTIF__
+    wxPushOrPopEventHandlers(this, win, true);
+#else

     win->PushEventHandler(new wxContextHelpEvtHandler(this));
     win->PushEventHandler(new wxContextHelpEvtHandler(this));

+#endif

 
     win->CaptureMouse();
 
 
     win->CaptureMouse();
 


@@ -111,40 +141,49 @@ bool wxContextHelp::BeginContextHelp(wxWindow* win)
 
     win->ReleaseMouse();
 
 
     win->ReleaseMouse();
 

-    win->PopEventHandler(TRUE);
+#ifdef __WXMOTIF__
+    wxPushOrPopEventHandlers(this, win, false);
+#else
+    win->PopEventHandler(true);
+#endif

 
     win->SetCursor(oldCursor);
 
 
     win->SetCursor(oldCursor);
 

+#ifdef __WXMAC__
+    wxSetCursor(wxNullCursor);
+#endif
+

     if (m_status)
     {
         wxPoint pt;
         wxWindow* winAtPtr = wxFindWindowAtPointer(pt);
     if (m_status)
     {
         wxPoint pt;
         wxWindow* winAtPtr = wxFindWindowAtPointer(pt);

-       /*
+
+#if 0

         if (winAtPtr)
         {
         if (winAtPtr)
         {

-       wxString msg;
-        msg.Printf("Picked %s (%d)", (const char*) winAtPtr->GetName(), winAtPtr->GetId());
-        cout << msg << '\n';
+            printf("Picked %s (%d)\n", winAtPtr->GetName().c_str(),
+                   winAtPtr->GetId());

         }
         }

-       */
+#endif

 
         if (winAtPtr)
             DispatchEvent(winAtPtr, pt);
     }
 
 
         if (winAtPtr)
             DispatchEvent(winAtPtr, pt);
     }
 

-    return TRUE;
+    return true;

 }
 
 bool wxContextHelp::EndContextHelp()
 {
 }
 
 bool wxContextHelp::EndContextHelp()
 {

-    m_inHelp = FALSE;
+    m_inHelp = false;

 
 

-    return TRUE;
+    return true;

 }
 
 bool wxContextHelp::EventLoop()
 {
 }
 
 bool wxContextHelp::EventLoop()
 {

-    m_inHelp = TRUE;
+    m_inHelp = true;
+

     while ( m_inHelp )
     {
         if (wxTheApp->Pending())
     while ( m_inHelp )
     {
         if (wxTheApp->Pending())


@@ -156,55 +195,50 @@ bool wxContextHelp::EventLoop()
             wxTheApp->ProcessIdle();
         }
     }
             wxTheApp->ProcessIdle();
         }
     }

-    return TRUE;
+
+    return true;

 }
 
 bool wxContextHelpEvtHandler::ProcessEvent(wxEvent& event)
 {
     if (event.GetEventType() == wxEVT_LEFT_DOWN)
     {
 }
 
 bool wxContextHelpEvtHandler::ProcessEvent(wxEvent& event)
 {
     if (event.GetEventType() == wxEVT_LEFT_DOWN)
     {

-        m_contextHelp->SetStatus(TRUE);
+        m_contextHelp->SetStatus(true);

         m_contextHelp->EndContextHelp();
         m_contextHelp->EndContextHelp();

-        return TRUE;
+        return true;

     }
     }

-    
+

     if ((event.GetEventType() == wxEVT_CHAR) ||
         (event.GetEventType() == wxEVT_KEY_DOWN) ||
         (event.GetEventType() == wxEVT_ACTIVATE) ||
         (event.GetEventType() == wxEVT_MOUSE_CAPTURE_CHANGED))
     {
     if ((event.GetEventType() == wxEVT_CHAR) ||
         (event.GetEventType() == wxEVT_KEY_DOWN) ||
         (event.GetEventType() == wxEVT_ACTIVATE) ||
         (event.GetEventType() == wxEVT_MOUSE_CAPTURE_CHANGED))
     {

-        m_contextHelp->SetStatus(FALSE);
+        // May have already been set to true by a left-click
+        //m_contextHelp->SetStatus(false);

         m_contextHelp->EndContextHelp();
         m_contextHelp->EndContextHelp();

-        return TRUE;
+        return true;

     }
     }

-    
+

     if ((event.GetEventType() == wxEVT_PAINT) ||
         (event.GetEventType() == wxEVT_ERASE_BACKGROUND))
     {
         event.Skip();
     if ((event.GetEventType() == wxEVT_PAINT) ||
         (event.GetEventType() == wxEVT_ERASE_BACKGROUND))
     {
         event.Skip();

-        return FALSE;
+        return false;

     }
     }

-    
-    return TRUE;
+
+    return true;

 }
 
 // Dispatch the help event to the relevant window
 bool wxContextHelp::DispatchEvent(wxWindow* win, const wxPoint& pt)
 {
 }
 
 // Dispatch the help event to the relevant window
 bool wxContextHelp::DispatchEvent(wxWindow* win, const wxPoint& pt)
 {

-    wxWindow* subjectOfHelp = win;
-    bool eventProcessed = FALSE;
-    while (subjectOfHelp && !eventProcessed)
-    {
-        wxHelpEvent helpEvent(wxEVT_HELP, subjectOfHelp->GetId(), pt) ;
-        helpEvent.SetEventObject(this);
-        eventProcessed = win->GetEventHandler()->ProcessEvent(helpEvent);
-        
-        // Go up the window hierarchy until the event is handled (or not).
-        // I.e. keep submitting ancestor windows until one is recognised
-        // by the app code that processes the ids and displays help.
-        subjectOfHelp = subjectOfHelp->GetParent();
-    }
-    return eventProcessed;
+    wxCHECK_MSG( win, false, wxT("win parameter can't be NULL") );
+
+    wxHelpEvent helpEvent(wxEVT_HELP, win->GetId(), pt,
+                          wxHelpEvent::Origin_HelpButton);
+    helpEvent.SetEventObject(win);
+
+    return win->GetEventHandler()->ProcessEvent(helpEvent);

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


@@ -217,8 +251,9 @@ bool wxContextHelp::DispatchEvent(wxWindow* win, const wxPoint& pt)
  * to put the application into context help mode.
  */
 
  * to put the application into context help mode.
  */
 

-#if !defined(__WXMSW__)
-static char * csquery_xpm[] = {
+#ifndef __WXPM__
+
+static const char * csquery_xpm[] = {

 "12 11 2 1",
 "  c None",
 ". c #000000",
 "12 11 2 1",
 "  c None",
 ". c #000000",


@@ -233,6 +268,7 @@ static char * csquery_xpm[] = {
 "     ..     ",
 "     ..     ",
 "            "};
 "     ..     ",
 "     ..     ",
 "            "};

+

 #endif
 
 IMPLEMENT_CLASS(wxContextHelpButton, wxBitmapButton)
 #endif
 
 IMPLEMENT_CLASS(wxContextHelpButton, wxBitmapButton)


@@ -246,12 +282,19 @@ wxContextHelpButton::wxContextHelpButton(wxWindow* parent,
                                          const wxPoint& pos,
                                          const wxSize& size,
                                          long style)
                                          const wxPoint& pos,
                                          const wxSize& size,
                                          long style)

-                   : wxBitmapButton(parent, id, wxBITMAP(csquery),
+#if defined(__WXPM__)
+                   : wxBitmapButton(parent, id, wxBitmap(wxCSQUERY_BITMAP
+                                                         ,wxBITMAP_TYPE_RESOURCE
+                                                        ),
+                                    pos, size, style)
+#else
+                   : wxBitmapButton(parent, id, wxBitmap(csquery_xpm),

                                     pos, size, style)
                                     pos, size, style)

+#endif

 {
 }
 
 {
 }
 

-void wxContextHelpButton::OnContextHelp(wxCommandEvent& event)
+void wxContextHelpButton::OnContextHelp(wxCommandEvent& WXUNUSED(event))

 {
     wxContextHelp contextHelp(GetParent());
 }
 {
     wxContextHelp contextHelp(GetParent());
 }


@@ -260,7 +303,7 @@ void wxContextHelpButton::OnContextHelp(wxCommandEvent& event)
 // wxHelpProvider
 // ----------------------------------------------------------------------------
 
 // wxHelpProvider
 // ----------------------------------------------------------------------------
 

-wxHelpProvider *wxHelpProvider::ms_helpProvider = (wxHelpProvider *)NULL;
+wxHelpProvider *wxHelpProvider::ms_helpProvider = NULL;

 
 // trivial implementation of some methods which we don't want to make pure
 // virtual for convenience
 
 // trivial implementation of some methods which we don't want to make pure
 // virtual for convenience


@@ -275,45 +318,122 @@ void wxHelpProvider::AddHelp(wxWindowID WXUNUSED(id),
 {
 }
 
 {
 }
 

+// removes the association
+void wxHelpProvider::RemoveHelp(wxWindowBase* WXUNUSED(window))
+{
+}
+

 wxHelpProvider::~wxHelpProvider()
 {
 }
 
 wxHelpProvider::~wxHelpProvider()
 {
 }
 

+wxString wxHelpProvider::GetHelpTextMaybeAtPoint(wxWindowBase *window)
+{
+    if ( m_helptextAtPoint != wxDefaultPosition ||
+            m_helptextOrigin != wxHelpEvent::Origin_Unknown )
+    {
+        wxCHECK_MSG( window, wxEmptyString, wxT("window must not be NULL") );
+
+        wxPoint pt = m_helptextAtPoint;
+        wxHelpEvent::Origin origin = m_helptextOrigin;
+
+        m_helptextAtPoint = wxDefaultPosition;
+        m_helptextOrigin = wxHelpEvent::Origin_Unknown;
+
+        return window->GetHelpTextAtPoint(pt, origin);
+    }
+
+    return GetHelp(window);
+}
+

 // ----------------------------------------------------------------------------
 // wxSimpleHelpProvider
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxSimpleHelpProvider
 // ----------------------------------------------------------------------------
 

+#define WINHASH_KEY(w) wxPtrToUInt(w)
+

 wxString wxSimpleHelpProvider::GetHelp(const wxWindowBase *window)
 {
 wxString wxSimpleHelpProvider::GetHelp(const wxWindowBase *window)
 {

-    bool wasFound;
-    wxString text = m_hashWindows.Get((long)window, &wasFound);
-    if ( !wasFound )
-        text = m_hashIds.Get(window->GetId());
+    wxSimpleHelpProviderHashMap::iterator it = m_hashWindows.find(WINHASH_KEY(window));
+
+    if ( it == m_hashWindows.end() )
+    {
+        it = m_hashIds.find(window->GetId());
+        if ( it == m_hashIds.end() )
+            return wxEmptyString;
+    }

 
 

-    return text;
+    return it->second;

 }
 
 void wxSimpleHelpProvider::AddHelp(wxWindowBase *window, const wxString& text)
 {
 }
 
 void wxSimpleHelpProvider::AddHelp(wxWindowBase *window, const wxString& text)
 {

-    m_hashWindows.Put((long)window, text);
+    m_hashWindows.erase(WINHASH_KEY(window));
+    m_hashWindows[WINHASH_KEY(window)] = text;

 }
 
 void wxSimpleHelpProvider::AddHelp(wxWindowID id, const wxString& text)
 {
 }
 
 void wxSimpleHelpProvider::AddHelp(wxWindowID id, const wxString& text)
 {

-    m_hashIds.Put(id, text);
+    wxSimpleHelpProviderHashMap::key_type key = (wxSimpleHelpProviderHashMap::key_type)id;
+    m_hashIds.erase(key);
+    m_hashIds[key] = text;
+}
+
+// removes the association
+void wxSimpleHelpProvider::RemoveHelp(wxWindowBase* window)
+{
+    m_hashWindows.erase(WINHASH_KEY(window));

 }
 
 bool wxSimpleHelpProvider::ShowHelp(wxWindowBase *window)
 {
 }
 
 bool wxSimpleHelpProvider::ShowHelp(wxWindowBase *window)
 {

-    wxString text = GetHelp(window);
+#if wxUSE_MS_HTML_HELP || wxUSE_TIPWINDOW
+#if wxUSE_MS_HTML_HELP
+    // m_helptextAtPoint will be reset by GetHelpTextMaybeAtPoint(), stash it
+    const wxPoint posTooltip = m_helptextAtPoint;
+#endif // wxUSE_MS_HTML_HELP
+
+    const wxString text = GetHelpTextMaybeAtPoint(window);
+

     if ( !text.empty() )
     {
     if ( !text.empty() )
     {

-        new wxTipWindow((wxWindow *)window, text);
+        // use the native help popup style if it's available
+#if wxUSE_MS_HTML_HELP
+        if ( !wxCHMHelpController::ShowContextHelpPopup
+                                   (
+                                        text,
+                                        posTooltip,
+                                        (wxWindow *)window
+                                   ) )
+#endif // wxUSE_MS_HTML_HELP
+        {
+#if wxUSE_TIPWINDOW
+            static wxTipWindow* s_tipWindow = NULL;
+
+            if ( s_tipWindow )
+            {
+                // Prevent s_tipWindow being nulled in OnIdle, thereby removing
+                // the chance for the window to be closed by ShowHelp
+                s_tipWindow->SetTipWindowPtr(NULL);
+                s_tipWindow->Close();
+            }
+
+            s_tipWindow = new wxTipWindow((wxWindow *)window, text,
+                                            100, &s_tipWindow);
+#else // !wxUSE_TIPWINDOW
+            // we tried wxCHMHelpController but it failed and we don't have
+            // wxTipWindow to fall back on, so
+            return false;
+#endif // wxUSE_TIPWINDOW
+        }

 
 

-        return TRUE;
+        return true;

     }
     }

+#else // !wxUSE_MS_HTML_HELP && !wxUSE_TIPWINDOW
+    wxUnusedVar(window);
+#endif // wxUSE_MS_HTML_HELP || wxUSE_TIPWINDOW

 
 

-    return FALSE;
+    return false;

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


@@ -327,35 +447,32 @@ wxHelpControllerHelpProvider::wxHelpControllerHelpProvider(wxHelpControllerBase*
 
 bool wxHelpControllerHelpProvider::ShowHelp(wxWindowBase *window)
 {
 
 bool wxHelpControllerHelpProvider::ShowHelp(wxWindowBase *window)
 {

-    wxString text = GetHelp(window);
-    if ( !text.empty() )
-    {
-        if (m_helpController)
-        {
-            if (text.IsNumber())
-                return m_helpController->DisplayContextPopup(wxAtoi(text));
+    const wxString text = GetHelpTextMaybeAtPoint(window);

 
 

-            // If the help controller is capable of popping up the text...
-            else if (m_helpController->DisplayTextPopup(text, wxGetMousePosition()))
-            {
-                return TRUE;
-            }
-            else
-            // ...else use the default method.
-                return wxSimpleHelpProvider::ShowHelp(window);
-        }
-        else
-            return wxSimpleHelpProvider::ShowHelp(window);
+    if ( text.empty() )
+        return false;

 
 

+    if ( m_helpController )
+    {
+        // if it's a numeric topic, show it
+        long topic;
+        if ( text.ToLong(&topic) )
+            return m_helpController->DisplayContextPopup(topic);
+
+        // otherwise show the text directly
+        if ( m_helpController->DisplayTextPopup(text, wxGetMousePosition()) )
+            return true;

     }
 
     }
 

-    return FALSE;
+    // if there is no help controller or it's not capable of showing the help,
+    // fallback to the default method
+    return wxSimpleHelpProvider::ShowHelp(window);

 }
 
 // Convenience function for turning context id into wxString
 wxString wxContextId(int id)
 {
 }
 
 // Convenience function for turning context id into wxString
 wxString wxContextId(int id)
 {

-    return wxString(IntToString(id));
+    return wxString::Format(wxT("%d"), id);

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


@@ -380,7 +497,7 @@ bool wxHelpProviderModule::OnInit()
     // since it could pull in extra code
     // wxHelpProvider::Set(new wxSimpleHelpProvider);
 
     // since it could pull in extra code
     // wxHelpProvider::Set(new wxSimpleHelpProvider);
 

-    return TRUE;
+    return true;

 }
 
 void wxHelpProviderModule::OnExit()
 }
 
 void wxHelpProviderModule::OnExit()