generate key events for Space/Enter in addition to the activate events, as wxMSW...

[wxWidgets.git] / src / html / helpctrl.cpp

diff --git a/src/html/helpctrl.cpp b/src/html/helpctrl.cpp
index 6d6583db509a9465598925bd0c12334a9f3937ff..b55d11fcb9ddd2bf02aea489a645f709393e0bf8 100644 (file)
--- a/src/html/helpctrl.cpp
+++ b/src/html/helpctrl.cpp
@@ -10,7 +10,7 @@
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
-#pragma implementation
+#pragma implementation "helpctrl.h"
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
@@ -20,22 +20,27 @@
 #pragma hdrstop
 #endif
 
-#include "wx/defs.h"
+#if wxUSE_WXHTML_HELP
 
-#if wxUSE_HTML
+#ifndef WX_PRECOMP
+    #include "wx/app.h"
+    #include "wx/intl.h"
+#endif // WX_PRECOMP
 
 #include "wx/html/helpctrl.h"
-#include "wx/wx.h"
 #include "wx/busyinfo.h"
 
-IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpController, wxHelpControllerBase)
+#ifdef __WXGTK__
+    // for the hack in AddGrabIfNeeded()
+    #include "wx/dialog.h"
+#endif // __WXGTK__
 
-#if 0
-BEGIN_EVENT_TABLE(wxHtmlHelpController, wxEvtHandler)
-EVT_CLOSE(wxHtmlHelpController::OnCloseFrame)
-END_EVENT_TABLE()
+#if wxUSE_HELP
+    #include "wx/tipwin.h"
 #endif
 
+IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpController, wxHelpControllerBase)
+
 wxHtmlHelpController::wxHtmlHelpController(int style)
 {
     m_helpFrame = NULL;
@@ -47,7 +52,8 @@ wxHtmlHelpController::wxHtmlHelpController(int style)
 
 wxHtmlHelpController::~wxHtmlHelpController()
 {
-    WriteCustomization(m_Config, m_ConfigRoot);
+    if (m_Config)
+        WriteCustomization(m_Config, m_ConfigRoot);
     if (m_helpFrame)
         DestroyHelpWindow();
 }
@@ -84,7 +90,8 @@ bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg)
 #if wxUSE_BUSYINFO
     wxBusyInfo* busy = NULL;
     wxString info;
-    if (show_wait_msg) {
+    if (show_wait_msg)
+    {
         info.Printf(_("Adding book %s"), book.c_str());
         busy = new wxBusyInfo(info);
     }
@@ -93,7 +100,9 @@ bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg)
 #if wxUSE_BUSYINFO
     if (show_wait_msg)
         delete busy;
-#endif 
+#endif
+    if (m_helpFrame) 
+        m_helpFrame->RefreshLists();
     return retval;
 }
 
@@ -107,12 +116,13 @@ wxHtmlHelpFrame *wxHtmlHelpController::CreateHelpFrame(wxHtmlHelpData *data)
 
 void wxHtmlHelpController::CreateHelpWindow()
 {
-    if (m_helpFrame) {
+    if (m_helpFrame)
+    {
         m_helpFrame->Raise();
         return ;
     }
 
-    if (m_Config == NULL) 
+    if (m_Config == NULL)
     {
         m_Config = wxConfigBase::Get(FALSE);
         if (m_Config != NULL)
@@ -121,7 +131,6 @@ void wxHtmlHelpController::CreateHelpWindow()
 
     m_helpFrame = CreateHelpFrame(&m_helpData);
     m_helpFrame->SetController(this);
-//    m_helpFrame->PushEventHandler(this);
 
     if (m_Config)
         m_helpFrame->UseConfig(m_Config, m_ConfigRoot);
@@ -135,14 +144,14 @@ void wxHtmlHelpController::ReadCustomization(wxConfigBase* cfg, const wxString&
 {
     /* should not be called by the user; call UseConfig, and the controller
      * will do the rest */
-    if (m_helpFrame)
+    if (m_helpFrame && cfg)
         m_helpFrame->ReadCustomization(cfg, path);
 }
 
 void wxHtmlHelpController::WriteCustomization(wxConfigBase* cfg, const wxString& path)
 {
     /* typically called by the controllers OnCloseFrame handler */
-    if (m_helpFrame)
+    if (m_helpFrame && cfg)
         m_helpFrame->WriteCustomization(cfg, path);
 }
 
@@ -150,7 +159,7 @@ void wxHtmlHelpController::UseConfig(wxConfigBase *config, const wxString& rootp
 {
     m_Config = config;
     m_ConfigRoot = rootpath;
-    if (m_helpFrame) m_helpFrame -> UseConfig(config, rootpath);
+    if (m_helpFrame) m_helpFrame->UseConfig(config, rootpath);
     ReadCustomization(config, rootpath);
 }
 
@@ -162,16 +171,16 @@ bool wxHtmlHelpController::Initialize(const wxString& file)
     wxSplitPath(file, & dir, & filename, & ext);
 
     if (!dir.IsEmpty())
-        dir = dir + wxString(_("/"));
+        dir = dir + wxString(wxT("/"));
 
     // Try to find a suitable file
-    wxString actualFilename = dir + filename + wxString(_(".zip"));
+    wxString actualFilename = dir + filename + wxString(wxT(".zip"));
     if (!wxFileExists(actualFilename))
     {
-        actualFilename = dir + filename + wxString(_(".htb"));
+        actualFilename = dir + filename + wxString(wxT(".htb"));
         if (!wxFileExists(actualFilename))
         {
-            actualFilename = dir + filename + wxString(_(".hhp"));
+            actualFilename = dir + filename + wxString(wxT(".hhp"));
             if (!wxFileExists(actualFilename))
                 return FALSE;
         }
@@ -191,6 +200,31 @@ bool wxHtmlHelpController::DisplaySection(int sectionNo)
     return Display(sectionNo);
 }
 
+bool wxHtmlHelpController::DisplayTextPopup(const wxString& text, const wxPoint& WXUNUSED(pos))
+{
+#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 = NULL;
+
+    if ( !text.empty() )
+    {
+        s_tipWindow = new wxTipWindow(wxTheApp->GetTopWindow(), text, 100, & s_tipWindow);
+
+        return TRUE;
+    }
+#endif // wxUSE_TIPWINDOW
+
+    return FALSE;
+}
+
 void wxHtmlHelpController::SetFrameParameters(const wxString& title,
                                    const wxSize& size,
                                    const wxPoint& pos,
@@ -222,5 +256,71 @@ bool wxHtmlHelpController::Quit()
     return TRUE;
 }
 
+// Make the help controller's frame 'modal' if
+// needed
+void wxHtmlHelpController::AddGrabIfNeeded()
+{
+    // So far, wxGTK only
+#ifdef __WXGTK__
+    bool needGrab = FALSE;
+    
+    // Check if there are any modal windows present,
+    // in which case we need to add a grab.
+    for ( wxWindowList::Node * node = wxTopLevelWindows.GetFirst();
+          node;
+          node = node->GetNext() )
+    {
+        wxWindow *win = node->GetData();
+        wxDialog *dialog = wxDynamicCast(win, wxDialog);
+
+        if (dialog && dialog->IsModal())
+            needGrab = TRUE;
+    }
+
+    if (needGrab && m_helpFrame)
+        m_helpFrame->AddGrab();
+#endif // __WXGTK__
+}
+
+bool wxHtmlHelpController::Display(const wxString& x)
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->Display(x);
+    AddGrabIfNeeded();
+    return success;    
+}
+
+bool wxHtmlHelpController::Display(int id)
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->Display(id);
+    AddGrabIfNeeded();
+    return success;
+}
+
+bool wxHtmlHelpController::DisplayContents()
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->DisplayContents();
+    AddGrabIfNeeded();
+    return success;
+}
+
+bool wxHtmlHelpController::DisplayIndex()
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->DisplayIndex();
+    AddGrabIfNeeded();
+    return success;
+}
+
+bool wxHtmlHelpController::KeywordSearch(const wxString& keyword)
+{
+    CreateHelpWindow();
+    bool success = m_helpFrame->KeywordSearch(keyword);
+    AddGrabIfNeeded();
+    return success;
+}
+
+#endif // wxUSE_WXHTML_HELP
 
-#endif