src/html/helpctrl.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpctrl.cpp
   3 // Purpose:     wxHtmlHelpController
   4 // Notes:       Based on htmlhelp.cpp, implementing a monolithic
   5 //              HTML Help controller class,  by Vaclav Slavik
   6 // Author:      Harm van der Heijden and Vaclav Slavik
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Harm van der Heijden and Vaclav Slavik
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  13 #pragma implementation "helpctrl.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20 #pragma hdrstop
  21 #endif
  22
  23 #if wxUSE_WXHTML_HELP
  24
  25 #ifndef WX_PRECOMP
  26     #include "wx/app.h"
  27     #include "wx/intl.h"
  28 #endif // WX_PRECOMP
  29
  30 #include "wx/html/helpctrl.h"
  31 #include "wx/busyinfo.h"
  32
  33 #ifdef __WXGTK__
  34     // for the hack in AddGrabIfNeeded()
  35     #include "wx/dialog.h"
  36 #endif // __WXGTK__
  37
  38 #if wxUSE_HELP
  39     #include "wx/tipwin.h"
  40 #endif
  41
  42
  43 #if wxUSE_LIBMSPACK
  44 #include "wx/html/forcelnk.h"
  45 FORCE_LINK(wxhtml_chm_support)
  46 #endif
  47
  48 IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpController, wxHelpControllerBase)
  49
  50 wxHtmlHelpController::wxHtmlHelpController(int style)
  51 {
  52     m_helpFrame = NULL;
  53     m_Config = NULL;
  54     m_ConfigRoot = wxEmptyString;
  55     m_titleFormat = _("Help: %s");
  56     m_FrameStyle = style;
  57 }
  58
  59 wxHtmlHelpController::~wxHtmlHelpController()
  60 {
  61     if (m_Config)
  62         WriteCustomization(m_Config, m_ConfigRoot);
  63     if (m_helpFrame)
  64         DestroyHelpWindow();
  65 }
  66
  67
  68 void wxHtmlHelpController::DestroyHelpWindow()
  69 {
  70     //if (m_Config) WriteCustomization(m_Config, m_ConfigRoot);
  71     if (m_helpFrame)
  72         m_helpFrame->Destroy();
  73 }
  74
  75 void wxHtmlHelpController::OnCloseFrame(wxCloseEvent& evt)
  76 {
  77     evt.Skip();
  78
  79     OnQuit();
  80
  81     m_helpFrame->SetController((wxHelpControllerBase*) NULL);
  82     m_helpFrame = NULL;
  83 }
  84
  85 void wxHtmlHelpController::SetTitleFormat(const wxString& title)
  86 {
  87     m_titleFormat = title;
  88     if (m_helpFrame)
  89         m_helpFrame->SetTitleFormat(title);
  90 }
  91
  92
  93 bool wxHtmlHelpController::AddBook(const wxFileName& book_file, bool show_wait_msg)
  94 {
  95     return AddBook(wxFileSystem::FileNameToURL(book_file), show_wait_msg);
  96 }
  97
  98 bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg)
  99 {
 100     wxBusyCursor cur;
 101 #if wxUSE_BUSYINFO
 102     wxBusyInfo* busy = NULL;
 103     wxString info;
 104     if (show_wait_msg)
 105     {
 106         info.Printf(_("Adding book %s"), book.c_str());
 107         busy = new wxBusyInfo(info);
 108     }
 109 #endif
 110     bool retval = m_helpData.AddBook(book);
 111 #if wxUSE_BUSYINFO
 112     if (show_wait_msg)
 113         delete busy;
 114 #endif
 115     if (m_helpFrame)
 116         m_helpFrame->RefreshLists();
 117     return retval;
 118 }
 119
 120
 121
 122 wxHtmlHelpFrame *wxHtmlHelpController::CreateHelpFrame(wxHtmlHelpData *data)
 123 {
 124     return new wxHtmlHelpFrame(data);
 125 }
 126
 127
 128 void wxHtmlHelpController::CreateHelpWindow()
 129 {
 130     if (m_helpFrame)
 131     {
 132         m_helpFrame->Raise();
 133         return ;
 134     }
 135
 136     if (m_Config == NULL)
 137     {
 138         m_Config = wxConfigBase::Get(FALSE);
 139         if (m_Config != NULL)
 140             m_ConfigRoot = _T("wxWidgets/wxHtmlHelpController");
 141     }
 142
 143     m_helpFrame = CreateHelpFrame(&m_helpData);
 144     m_helpFrame->SetController(this);
 145
 146     if (m_Config)
 147         m_helpFrame->UseConfig(m_Config, m_ConfigRoot);
 148
 149     m_helpFrame->Create(NULL, wxID_HTML_HELPFRAME, wxEmptyString, m_FrameStyle);
 150     m_helpFrame->SetTitleFormat(m_titleFormat);
 151
 152     m_helpFrame->Show(TRUE);
 153 }
 154
 155 void wxHtmlHelpController::ReadCustomization(wxConfigBase* cfg, const wxString& path)
 156 {
 157     /* should not be called by the user; call UseConfig, and the controller
 158      * will do the rest */
 159     if (m_helpFrame && cfg)
 160         m_helpFrame->ReadCustomization(cfg, path);
 161 }
 162
 163 void wxHtmlHelpController::WriteCustomization(wxConfigBase* cfg, const wxString& path)
 164 {
 165     /* typically called by the controllers OnCloseFrame handler */
 166     if (m_helpFrame && cfg)
 167         m_helpFrame->WriteCustomization(cfg, path);
 168 }
 169
 170 void wxHtmlHelpController::UseConfig(wxConfigBase *config, const wxString& rootpath)
 171 {
 172     m_Config = config;
 173     m_ConfigRoot = rootpath;
 174     if (m_helpFrame) m_helpFrame->UseConfig(config, rootpath);
 175     ReadCustomization(config, rootpath);
 176 }
 177
 178 //// Backward compatibility with wxHelpController API
 179
 180 bool wxHtmlHelpController::Initialize(const wxString& file)
 181 {
 182     wxString dir, filename, ext;
 183     wxSplitPath(file, & dir, & filename, & ext);
 184
 185     if (!dir.IsEmpty())
 186         dir = dir + wxFILE_SEP_PATH;
 187
 188     // Try to find a suitable file
 189     wxString actualFilename = dir + filename + wxString(wxT(".zip"));
 190     if (!wxFileExists(actualFilename))
 191     {
 192         actualFilename = dir + filename + wxString(wxT(".htb"));
 193         if (!wxFileExists(actualFilename))
 194         {
 195             actualFilename = dir + filename + wxString(wxT(".hhp"));
 196             if (!wxFileExists(actualFilename))
 197             {
 198 #if wxUSE_LIBMSPACK
 199                 actualFilename = dir + filename + wxString(wxT(".chm"));
 200                 if (!wxFileExists(actualFilename))
 201 #endif
 202                     return false;
 203             }
 204         }
 205     }
 206     return AddBook(wxFileName(actualFilename));
 207 }
 208
 209 bool wxHtmlHelpController::LoadFile(const wxString& WXUNUSED(file))
 210 {
 211     // Don't reload the file or we'll have it appear again, presumably.
 212     return TRUE;
 213 }
 214
 215 bool wxHtmlHelpController::DisplaySection(int sectionNo)
 216 {
 217     return Display(sectionNo);
 218 }
 219
 220 bool wxHtmlHelpController::DisplayTextPopup(const wxString& text, const wxPoint& WXUNUSED(pos))
 221 {
 222 #if wxUSE_TIPWINDOW
 223     static wxTipWindow* s_tipWindow = NULL;
 224
 225     if (s_tipWindow)
 226     {
 227         // Prevent s_tipWindow being nulled in OnIdle,
 228         // thereby removing the chance for the window to be closed by ShowHelp
 229         s_tipWindow->SetTipWindowPtr(NULL);
 230         s_tipWindow->Close();
 231     }
 232     s_tipWindow = NULL;
 233
 234     if ( !text.empty() )
 235     {
 236         s_tipWindow = new wxTipWindow(wxTheApp->GetTopWindow(), text, 100, & s_tipWindow);
 237
 238         return TRUE;
 239     }
 240 #endif // wxUSE_TIPWINDOW
 241
 242     return FALSE;
 243 }
 244
 245 void wxHtmlHelpController::SetFrameParameters(const wxString& title,
 246                                    const wxSize& size,
 247                                    const wxPoint& pos,
 248                                    bool WXUNUSED(newFrameEachTime))
 249 {
 250     SetTitleFormat(title);
 251     if (m_helpFrame)
 252     {
 253         m_helpFrame->SetSize(pos.x, pos.y, size.x, size.y);
 254     }
 255 }
 256
 257 wxFrame* wxHtmlHelpController::GetFrameParameters(wxSize *size,
 258                                    wxPoint *pos,
 259                                    bool *newFrameEachTime)
 260 {
 261     if (newFrameEachTime)
 262         (* newFrameEachTime) = FALSE;
 263     if (size && m_helpFrame)
 264         (* size) = m_helpFrame->GetSize();
 265     if (pos && m_helpFrame)
 266         (* pos) = m_helpFrame->GetPosition();
 267     return m_helpFrame;
 268 }
 269
 270 bool wxHtmlHelpController::Quit()
 271 {
 272     DestroyHelpWindow();
 273     return TRUE;
 274 }
 275
 276 // Make the help controller's frame 'modal' if
 277 // needed
 278 void wxHtmlHelpController::AddGrabIfNeeded()
 279 {
 280     // So far, wxGTK only
 281 #ifdef __WXGTK__
 282     bool needGrab = FALSE;
 283
 284     // Check if there are any modal windows present,
 285     // in which case we need to add a grab.
 286     for ( wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst();
 287           node;
 288           node = node->GetNext() )
 289     {
 290         wxWindow *win = node->GetData();
 291         wxDialog *dialog = wxDynamicCast(win, wxDialog);
 292
 293         if (dialog && dialog->IsModal())
 294             needGrab = TRUE;
 295     }
 296
 297     if (needGrab && m_helpFrame)
 298         m_helpFrame->AddGrab();
 299 #endif // __WXGTK__
 300 }
 301
 302 bool wxHtmlHelpController::Display(const wxString& x)
 303 {
 304     CreateHelpWindow();
 305     bool success = m_helpFrame->Display(x);
 306     AddGrabIfNeeded();
 307     return success;
 308 }
 309
 310 bool wxHtmlHelpController::Display(int id)
 311 {
 312     CreateHelpWindow();
 313     bool success = m_helpFrame->Display(id);
 314     AddGrabIfNeeded();
 315     return success;
 316 }
 317
 318 bool wxHtmlHelpController::DisplayContents()
 319 {
 320     CreateHelpWindow();
 321     bool success = m_helpFrame->DisplayContents();
 322     AddGrabIfNeeded();
 323     return success;
 324 }
 325
 326 bool wxHtmlHelpController::DisplayIndex()
 327 {
 328     CreateHelpWindow();
 329     bool success = m_helpFrame->DisplayIndex();
 330     AddGrabIfNeeded();
 331     return success;
 332 }
 333
 334 bool wxHtmlHelpController::KeywordSearch(const wxString& keyword,
 335                                          wxHelpSearchMode mode)
 336 {
 337     CreateHelpWindow();
 338     bool success = m_helpFrame->KeywordSearch(keyword, mode);
 339     AddGrabIfNeeded();
 340     return success;
 341 }
 342
 343 #endif // wxUSE_WXHTML_HELP
 344