X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/16a12a3d27d3d3e2557bcde15365245ef2675bb4..65676a2882da289289c22a2810d92e56f7b9449c:/include/wx/html/helpfrm.h diff --git a/include/wx/html/helpfrm.h b/include/wx/html/helpfrm.h index b523856ce9..bac1a1a778 100644 --- a/include/wx/html/helpfrm.h +++ b/include/wx/html/helpfrm.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: helpfrm.h +// Name: wx/html/helpfrm.h // Purpose: wxHtmlHelpFrame // Notes: Based on htmlhelp.cpp, implementing a monolithic // HTML Help controller class, by Vaclav Slavik @@ -12,14 +12,11 @@ #ifndef _WX_HELPFRM_H_ #define _WX_HELPFRM_H_ -#ifdef __GNUG__ -#pragma interface -#endif - #include "wx/defs.h" -#if wxUSE_HTML +#if wxUSE_WXHTML_HELP +#include "wx/helpbase.h" #include "wx/html/helpdata.h" #include "wx/window.h" #include "wx/frame.h" @@ -28,156 +25,134 @@ #include "wx/notebook.h" #include "wx/listbox.h" #include "wx/choice.h" +#include "wx/combobox.h" +#include "wx/checkbox.h" +#include "wx/stattext.h" #include "wx/html/htmlwin.h" +#include "wx/html/helpwnd.h" +#include "wx/html/htmprint.h" -// style flags for the Help Frame -const int wxHF_TOOLBAR = 1; -const int wxHF_CONTENTS = 2; -const int wxHF_INDEX = 4; -const int wxHF_SEARCH = 8; -const int wxHF_DEFAULTSTYLE = -1; - -// Command IDs : -enum { - wxID_HTML_PANEL = wxID_HIGHEST + 1, - wxID_HTML_BACK, - wxID_HTML_FORWARD, - wxID_HTML_TREECTRL, - wxID_HTML_INDEXPAGE, - wxID_HTML_INDEXLIST, - wxID_HTML_NOTEBOOK, - wxID_HTML_SEARCHPAGE, - wxID_HTML_SEARCHTEXT, - wxID_HTML_SEARCHLIST, - wxID_HTML_SEARCHBUTTON, - wxID_HTML_SEARCHCHOICE, - wxID_HTML_HELPFRAME // the id of wxHtmlHelpController's helpframe -}; +class WXDLLIMPEXP_FWD_CORE wxButton; +class WXDLLIMPEXP_FWD_CORE wxTextCtrl; +class WXDLLIMPEXP_FWD_CORE wxTreeEvent; +class WXDLLIMPEXP_FWD_CORE wxTreeCtrl; -class WXDLLEXPORT wxHtmlHelpFrameCfg -{ -public: - wxHtmlHelpFrameCfg() {}; - long x, y, w, h; - long sashpos; - bool navig_on; - int style; // flags given to wxHtmlHelpFrame ctor - wxString titleformat; -}; -class WXDLLEXPORT wxHtmlHelpFrame : public wxFrame +// style flags for the Help Frame +#define wxHF_TOOLBAR 0x0001 +#define wxHF_CONTENTS 0x0002 +#define wxHF_INDEX 0x0004 +#define wxHF_SEARCH 0x0008 +#define wxHF_BOOKMARKS 0x0010 +#define wxHF_OPEN_FILES 0x0020 +#define wxHF_PRINT 0x0040 +#define wxHF_FLAT_TOOLBAR 0x0080 +#define wxHF_MERGE_BOOKS 0x0100 +#define wxHF_ICONS_BOOK 0x0200 +#define wxHF_ICONS_BOOK_CHAPTER 0x0400 +#define wxHF_ICONS_FOLDER 0x0000 // this is 0 since it is default +#define wxHF_DEFAULT_STYLE (wxHF_TOOLBAR | wxHF_CONTENTS | \ + wxHF_INDEX | wxHF_SEARCH | \ + wxHF_BOOKMARKS | wxHF_PRINT) +//compatibility: +#define wxHF_OPENFILES wxHF_OPEN_FILES +#define wxHF_FLATTOOLBAR wxHF_FLAT_TOOLBAR +#define wxHF_DEFAULTSTYLE wxHF_DEFAULT_STYLE + +struct wxHtmlHelpMergedIndexItem; +class wxHtmlHelpMergedIndex; + +class WXDLLIMPEXP_FWD_CORE wxHelpControllerBase; +class WXDLLIMPEXP_FWD_HTML wxHtmlHelpController; +class WXDLLIMPEXP_FWD_HTML wxHtmlHelpWindow; + +class WXDLLIMPEXP_HTML wxHtmlHelpFrame : public wxFrame { DECLARE_DYNAMIC_CLASS(wxHtmlHelpFrame) public: wxHtmlHelpFrame(wxHtmlHelpData* data = NULL) { Init(data); } - wxHtmlHelpFrame(wxWindow* parent, int wxWindowID, - const wxString& title = wxEmptyString, - int style = wxHF_DEFAULTSTYLE, wxHtmlHelpData* data = NULL); + wxHtmlHelpFrame(wxWindow* parent, wxWindowID wxWindowID, + const wxString& title = wxEmptyString, + int style = wxHF_DEFAULT_STYLE, wxHtmlHelpData* data = NULL +#if wxUSE_CONFIG + , wxConfigBase *config=NULL, const wxString& rootpath = wxEmptyString +#endif // wxUSE_CONFIG + ); bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxEmptyString, - int style = wxHF_DEFAULTSTYLE); - ~wxHtmlHelpFrame(); - + int style = wxHF_DEFAULT_STYLE +#if wxUSE_CONFIG + , wxConfigBase *config=NULL, const wxString& rootpath = wxEmptyString +#endif // wxUSE_CONFIG + ); + virtual ~wxHtmlHelpFrame(); + + /// Returns the data associated with the window. wxHtmlHelpData* GetData() { return m_Data; } - void SetTitleFormat(const wxString& format) { - if (m_HtmlWin) - m_HtmlWin->SetRelatedFrame(this, format); - m_TitleFormat = format; - } + /// Returns the help controller associated with the window. + wxHtmlHelpController* GetController() const { return m_helpController; } + + /// Sets the help controller associated with the window. + void SetController(wxHtmlHelpController* controller); + + /// Returns the help window. + wxHtmlHelpWindow* GetHelpWindow() const { return m_HtmlHelpWin; } + // Sets format of title of the frame. Must contain exactly one "%s" // (for title of displayed HTML page) + void SetTitleFormat(const wxString& format); + +#if wxUSE_CONFIG + // For compatibility + void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString); +#endif // wxUSE_CONFIG + + // Make the help controller's frame 'modal' if + // needed + void AddGrabIfNeeded(); + + // Override to add custom buttons to the toolbar + virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {} + + void SetShouldPreventAppExit(bool enable); + + // we don't want to prevent the app from closing just because a help window + // remains opened + virtual bool ShouldPreventAppExit() const { return m_shouldPreventAppExit; } + +protected: + void Init(wxHtmlHelpData* data = NULL); - bool Display(const wxString& x); - // Displays page x. If not found it will offect the user a choice of - // searching books. - // Looking for the page runs in these steps: - // 1. try to locate file named x (if x is for example "doc/howto.htm") - // 2. try to open starting page of book x - // 3. try to find x in contents (if x is for example "How To ...") - // 4. try to find x in index (if x is for example "How To ...") - bool Display(const int id); - // Alternative version that works with numeric ID. - // (uses extension to MS format, , see docs) - - bool DisplayContents(); - // Displays help window and focuses contents. - - bool DisplayIndex(); - // Displays help window and focuses index. - - bool KeywordSearch(const wxString& keyword); - // Searches for keyword. Returns TRUE and display page if found, return - // FALSE otherwise - // Syntax of keyword is Altavista-like: - // * words are separated by spaces - // (but "\"hello world\"" is only one world "hello world") - // * word may be pretended by + or - - // (+ : page must contain the word ; - : page can't contain the word) - // * if there is no + or - before the word, + is default - void RefreshLists(bool show_progress = FALSE); - // Refreshes Contents and Index tabs - void CreateContents(bool show_progress = FALSE); - // Adds items to m_Contents tree control - void CreateIndex(bool show_progress = FALSE); - // Adds items to m_IndexList - void CreateSearch(); - // Add books to search choice panel - void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString) { - m_Config = config; m_ConfigRoot = rootpath; - ReadCustomization(config, rootpath); - } - void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); - // saves custom settings into cfg config. it will use the path 'path' - // if given, otherwise it will save info into currently selected path. - // saved values : things set by SetFonts, SetBorders. - void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); - // ... - void OnToolbar(wxCommandEvent& event); - void OnContentsSel(wxTreeEvent& event); - void OnIndexSel(wxCommandEvent& event); - void OnSearchSel(wxCommandEvent& event); - void OnSearch(wxCommandEvent& event); void OnCloseWindow(wxCloseEvent& event); + void OnActivate(wxActivateEvent& event); + +#ifdef __WXMAC__ + void OnClose(wxCommandEvent& event); + void OnAbout(wxCommandEvent& event); +#endif // Images: enum { - IMG_Book = 0, - IMG_Folder, - IMG_Page + IMG_Book = 0, + IMG_Folder, + IMG_Page }; protected: wxHtmlHelpData* m_Data; - bool m_DataCreated; // m_Data created by frame, or supplied? - wxString m_TitleFormat; // title of the help frame - // below are various pointers to GUI components - wxHtmlWindow *m_HtmlWin; - wxSplitterWindow *m_Splitter; - wxNotebook *m_NavigPan; - wxTreeCtrl *m_ContentsBox; - wxImageList *m_ContentsImageList; - wxListBox *m_IndexBox; - wxTextCtrl *m_SearchText; - wxButton *m_SearchButton; - wxListBox *m_SearchList; - wxChoice *m_SearchChoice; - - wxHtmlHelpFrameCfg m_Cfg; - wxConfigBase *m_Config; - wxString m_ConfigRoot; - - // pagenumbers of controls in notebook (usually 0,1,2) - int m_ContentsPage; - int m_IndexPage; - int m_SearchPage; + bool m_DataCreated; // m_Data created by frame, or supplied? + wxString m_TitleFormat; // title of the help frame + wxHtmlHelpWindow *m_HtmlHelpWin; + wxHtmlHelpController* m_helpController; + bool m_shouldPreventAppExit; -protected: - void Init(wxHtmlHelpData* data = NULL); +private: DECLARE_EVENT_TABLE() + wxDECLARE_NO_COPY_CLASS(wxHtmlHelpFrame); }; -#endif +#endif // wxUSE_WXHTML_HELP #endif