include/wx/html/helpctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpctrl.h
   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 #ifndef _WX_HELPCTRL_H_
  13 #define _WX_HELPCTRL_H_
  14
  15 #include "wx/defs.h"
  16
  17 #ifdef __GNUG__
  18 #pragma interface
  19 #endif
  20
  21 #if wxUSE_HTML
  22
  23 #include "wx/html/helpfrm.h"
  24 #include "wx/helpbase.h"
  25
  26 class WXDLLEXPORT wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler
  27 {
  28         DECLARE_DYNAMIC_CLASS(wxHtmlHelpController)
  29
  30     public:
  31         wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE);
  32         virtual ~wxHtmlHelpController();
  33
  34         void SetTitleFormat(const wxString& format);
  35         void SetTempDir(const wxString& path) { m_helpData.SetTempDir(path); }
  36         bool AddBook(const wxString& book, bool show_wait_msg = FALSE);
  37         bool Display(const wxString& x)
  38         {
  39             CreateHelpWindow(); return m_helpFrame->Display(x);
  40         }
  41         bool Display(int id)
  42         {
  43             CreateHelpWindow(); return m_helpFrame->Display(id);
  44         }
  45         bool DisplayContents()
  46         {
  47             CreateHelpWindow(); return m_helpFrame->DisplayContents();
  48         }
  49         bool DisplayIndex()
  50         {
  51             CreateHelpWindow(); return m_helpFrame->DisplayIndex();
  52         }
  53         bool KeywordSearch(const wxString& keyword)
  54         {
  55             CreateHelpWindow(); return m_helpFrame->KeywordSearch(keyword);
  56         }
  57         wxHtmlHelpFrame* GetFrame() { return m_helpFrame; }
  58         void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
  59
  60         // Assigns config object to the Ctrl. This config is then
  61         // used in subsequent calls to Read/WriteCustomization of both help
  62         // Ctrl and it's wxHtmlWindow
  63         virtual void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
  64         virtual void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
  65
  66         //// Backward compatibility with wxHelpController API
  67
  68         virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize(file); }
  69         virtual bool Initialize(const wxString& file);
  70         virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
  71         virtual bool LoadFile(const wxString& file = "");
  72         virtual bool DisplaySection(int sectionNo);
  73         virtual bool DisplaySection(const wxString& section) { return Display(section); }
  74         virtual bool DisplayBlock(long blockNo) { return DisplaySection(blockNo); }
  75         virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos);
  76
  77         virtual void SetFrameParameters(const wxString& title,
  78                                    const wxSize& size,
  79                                    const wxPoint& pos = wxDefaultPosition,
  80                                    bool newFrameEachTime = FALSE);
  81         /// Obtains the latest settings used by the help frame and the help
  82         /// frame.
  83         virtual wxFrame *GetFrameParameters(wxSize *size = NULL,
  84                                    wxPoint *pos = NULL,
  85                                    bool *newFrameEachTime = NULL);
  86
  87         // Sets the specified book or all books to have the given base path
  88         virtual void SetBookBasePath(const wxString& basePath, int which = -1);
  89
  90         virtual bool Quit() ;
  91         virtual void OnQuit() {};
  92
  93         void OnCloseFrame(wxCloseEvent& evt);
  94     protected:
  95         virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data);
  96
  97         virtual void CreateHelpWindow();
  98         virtual void DestroyHelpWindow();
  99
 100         wxHtmlHelpData      m_helpData;
 101         wxHtmlHelpFrame*    m_helpFrame;
 102         wxConfigBase *      m_Config;
 103         wxString            m_ConfigRoot;
 104         wxString            m_titleFormat;
 105         int                 m_FrameStyle;
 106         // DECLARE_EVENT_TABLE()
 107 };
 108
 109 #endif
 110
 111 #endif // _WX_HELPCTRL_H_