X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e81910e077529af6905429942dc3761a69255687..7dbe942aaaa9a8f32c9f901bdcf83d7941362b71:/src/html/helpctrl.cpp diff --git a/src/html/helpctrl.cpp b/src/html/helpctrl.cpp index af0ba923d8..c52512ab36 100644 --- a/src/html/helpctrl.cpp +++ b/src/html/helpctrl.cpp @@ -9,10 +9,6 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -20,23 +16,35 @@ #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 wxUSE_HELP + #include "wx/tipwin.h" +#endif + -#if 0 -BEGIN_EVENT_TABLE(wxHtmlHelpController, wxEvtHandler) -EVT_CLOSE(wxHtmlHelpController::OnCloseFrame) -END_EVENT_TABLE() +#if wxUSE_LIBMSPACK +#include "wx/html/forcelnk.h" +FORCE_LINK(wxhtml_chm_support) #endif -wxHtmlHelpController::wxHtmlHelpController(int style) +IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpController, wxHelpControllerBase) + +wxHtmlHelpController::wxHtmlHelpController(int style, wxWindow* parentWindow): + wxHelpControllerBase(parentWindow) { m_helpFrame = NULL; m_Config = NULL; @@ -47,7 +55,8 @@ wxHtmlHelpController::wxHtmlHelpController(int style) wxHtmlHelpController::~wxHtmlHelpController() { - WriteCustomization(m_Config, m_ConfigRoot); + if (m_Config) + WriteCustomization(m_Config, m_ConfigRoot); if (m_helpFrame) DestroyHelpWindow(); } @@ -78,13 +87,19 @@ void wxHtmlHelpController::SetTitleFormat(const wxString& title) } +bool wxHtmlHelpController::AddBook(const wxFileName& book_file, bool show_wait_msg) +{ + return AddBook(wxFileSystem::FileNameToURL(book_file), show_wait_msg); +} + bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg) { wxBusyCursor cur; #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 +108,11 @@ bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg) #if wxUSE_BUSYINFO if (show_wait_msg) delete busy; -#endif +#else + wxUnusedVar(show_wait_msg); +#endif + if (m_helpFrame) + m_helpFrame->RefreshLists(); return retval; } @@ -107,42 +126,43 @@ 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); + m_Config = wxConfigBase::Get(false); if (m_Config != NULL) m_ConfigRoot = _T("wxWindows/wxHtmlHelpController"); } m_helpFrame = CreateHelpFrame(&m_helpData); m_helpFrame->SetController(this); -// m_helpFrame->PushEventHandler(this); if (m_Config) m_helpFrame->UseConfig(m_Config, m_ConfigRoot); - m_helpFrame->Create(NULL, wxID_HTML_HELPFRAME, wxEmptyString, m_FrameStyle); + m_helpFrame->Create(GetParentWindow(), wxID_HTML_HELPFRAME, wxEmptyString, m_FrameStyle); m_helpFrame->SetTitleFormat(m_titleFormat); - m_helpFrame->Show(TRUE); + + m_helpFrame->Show(true); } void wxHtmlHelpController::ReadCustomization(wxConfigBase* cfg, const wxString& path) { /* 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 +170,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); } @@ -161,8 +181,8 @@ bool wxHtmlHelpController::Initialize(const wxString& file) wxString dir, filename, ext; wxSplitPath(file, & dir, & filename, & ext); - if (!dir.IsEmpty()) - dir = dir + wxString(wxT("/")); + if (!dir.empty()) + dir = dir + wxFILE_SEP_PATH; // Try to find a suitable file wxString actualFilename = dir + filename + wxString(wxT(".zip")); @@ -173,17 +193,22 @@ bool wxHtmlHelpController::Initialize(const wxString& file) { actualFilename = dir + filename + wxString(wxT(".hhp")); if (!wxFileExists(actualFilename)) - return FALSE; + { +#if wxUSE_LIBMSPACK + actualFilename = dir + filename + wxString(wxT(".chm")); + if (!wxFileExists(actualFilename)) +#endif + return false; + } } } - - return AddBook(actualFilename); + return AddBook(wxFileName(actualFilename)); } bool wxHtmlHelpController::LoadFile(const wxString& WXUNUSED(file)) { // Don't reload the file or we'll have it appear again, presumably. - return TRUE; + return true; } bool wxHtmlHelpController::DisplaySection(int sectionNo) @@ -191,6 +216,33 @@ 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; + } +#else + wxUnusedVar(text); +#endif // wxUSE_TIPWINDOW + + return false; +} + void wxHtmlHelpController::SetFrameParameters(const wxString& title, const wxSize& size, const wxPoint& pos, @@ -208,7 +260,7 @@ wxFrame* wxHtmlHelpController::GetFrameParameters(wxSize *size, bool *newFrameEachTime) { if (newFrameEachTime) - (* newFrameEachTime) = FALSE; + (* newFrameEachTime) = false; if (size && m_helpFrame) (* size) = m_helpFrame->GetSize(); if (pos && m_helpFrame) @@ -219,8 +271,75 @@ wxFrame* wxHtmlHelpController::GetFrameParameters(wxSize *size, bool wxHtmlHelpController::Quit() { DestroyHelpWindow(); - return TRUE; + 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::compatibility_iterator 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, + wxHelpSearchMode mode) +{ + CreateHelpWindow(); + bool success = m_helpFrame->KeywordSearch(keyword, mode); + AddGrabIfNeeded(); + return success; +} + +#endif // wxUSE_WXHTML_HELP -#endif