mention wx[Flex]GridSizer too

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

diff --git a/src/common/cshelp.cpp b/src/common/cshelp.cpp
index cc59931d9cadb191bb2d18bb7969999ce92a2fd0..cb9a8d895fabc48e7d9db76b4f999c16d5b46a98 100644 (file)
--- a/src/common/cshelp.cpp
+++ b/src/common/cshelp.cpp
@@ -1,41 +1,49 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        cshelp.cpp
+// Name:        src/common/cshelp.cpp

 // Purpose:     Context sensitive help class implementation
 // Purpose:     Context sensitive help class implementation

-// Author:      Julian Smart
+// Author:      Julian Smart, Vadim Zeitlin

 // Modified by:
 // Created:     08/09/2000
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     08/09/2000
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart
+// Copyright:   (c) 2000 Julian Smart, Vadim Zeitlin

 // Licence:    wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:    wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================
+

 #ifdef __GNUG__
 #ifdef __GNUG__

-#pragma implementation "cshelp.h"
+    #pragma implementation "cshelp.h"

 #endif
 
 #endif
 

+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_HELP
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

-#include "wx/defs.h"

 #endif
 
 #endif
 

+#include "wx/tipwin.h"

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

-
-#if wxUSE_HELP
-
+#include "wx/module.h"

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

-/*
- * Invokes context-sensitive help
- */
+// ----------------------------------------------------------------------------
+// wxContextHelpEvtHandler private class
+// ----------------------------------------------------------------------------

 
 

-// This class exists in order to eat events until the left mouse
-// button is pressed
+// This class exists in order to eat events until the left mouse button is
+// pressed

 class wxContextHelpEvtHandler: public wxEvtHandler
 {
 public:
 class wxContextHelpEvtHandler: public wxEvtHandler
 {
 public:


@@ -50,6 +58,19 @@ public:
     wxContextHelp* m_contextHelp;
 };
 
     wxContextHelp* m_contextHelp;
 };
 

+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxContextHelp
+// ----------------------------------------------------------------------------
+
+/*
+ * Invokes context-sensitive help
+ */
+
+

 IMPLEMENT_DYNAMIC_CLASS(wxContextHelp, wxObject)
 
 wxContextHelp::wxContextHelp(wxWindow* win, bool beginHelp)
 IMPLEMENT_DYNAMIC_CLASS(wxContextHelp, wxObject)
 
 wxContextHelp::wxContextHelp(wxWindow* win, bool beginHelp)


@@ -98,6 +119,15 @@ bool wxContextHelp::BeginContextHelp(wxWindow* win)
     {
         wxPoint pt;
         wxWindow* winAtPtr = wxFindWindowAtPointer(pt);
     {
         wxPoint pt;
         wxWindow* winAtPtr = wxFindWindowAtPointer(pt);

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

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


@@ -131,33 +161,28 @@ bool wxContextHelp::EventLoop()
 
 bool wxContextHelpEvtHandler::ProcessEvent(wxEvent& event)
 {
 
 bool wxContextHelpEvtHandler::ProcessEvent(wxEvent& event)
 {

-    switch (event.GetEventType())
+    if (event.GetEventType() == wxEVT_LEFT_DOWN)

     {
     {

-        case wxEVT_LEFT_DOWN:
-        {
-         //wxMouseEvent& mouseEvent = (wxMouseEvent&) event;
-            m_contextHelp->SetStatus(TRUE);
-            m_contextHelp->EndContextHelp();
-            return TRUE;
-            break;
-        }
-        case wxEVT_CHAR:
-        case wxEVT_KEY_DOWN:
-        case wxEVT_ACTIVATE:
-        case wxEVT_MOUSE_CAPTURE_CHANGED:
-        {
-            m_contextHelp->SetStatus(FALSE);
-            m_contextHelp->EndContextHelp();
-            return TRUE;
-            break;
-        }
-        case wxEVT_PAINT:
-        case wxEVT_ERASE_BACKGROUND:
-        {
-            event.Skip();
-            return FALSE;
-            break;
-        }
+        m_contextHelp->SetStatus(TRUE);
+        m_contextHelp->EndContextHelp();
+        return TRUE;
+    }
+
+    if ((event.GetEventType() == wxEVT_CHAR) ||
+        (event.GetEventType() == wxEVT_KEY_DOWN) ||
+        (event.GetEventType() == wxEVT_ACTIVATE) ||
+        (event.GetEventType() == wxEVT_MOUSE_CAPTURE_CHANGED))
+    {
+        m_contextHelp->SetStatus(FALSE);
+        m_contextHelp->EndContextHelp();
+        return TRUE;
+    }
+
+    if ((event.GetEventType() == wxEVT_PAINT) ||
+        (event.GetEventType() == wxEVT_ERASE_BACKGROUND))
+    {
+        event.Skip();
+        return FALSE;

     }
 
     return TRUE;
     }
 
     return TRUE;


@@ -173,7 +198,7 @@ bool wxContextHelp::DispatchEvent(wxWindow* win, const wxPoint& pt)
         wxHelpEvent helpEvent(wxEVT_HELP, subjectOfHelp->GetId(), pt) ;
         helpEvent.SetEventObject(this);
         eventProcessed = win->GetEventHandler()->ProcessEvent(helpEvent);
         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.
         // 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.


@@ -182,6 +207,10 @@ bool wxContextHelp::DispatchEvent(wxWindow* win, const wxPoint& pt)
     return eventProcessed;
 }
 
     return eventProcessed;
 }
 

+// ----------------------------------------------------------------------------
+// wxContextHelpButton
+// ----------------------------------------------------------------------------
+

 /*
  * wxContextHelpButton
  * You can add this to your dialogs (especially on non-Windows platforms)
 /*
  * wxContextHelpButton
  * You can add this to your dialogs (especially on non-Windows platforms)


@@ -222,9 +251,156 @@ wxContextHelpButton::wxContextHelpButton(wxWindow* parent,
 {
 }
 
 {
 }
 

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

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

+// ----------------------------------------------------------------------------
+// wxHelpProvider
+// ----------------------------------------------------------------------------
+
+wxHelpProvider *wxHelpProvider::ms_helpProvider = (wxHelpProvider *)NULL;
+
+// trivial implementation of some methods which we don't want to make pure
+// virtual for convenience
+
+void wxHelpProvider::AddHelp(wxWindowBase * WXUNUSED(window),
+                             const wxString& WXUNUSED(text))
+{
+}
+
+void wxHelpProvider::AddHelp(wxWindowID WXUNUSED(id),
+                             const wxString& WXUNUSED(text))
+{
+}
+
+wxHelpProvider::~wxHelpProvider()
+{
+}
+
+// ----------------------------------------------------------------------------
+// wxSimpleHelpProvider
+// ----------------------------------------------------------------------------
+
+wxString wxSimpleHelpProvider::GetHelp(const wxWindowBase *window)
+{
+    bool wasFound;
+    wxString text = m_hashWindows.Get((long)window, &wasFound);
+    if ( !wasFound )
+        text = m_hashIds.Get(window->GetId());
+
+    return text;
+}
+
+void wxSimpleHelpProvider::AddHelp(wxWindowBase *window, const wxString& text)
+{
+    m_hashWindows.Put((long)window, text);
+}
+
+void wxSimpleHelpProvider::AddHelp(wxWindowID id, const wxString& text)
+{
+    m_hashIds.Put(id, text);
+}
+
+bool wxSimpleHelpProvider::ShowHelp(wxWindowBase *window)
+{
+    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 = NULL;
+
+    wxString text = GetHelp(window);
+    if ( !text.empty() )
+    {
+        s_tipWindow = new wxTipWindow((wxWindow *)window, text, 100, & s_tipWindow);
+
+        return TRUE;
+    }
+
+    return FALSE;
+}
+
+// ----------------------------------------------------------------------------
+// wxHelpControllerHelpProvider
+// ----------------------------------------------------------------------------
+
+wxHelpControllerHelpProvider::wxHelpControllerHelpProvider(wxHelpControllerBase* hc)
+{
+    m_helpController = hc;
+}
+
+bool wxHelpControllerHelpProvider::ShowHelp(wxWindowBase *window)
+{
+    wxString text = GetHelp(window);
+    if ( !text.empty() )
+    {
+        if (m_helpController)
+        {
+            if (text.IsNumber())
+                return m_helpController->DisplayContextPopup(wxAtoi(text));
+
+            // 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);
+
+    }
+
+    return FALSE;
+}
+
+// Convenience function for turning context id into wxString
+wxString wxContextId(int id)
+{
+    return wxString(IntToString(id));
+}
+
+// ----------------------------------------------------------------------------
+// wxHelpProviderModule: module responsible for cleaning up help provider.
+// ----------------------------------------------------------------------------
+
+class wxHelpProviderModule : public wxModule
+{
+public:
+    bool OnInit();
+    void OnExit();
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxHelpProviderModule)
+};
+
+IMPLEMENT_DYNAMIC_CLASS(wxHelpProviderModule, wxModule)
+
+bool wxHelpProviderModule::OnInit()
+{
+    // Probably we don't want to do anything by default,
+    // since it could pull in extra code
+    // wxHelpProvider::Set(new wxSimpleHelpProvider);
+
+    return TRUE;
+}
+
+void wxHelpProviderModule::OnExit()
+{
+    if (wxHelpProvider::Get())
+    {
+        delete wxHelpProvider::Get();
+        wxHelpProvider::Set(NULL);
+    }
+}
+

 #endif // wxUSE_HELP
 #endif // wxUSE_HELP