From 3755cfa64d2f5182ec88d9d0bf934769e0269d10 Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Mon, 9 Jan 2006 13:42:57 +0000 Subject: [PATCH] Moved wxHtmlHelpFrame functionality to wxHtmlHelpWindow to allow for embedded and modal help git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@36802 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- Makefile.in | 32 + build/bakefiles/files.bkl | 2 + build/msw/makefile.bcc | 36 + build/msw/makefile.gcc | 36 + build/msw/makefile.vc | 36 + build/msw/makefile.wat | 36 + build/msw/wx_html.dsp | 8 + docs/latex/wx/hthelpct.tex | 72 +- docs/latex/wx/hthlpfrm.tex | 272 +++++- include/wx/html/helpctrl.h | 52 +- include/wx/html/helpdlg.h | 94 ++ include/wx/html/helpfrm.h | 156 +--- include/wx/html/helpwin.h | 286 ++++++ samples/help/demo.cpp | 33 + src/html/helpctrl.cpp | 244 +++-- src/html/helpdlg.cpp | 140 +++ src/html/helpfrm.cpp | 1727 ++--------------------------------- src/html/helpwin.cpp | 1757 ++++++++++++++++++++++++++++++++++++ 18 files changed, 3069 insertions(+), 1950 deletions(-) create mode 100644 include/wx/html/helpdlg.h create mode 100644 include/wx/html/helpwin.h create mode 100644 src/html/helpdlg.cpp create mode 100644 src/html/helpwin.cpp diff --git a/Makefile.in b/Makefile.in index c8067d73c1..228ac6bbbb 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1135,7 +1135,9 @@ HTMLDLL_OBJECTS = \ $(__HTML_SRC_PLATFORM_OBJECTS_2) \ htmldll_helpctrl.o \ htmldll_helpdata.o \ + htmldll_helpdlg.o \ htmldll_helpfrm.o \ + htmldll_helpwin.o \ htmldll_htmlcell.o \ htmldll_htmlfilt.o \ htmldll_htmlpars.o \ @@ -1164,7 +1166,9 @@ HTMLLIB_OBJECTS = \ $(__HTML_SRC_PLATFORM_OBJECTS_3) \ htmllib_helpctrl.o \ htmllib_helpdata.o \ + htmllib_helpdlg.o \ htmllib_helpfrm.o \ + htmllib_helpwin.o \ htmllib_htmlcell.o \ htmllib_htmlfilt.o \ htmllib_htmlpars.o \ @@ -2958,7 +2962,9 @@ COND_USE_GUI_1___MONOLIB_GUI_SRC_OBJECTS = \ $(__HTML_SRC_PLATFORM_OBJECTS) \ monodll_helpctrl.o \ monodll_helpdata.o \ + monodll_helpdlg.o \ monodll_helpfrm.o \ + monodll_helpwin.o \ monodll_htmlcell.o \ monodll_htmlfilt.o \ monodll_htmlpars.o \ @@ -4440,7 +4446,9 @@ COND_USE_GUI_1___MONOLIB_GUI_SRC_OBJECTS_1 = \ $(__HTML_SRC_PLATFORM_OBJECTS_1) \ monolib_helpctrl.o \ monolib_helpdata.o \ + monolib_helpdlg.o \ monolib_helpfrm.o \ + monolib_helpwin.o \ monolib_htmlcell.o \ monolib_htmlfilt.o \ monolib_htmlpars.o \ @@ -10869,6 +10877,9 @@ monodll_helpctrl.o: $(srcdir)/src/html/helpctrl.cpp $(MONODLL_ODEP) monodll_helpdata.o: $(srcdir)/src/html/helpdata.cpp $(MONODLL_ODEP) $(CXXC) -c -o $@ $(MONODLL_CXXFLAGS) $(srcdir)/src/html/helpdata.cpp +monodll_helpdlg.o: $(srcdir)/src/html/helpdlg.cpp $(MONODLL_ODEP) + $(CXXC) -c -o $@ $(MONODLL_CXXFLAGS) $(srcdir)/src/html/helpdlg.cpp + monodll_helpfrm.o: $(srcdir)/src/html/helpfrm.cpp $(MONODLL_ODEP) $(CXXC) -c -o $@ $(MONODLL_CXXFLAGS) $(srcdir)/src/html/helpfrm.cpp @@ -12375,6 +12386,9 @@ monodll_sound_sdl.o: $(srcdir)/src/unix/sound_sdl.cpp $(MONODLL_ODEP) @COND_TOOLKIT_PM_USE_GUI_1_WXUNIV_0@monodll_helpwin.o: $(srcdir)/src/os2/helpwin.cpp $(MONODLL_ODEP) @COND_TOOLKIT_PM_USE_GUI_1_WXUNIV_0@ $(CXXC) -c -o $@ $(MONODLL_CXXFLAGS) $(srcdir)/src/os2/helpwin.cpp +@COND_USE_GUI_1@monodll_helpwin.o: $(srcdir)/src/html/helpwin.cpp $(MONODLL_ODEP) +@COND_USE_GUI_1@ $(CXXC) -c -o $@ $(MONODLL_CXXFLAGS) $(srcdir)/src/html/helpwin.cpp + @COND_TOOLKIT_MSW_USE_GUI_1@monodll_automtn.o: $(srcdir)/src/msw/ole/automtn.cpp $(MONODLL_ODEP) @COND_TOOLKIT_MSW_USE_GUI_1@ $(CXXC) -c -o $@ $(MONODLL_CXXFLAGS) $(srcdir)/src/msw/ole/automtn.cpp @@ -14364,6 +14378,9 @@ monolib_helpctrl.o: $(srcdir)/src/html/helpctrl.cpp $(MONOLIB_ODEP) monolib_helpdata.o: $(srcdir)/src/html/helpdata.cpp $(MONOLIB_ODEP) $(CXXC) -c -o $@ $(MONOLIB_CXXFLAGS) $(srcdir)/src/html/helpdata.cpp +monolib_helpdlg.o: $(srcdir)/src/html/helpdlg.cpp $(MONOLIB_ODEP) + $(CXXC) -c -o $@ $(MONOLIB_CXXFLAGS) $(srcdir)/src/html/helpdlg.cpp + monolib_helpfrm.o: $(srcdir)/src/html/helpfrm.cpp $(MONOLIB_ODEP) $(CXXC) -c -o $@ $(MONOLIB_CXXFLAGS) $(srcdir)/src/html/helpfrm.cpp @@ -15870,6 +15887,9 @@ monolib_sound_sdl.o: $(srcdir)/src/unix/sound_sdl.cpp $(MONOLIB_ODEP) @COND_TOOLKIT_PM_USE_GUI_1_WXUNIV_0@monolib_helpwin.o: $(srcdir)/src/os2/helpwin.cpp $(MONOLIB_ODEP) @COND_TOOLKIT_PM_USE_GUI_1_WXUNIV_0@ $(CXXC) -c -o $@ $(MONOLIB_CXXFLAGS) $(srcdir)/src/os2/helpwin.cpp +@COND_USE_GUI_1@monolib_helpwin.o: $(srcdir)/src/html/helpwin.cpp $(MONOLIB_ODEP) +@COND_USE_GUI_1@ $(CXXC) -c -o $@ $(MONOLIB_CXXFLAGS) $(srcdir)/src/html/helpwin.cpp + @COND_TOOLKIT_MSW_USE_GUI_1@monolib_automtn.o: $(srcdir)/src/msw/ole/automtn.cpp $(MONOLIB_ODEP) @COND_TOOLKIT_MSW_USE_GUI_1@ $(CXXC) -c -o $@ $(MONOLIB_CXXFLAGS) $(srcdir)/src/msw/ole/automtn.cpp @@ -24051,9 +24071,15 @@ htmldll_helpctrl.o: $(srcdir)/src/html/helpctrl.cpp $(HTMLDLL_ODEP) htmldll_helpdata.o: $(srcdir)/src/html/helpdata.cpp $(HTMLDLL_ODEP) $(CXXC) -c -o $@ $(HTMLDLL_CXXFLAGS) $(srcdir)/src/html/helpdata.cpp +htmldll_helpdlg.o: $(srcdir)/src/html/helpdlg.cpp $(HTMLDLL_ODEP) + $(CXXC) -c -o $@ $(HTMLDLL_CXXFLAGS) $(srcdir)/src/html/helpdlg.cpp + htmldll_helpfrm.o: $(srcdir)/src/html/helpfrm.cpp $(HTMLDLL_ODEP) $(CXXC) -c -o $@ $(HTMLDLL_CXXFLAGS) $(srcdir)/src/html/helpfrm.cpp +htmldll_helpwin.o: $(srcdir)/src/html/helpwin.cpp $(HTMLDLL_ODEP) + $(CXXC) -c -o $@ $(HTMLDLL_CXXFLAGS) $(srcdir)/src/html/helpwin.cpp + htmldll_htmlcell.o: $(srcdir)/src/html/htmlcell.cpp $(HTMLDLL_ODEP) $(CXXC) -c -o $@ $(HTMLDLL_CXXFLAGS) $(srcdir)/src/html/htmlcell.cpp @@ -24123,9 +24149,15 @@ htmllib_helpctrl.o: $(srcdir)/src/html/helpctrl.cpp $(HTMLLIB_ODEP) htmllib_helpdata.o: $(srcdir)/src/html/helpdata.cpp $(HTMLLIB_ODEP) $(CXXC) -c -o $@ $(HTMLLIB_CXXFLAGS) $(srcdir)/src/html/helpdata.cpp +htmllib_helpdlg.o: $(srcdir)/src/html/helpdlg.cpp $(HTMLLIB_ODEP) + $(CXXC) -c -o $@ $(HTMLLIB_CXXFLAGS) $(srcdir)/src/html/helpdlg.cpp + htmllib_helpfrm.o: $(srcdir)/src/html/helpfrm.cpp $(HTMLLIB_ODEP) $(CXXC) -c -o $@ $(HTMLLIB_CXXFLAGS) $(srcdir)/src/html/helpfrm.cpp +htmllib_helpwin.o: $(srcdir)/src/html/helpwin.cpp $(HTMLLIB_ODEP) + $(CXXC) -c -o $@ $(HTMLLIB_CXXFLAGS) $(srcdir)/src/html/helpwin.cpp + htmllib_htmlcell.o: $(srcdir)/src/html/htmlcell.cpp $(HTMLLIB_ODEP) $(CXXC) -c -o $@ $(HTMLLIB_CXXFLAGS) $(srcdir)/src/html/htmlcell.cpp diff --git a/build/bakefiles/files.bkl b/build/bakefiles/files.bkl index a647350ece..f81f715d68 100644 --- a/build/bakefiles/files.bkl +++ b/build/bakefiles/files.bkl @@ -2545,7 +2545,9 @@ IMPORTANT: please read docs/tech/tn0016.txt before modifying this file! $(HTML_SRC_PLATFORM) src/html/helpctrl.cpp src/html/helpdata.cpp + src/html/helpdlg.cpp src/html/helpfrm.cpp + src/html/helpwin.cpp src/html/htmlcell.cpp src/html/htmlfilt.cpp src/html/htmlpars.cpp diff --git a/build/msw/makefile.bcc b/build/msw/makefile.bcc index f645a11bad..2970732aca 100644 --- a/build/msw/makefile.bcc +++ b/build/msw/makefile.bcc @@ -770,7 +770,9 @@ HTMLDLL_OBJECTS = \ $(OBJS)\htmldll_helpbest.obj \ $(OBJS)\htmldll_helpctrl.obj \ $(OBJS)\htmldll_helpdata.obj \ + $(OBJS)\htmldll_helpdlg.obj \ $(OBJS)\htmldll_helpfrm.obj \ + $(OBJS)\htmldll_helpwin.obj \ $(OBJS)\htmldll_htmlcell.obj \ $(OBJS)\htmldll_htmlfilt.obj \ $(OBJS)\htmldll_htmlpars.obj \ @@ -801,7 +803,9 @@ HTMLLIB_OBJECTS = \ $(OBJS)\htmllib_helpbest.obj \ $(OBJS)\htmllib_helpctrl.obj \ $(OBJS)\htmllib_helpdata.obj \ + $(OBJS)\htmllib_helpdlg.obj \ $(OBJS)\htmllib_helpfrm.obj \ + $(OBJS)\htmllib_helpwin.obj \ $(OBJS)\htmllib_htmlcell.obj \ $(OBJS)\htmllib_htmlfilt.obj \ $(OBJS)\htmllib_htmlpars.obj \ @@ -1062,7 +1066,9 @@ ____MONOLIB_GUI_SRC_FILENAMES_OBJECTS = \ $(OBJS)\monodll_helpbest.obj \ $(OBJS)\monodll_helpctrl.obj \ $(OBJS)\monodll_helpdata.obj \ + $(OBJS)\monodll_helpdlg.obj \ $(OBJS)\monodll_helpfrm.obj \ + $(OBJS)\monodll_helpwin.obj \ $(OBJS)\monodll_htmlcell.obj \ $(OBJS)\monodll_htmlfilt.obj \ $(OBJS)\monodll_htmlpars.obj \ @@ -1588,7 +1594,9 @@ ____MONOLIB_GUI_SRC_FILENAMES_1_OBJECTS = \ $(OBJS)\monolib_helpbest.obj \ $(OBJS)\monolib_helpctrl.obj \ $(OBJS)\monolib_helpdata.obj \ + $(OBJS)\monolib_helpdlg.obj \ $(OBJS)\monolib_helpfrm.obj \ + $(OBJS)\monolib_helpwin.obj \ $(OBJS)\monolib_htmlcell.obj \ $(OBJS)\monolib_htmlfilt.obj \ $(OBJS)\monolib_htmlpars.obj \ @@ -4419,6 +4427,9 @@ $(OBJS)\monodll_helpctrl.obj: ..\..\src\html\helpctrl.cpp $(OBJS)\monodll_helpdata.obj: ..\..\src\html\helpdata.cpp $(CXX) -q -c -P -o$@ $(MONODLL_CXXFLAGS) $** +$(OBJS)\monodll_helpdlg.obj: ..\..\src\html\helpdlg.cpp + $(CXX) -q -c -P -o$@ $(MONODLL_CXXFLAGS) $** + $(OBJS)\monodll_helpfrm.obj: ..\..\src\html\helpfrm.cpp $(CXX) -q -c -P -o$@ $(MONODLL_CXXFLAGS) $** @@ -4862,6 +4873,11 @@ $(OBJS)\monodll_helpwin.obj: ..\..\src\msw\helpwin.cpp $(CXX) -q -c -P -o$@ $(MONODLL_CXXFLAGS) $** !endif +!if "$(USE_GUI)" == "1" +$(OBJS)\monodll_helpwin.obj: ..\..\src\html\helpwin.cpp + $(CXX) -q -c -P -o$@ $(MONODLL_CXXFLAGS) $** +!endif + !if "$(USE_GUI)" == "1" $(OBJS)\monodll_automtn.obj: ..\..\src\msw\ole\automtn.cpp $(CXX) -q -c -P -o$@ $(MONODLL_CXXFLAGS) $** @@ -6143,6 +6159,9 @@ $(OBJS)\monolib_helpctrl.obj: ..\..\src\html\helpctrl.cpp $(OBJS)\monolib_helpdata.obj: ..\..\src\html\helpdata.cpp $(CXX) -q -c -P -o$@ $(MONOLIB_CXXFLAGS) $** +$(OBJS)\monolib_helpdlg.obj: ..\..\src\html\helpdlg.cpp + $(CXX) -q -c -P -o$@ $(MONOLIB_CXXFLAGS) $** + $(OBJS)\monolib_helpfrm.obj: ..\..\src\html\helpfrm.cpp $(CXX) -q -c -P -o$@ $(MONOLIB_CXXFLAGS) $** @@ -6586,6 +6605,11 @@ $(OBJS)\monolib_helpwin.obj: ..\..\src\msw\helpwin.cpp $(CXX) -q -c -P -o$@ $(MONOLIB_CXXFLAGS) $** !endif +!if "$(USE_GUI)" == "1" +$(OBJS)\monolib_helpwin.obj: ..\..\src\html\helpwin.cpp + $(CXX) -q -c -P -o$@ $(MONOLIB_CXXFLAGS) $** +!endif + !if "$(USE_GUI)" == "1" $(OBJS)\monolib_automtn.obj: ..\..\src\msw\ole\automtn.cpp $(CXX) -q -c -P -o$@ $(MONOLIB_CXXFLAGS) $** @@ -10493,9 +10517,15 @@ $(OBJS)\htmldll_helpctrl.obj: ..\..\src\html\helpctrl.cpp $(OBJS)\htmldll_helpdata.obj: ..\..\src\html\helpdata.cpp $(CXX) -q -c -P -o$@ $(HTMLDLL_CXXFLAGS) $** +$(OBJS)\htmldll_helpdlg.obj: ..\..\src\html\helpdlg.cpp + $(CXX) -q -c -P -o$@ $(HTMLDLL_CXXFLAGS) $** + $(OBJS)\htmldll_helpfrm.obj: ..\..\src\html\helpfrm.cpp $(CXX) -q -c -P -o$@ $(HTMLDLL_CXXFLAGS) $** +$(OBJS)\htmldll_helpwin.obj: ..\..\src\html\helpwin.cpp + $(CXX) -q -c -P -o$@ $(HTMLDLL_CXXFLAGS) $** + $(OBJS)\htmldll_htmlcell.obj: ..\..\src\html\htmlcell.cpp $(CXX) -q -c -P -o$@ $(HTMLDLL_CXXFLAGS) $** @@ -10562,9 +10592,15 @@ $(OBJS)\htmllib_helpctrl.obj: ..\..\src\html\helpctrl.cpp $(OBJS)\htmllib_helpdata.obj: ..\..\src\html\helpdata.cpp $(CXX) -q -c -P -o$@ $(HTMLLIB_CXXFLAGS) $** +$(OBJS)\htmllib_helpdlg.obj: ..\..\src\html\helpdlg.cpp + $(CXX) -q -c -P -o$@ $(HTMLLIB_CXXFLAGS) $** + $(OBJS)\htmllib_helpfrm.obj: ..\..\src\html\helpfrm.cpp $(CXX) -q -c -P -o$@ $(HTMLLIB_CXXFLAGS) $** +$(OBJS)\htmllib_helpwin.obj: ..\..\src\html\helpwin.cpp + $(CXX) -q -c -P -o$@ $(HTMLLIB_CXXFLAGS) $** + $(OBJS)\htmllib_htmlcell.obj: ..\..\src\html\htmlcell.cpp $(CXX) -q -c -P -o$@ $(HTMLLIB_CXXFLAGS) $** diff --git a/build/msw/makefile.gcc b/build/msw/makefile.gcc index 36d67995a9..4a583c4a4a 100644 --- a/build/msw/makefile.gcc +++ b/build/msw/makefile.gcc @@ -767,7 +767,9 @@ HTMLDLL_OBJECTS = \ $(OBJS)\htmldll_helpbest.o \ $(OBJS)\htmldll_helpctrl.o \ $(OBJS)\htmldll_helpdata.o \ + $(OBJS)\htmldll_helpdlg.o \ $(OBJS)\htmldll_helpfrm.o \ + $(OBJS)\htmldll_helpwin.o \ $(OBJS)\htmldll_htmlcell.o \ $(OBJS)\htmldll_htmlfilt.o \ $(OBJS)\htmldll_htmlpars.o \ @@ -799,7 +801,9 @@ HTMLLIB_OBJECTS = \ $(OBJS)\htmllib_helpbest.o \ $(OBJS)\htmllib_helpctrl.o \ $(OBJS)\htmllib_helpdata.o \ + $(OBJS)\htmllib_helpdlg.o \ $(OBJS)\htmllib_helpfrm.o \ + $(OBJS)\htmllib_helpwin.o \ $(OBJS)\htmllib_htmlcell.o \ $(OBJS)\htmllib_htmlfilt.o \ $(OBJS)\htmllib_htmlpars.o \ @@ -1071,7 +1075,9 @@ ____MONOLIB_GUI_SRC_FILENAMES_OBJECTS = \ $(OBJS)\monodll_helpbest.o \ $(OBJS)\monodll_helpctrl.o \ $(OBJS)\monodll_helpdata.o \ + $(OBJS)\monodll_helpdlg.o \ $(OBJS)\monodll_helpfrm.o \ + $(OBJS)\monodll_helpwin.o \ $(OBJS)\monodll_htmlcell.o \ $(OBJS)\monodll_htmlfilt.o \ $(OBJS)\monodll_htmlpars.o \ @@ -1603,7 +1609,9 @@ ____MONOLIB_GUI_SRC_FILENAMES_1_OBJECTS = \ $(OBJS)\monolib_helpbest.o \ $(OBJS)\monolib_helpctrl.o \ $(OBJS)\monolib_helpdata.o \ + $(OBJS)\monolib_helpdlg.o \ $(OBJS)\monolib_helpfrm.o \ + $(OBJS)\monolib_helpwin.o \ $(OBJS)\monolib_htmlcell.o \ $(OBJS)\monolib_htmlfilt.o \ $(OBJS)\monolib_htmlpars.o \ @@ -4514,6 +4522,9 @@ $(OBJS)\monodll_helpctrl.o: ../../src/html/helpctrl.cpp $(OBJS)\monodll_helpdata.o: ../../src/html/helpdata.cpp $(CXX) -c -o $@ $(MONODLL_CXXFLAGS) $(CPPDEPS) $< +$(OBJS)\monodll_helpdlg.o: ../../src/html/helpdlg.cpp + $(CXX) -c -o $@ $(MONODLL_CXXFLAGS) $(CPPDEPS) $< + $(OBJS)\monodll_helpfrm.o: ../../src/html/helpfrm.cpp $(CXX) -c -o $@ $(MONODLL_CXXFLAGS) $(CPPDEPS) $< @@ -4957,6 +4968,11 @@ $(OBJS)\monodll_helpwin.o: ../../src/msw/helpwin.cpp $(CXX) -c -o $@ $(MONODLL_CXXFLAGS) $(CPPDEPS) $< endif +ifeq ($(USE_GUI),1) +$(OBJS)\monodll_helpwin.o: ../../src/html/helpwin.cpp + $(CXX) -c -o $@ $(MONODLL_CXXFLAGS) $(CPPDEPS) $< +endif + ifeq ($(USE_GUI),1) $(OBJS)\monodll_automtn.o: ../../src/msw/ole/automtn.cpp $(CXX) -c -o $@ $(MONODLL_CXXFLAGS) $(CPPDEPS) $< @@ -6338,6 +6354,9 @@ $(OBJS)\monolib_helpctrl.o: ../../src/html/helpctrl.cpp $(OBJS)\monolib_helpdata.o: ../../src/html/helpdata.cpp $(CXX) -c -o $@ $(MONOLIB_CXXFLAGS) $(CPPDEPS) $< +$(OBJS)\monolib_helpdlg.o: ../../src/html/helpdlg.cpp + $(CXX) -c -o $@ $(MONOLIB_CXXFLAGS) $(CPPDEPS) $< + $(OBJS)\monolib_helpfrm.o: ../../src/html/helpfrm.cpp $(CXX) -c -o $@ $(MONOLIB_CXXFLAGS) $(CPPDEPS) $< @@ -6781,6 +6800,11 @@ $(OBJS)\monolib_helpwin.o: ../../src/msw/helpwin.cpp $(CXX) -c -o $@ $(MONOLIB_CXXFLAGS) $(CPPDEPS) $< endif +ifeq ($(USE_GUI),1) +$(OBJS)\monolib_helpwin.o: ../../src/html/helpwin.cpp + $(CXX) -c -o $@ $(MONOLIB_CXXFLAGS) $(CPPDEPS) $< +endif + ifeq ($(USE_GUI),1) $(OBJS)\monolib_automtn.o: ../../src/msw/ole/automtn.cpp $(CXX) -c -o $@ $(MONOLIB_CXXFLAGS) $(CPPDEPS) $< @@ -10988,9 +11012,15 @@ $(OBJS)\htmldll_helpctrl.o: ../../src/html/helpctrl.cpp $(OBJS)\htmldll_helpdata.o: ../../src/html/helpdata.cpp $(CXX) -c -o $@ $(HTMLDLL_CXXFLAGS) $(CPPDEPS) $< +$(OBJS)\htmldll_helpdlg.o: ../../src/html/helpdlg.cpp + $(CXX) -c -o $@ $(HTMLDLL_CXXFLAGS) $(CPPDEPS) $< + $(OBJS)\htmldll_helpfrm.o: ../../src/html/helpfrm.cpp $(CXX) -c -o $@ $(HTMLDLL_CXXFLAGS) $(CPPDEPS) $< +$(OBJS)\htmldll_helpwin.o: ../../src/html/helpwin.cpp + $(CXX) -c -o $@ $(HTMLDLL_CXXFLAGS) $(CPPDEPS) $< + $(OBJS)\htmldll_htmlcell.o: ../../src/html/htmlcell.cpp $(CXX) -c -o $@ $(HTMLDLL_CXXFLAGS) $(CPPDEPS) $< @@ -11057,9 +11087,15 @@ $(OBJS)\htmllib_helpctrl.o: ../../src/html/helpctrl.cpp $(OBJS)\htmllib_helpdata.o: ../../src/html/helpdata.cpp $(CXX) -c -o $@ $(HTMLLIB_CXXFLAGS) $(CPPDEPS) $< +$(OBJS)\htmllib_helpdlg.o: ../../src/html/helpdlg.cpp + $(CXX) -c -o $@ $(HTMLLIB_CXXFLAGS) $(CPPDEPS) $< + $(OBJS)\htmllib_helpfrm.o: ../../src/html/helpfrm.cpp $(CXX) -c -o $@ $(HTMLLIB_CXXFLAGS) $(CPPDEPS) $< +$(OBJS)\htmllib_helpwin.o: ../../src/html/helpwin.cpp + $(CXX) -c -o $@ $(HTMLLIB_CXXFLAGS) $(CPPDEPS) $< + $(OBJS)\htmllib_htmlcell.o: ../../src/html/htmlcell.cpp $(CXX) -c -o $@ $(HTMLLIB_CXXFLAGS) $(CPPDEPS) $< diff --git a/build/msw/makefile.vc b/build/msw/makefile.vc index 88c9159d22..ea9d0f656e 100644 --- a/build/msw/makefile.vc +++ b/build/msw/makefile.vc @@ -831,7 +831,9 @@ HTMLDLL_OBJECTS = \ $(OBJS)\htmldll_helpbest.obj \ $(OBJS)\htmldll_helpctrl.obj \ $(OBJS)\htmldll_helpdata.obj \ + $(OBJS)\htmldll_helpdlg.obj \ $(OBJS)\htmldll_helpfrm.obj \ + $(OBJS)\htmldll_helpwin.obj \ $(OBJS)\htmldll_htmlcell.obj \ $(OBJS)\htmldll_htmlfilt.obj \ $(OBJS)\htmldll_htmlpars.obj \ @@ -865,7 +867,9 @@ HTMLLIB_OBJECTS = \ $(OBJS)\htmllib_helpbest.obj \ $(OBJS)\htmllib_helpctrl.obj \ $(OBJS)\htmllib_helpdata.obj \ + $(OBJS)\htmllib_helpdlg.obj \ $(OBJS)\htmllib_helpfrm.obj \ + $(OBJS)\htmllib_helpwin.obj \ $(OBJS)\htmllib_htmlcell.obj \ $(OBJS)\htmllib_htmlfilt.obj \ $(OBJS)\htmllib_htmlpars.obj \ @@ -1220,7 +1224,9 @@ ____MONOLIB_GUI_SRC_FILENAMES_OBJECTS = \ $(OBJS)\monodll_helpbest.obj \ $(OBJS)\monodll_helpctrl.obj \ $(OBJS)\monodll_helpdata.obj \ + $(OBJS)\monodll_helpdlg.obj \ $(OBJS)\monodll_helpfrm.obj \ + $(OBJS)\monodll_helpwin.obj \ $(OBJS)\monodll_htmlcell.obj \ $(OBJS)\monodll_htmlfilt.obj \ $(OBJS)\monodll_htmlpars.obj \ @@ -1752,7 +1758,9 @@ ____MONOLIB_GUI_SRC_FILENAMES_1_OBJECTS = \ $(OBJS)\monolib_helpbest.obj \ $(OBJS)\monolib_helpctrl.obj \ $(OBJS)\monolib_helpdata.obj \ + $(OBJS)\monolib_helpdlg.obj \ $(OBJS)\monolib_helpfrm.obj \ + $(OBJS)\monolib_helpwin.obj \ $(OBJS)\monolib_htmlcell.obj \ $(OBJS)\monolib_htmlfilt.obj \ $(OBJS)\monolib_htmlpars.obj \ @@ -4727,6 +4735,9 @@ $(OBJS)\monodll_helpctrl.obj: ..\..\src\html\helpctrl.cpp $(OBJS)\monodll_helpdata.obj: ..\..\src\html\helpdata.cpp $(CXX) /c /nologo /TP /Fo$@ $(MONODLL_CXXFLAGS) $** +$(OBJS)\monodll_helpdlg.obj: ..\..\src\html\helpdlg.cpp + $(CXX) /c /nologo /TP /Fo$@ $(MONODLL_CXXFLAGS) $** + $(OBJS)\monodll_helpfrm.obj: ..\..\src\html\helpfrm.cpp $(CXX) /c /nologo /TP /Fo$@ $(MONODLL_CXXFLAGS) $** @@ -5170,6 +5181,11 @@ $(OBJS)\monodll_helpwin.obj: ..\..\src\msw\helpwin.cpp $(CXX) /c /nologo /TP /Fo$@ $(MONODLL_CXXFLAGS) $** !endif +!if "$(USE_GUI)" == "1" +$(OBJS)\monodll_helpwin.obj: ..\..\src\html\helpwin.cpp + $(CXX) /c /nologo /TP /Fo$@ $(MONODLL_CXXFLAGS) $** +!endif + !if "$(USE_GUI)" == "1" $(OBJS)\monodll_automtn.obj: ..\..\src\msw\ole\automtn.cpp $(CXX) /c /nologo /TP /Fo$@ $(MONODLL_CXXFLAGS) $** @@ -6451,6 +6467,9 @@ $(OBJS)\monolib_helpctrl.obj: ..\..\src\html\helpctrl.cpp $(OBJS)\monolib_helpdata.obj: ..\..\src\html\helpdata.cpp $(CXX) /c /nologo /TP /Fo$@ $(MONOLIB_CXXFLAGS) $** +$(OBJS)\monolib_helpdlg.obj: ..\..\src\html\helpdlg.cpp + $(CXX) /c /nologo /TP /Fo$@ $(MONOLIB_CXXFLAGS) $** + $(OBJS)\monolib_helpfrm.obj: ..\..\src\html\helpfrm.cpp $(CXX) /c /nologo /TP /Fo$@ $(MONOLIB_CXXFLAGS) $** @@ -6894,6 +6913,11 @@ $(OBJS)\monolib_helpwin.obj: ..\..\src\msw\helpwin.cpp $(CXX) /c /nologo /TP /Fo$@ $(MONOLIB_CXXFLAGS) $** !endif +!if "$(USE_GUI)" == "1" +$(OBJS)\monolib_helpwin.obj: ..\..\src\html\helpwin.cpp + $(CXX) /c /nologo /TP /Fo$@ $(MONOLIB_CXXFLAGS) $** +!endif + !if "$(USE_GUI)" == "1" $(OBJS)\monolib_automtn.obj: ..\..\src\msw\ole\automtn.cpp $(CXX) /c /nologo /TP /Fo$@ $(MONOLIB_CXXFLAGS) $** @@ -10801,9 +10825,15 @@ $(OBJS)\htmldll_helpctrl.obj: ..\..\src\html\helpctrl.cpp $(OBJS)\htmldll_helpdata.obj: ..\..\src\html\helpdata.cpp $(CXX) /c /nologo /TP /Fo$@ $(HTMLDLL_CXXFLAGS) $** +$(OBJS)\htmldll_helpdlg.obj: ..\..\src\html\helpdlg.cpp + $(CXX) /c /nologo /TP /Fo$@ $(HTMLDLL_CXXFLAGS) $** + $(OBJS)\htmldll_helpfrm.obj: ..\..\src\html\helpfrm.cpp $(CXX) /c /nologo /TP /Fo$@ $(HTMLDLL_CXXFLAGS) $** +$(OBJS)\htmldll_helpwin.obj: ..\..\src\html\helpwin.cpp + $(CXX) /c /nologo /TP /Fo$@ $(HTMLDLL_CXXFLAGS) $** + $(OBJS)\htmldll_htmlcell.obj: ..\..\src\html\htmlcell.cpp $(CXX) /c /nologo /TP /Fo$@ $(HTMLDLL_CXXFLAGS) $** @@ -10870,9 +10900,15 @@ $(OBJS)\htmllib_helpctrl.obj: ..\..\src\html\helpctrl.cpp $(OBJS)\htmllib_helpdata.obj: ..\..\src\html\helpdata.cpp $(CXX) /c /nologo /TP /Fo$@ $(HTMLLIB_CXXFLAGS) $** +$(OBJS)\htmllib_helpdlg.obj: ..\..\src\html\helpdlg.cpp + $(CXX) /c /nologo /TP /Fo$@ $(HTMLLIB_CXXFLAGS) $** + $(OBJS)\htmllib_helpfrm.obj: ..\..\src\html\helpfrm.cpp $(CXX) /c /nologo /TP /Fo$@ $(HTMLLIB_CXXFLAGS) $** +$(OBJS)\htmllib_helpwin.obj: ..\..\src\html\helpwin.cpp + $(CXX) /c /nologo /TP /Fo$@ $(HTMLLIB_CXXFLAGS) $** + $(OBJS)\htmllib_htmlcell.obj: ..\..\src\html\htmlcell.cpp $(CXX) /c /nologo /TP /Fo$@ $(HTMLLIB_CXXFLAGS) $** diff --git a/build/msw/makefile.wat b/build/msw/makefile.wat index dbfe7ce1d4..63826cb3cd 100644 --- a/build/msw/makefile.wat +++ b/build/msw/makefile.wat @@ -106,7 +106,9 @@ ____MONOLIB_GUI_SRC_FILENAMES_OBJECTS = & $(OBJS)\monodll_helpbest.obj & $(OBJS)\monodll_helpctrl.obj & $(OBJS)\monodll_helpdata.obj & + $(OBJS)\monodll_helpdlg.obj & $(OBJS)\monodll_helpfrm.obj & + $(OBJS)\monodll_helpwin.obj & $(OBJS)\monodll_htmlcell.obj & $(OBJS)\monodll_htmlfilt.obj & $(OBJS)\monodll_htmlpars.obj & @@ -642,7 +644,9 @@ ____MONOLIB_GUI_SRC_FILENAMES_1_OBJECTS = & $(OBJS)\monolib_helpbest.obj & $(OBJS)\monolib_helpctrl.obj & $(OBJS)\monolib_helpdata.obj & + $(OBJS)\monolib_helpdlg.obj & $(OBJS)\monolib_helpfrm.obj & + $(OBJS)\monolib_helpwin.obj & $(OBJS)\monolib_htmlcell.obj & $(OBJS)\monolib_htmlfilt.obj & $(OBJS)\monolib_htmlpars.obj & @@ -3156,7 +3160,9 @@ HTMLDLL_OBJECTS = & $(OBJS)\htmldll_helpbest.obj & $(OBJS)\htmldll_helpctrl.obj & $(OBJS)\htmldll_helpdata.obj & + $(OBJS)\htmldll_helpdlg.obj & $(OBJS)\htmldll_helpfrm.obj & + $(OBJS)\htmldll_helpwin.obj & $(OBJS)\htmldll_htmlcell.obj & $(OBJS)\htmldll_htmlfilt.obj & $(OBJS)\htmldll_htmlpars.obj & @@ -3188,7 +3194,9 @@ HTMLLIB_OBJECTS = & $(OBJS)\htmllib_helpbest.obj & $(OBJS)\htmllib_helpctrl.obj & $(OBJS)\htmllib_helpdata.obj & + $(OBJS)\htmllib_helpdlg.obj & $(OBJS)\htmllib_helpfrm.obj & + $(OBJS)\htmllib_helpwin.obj & $(OBJS)\htmllib_htmlcell.obj & $(OBJS)\htmllib_htmlfilt.obj & $(OBJS)\htmllib_htmlpars.obj & @@ -4714,6 +4722,9 @@ $(OBJS)\monodll_helpctrl.obj : .AUTODEPEND ..\..\src\html\helpctrl.cpp $(OBJS)\monodll_helpdata.obj : .AUTODEPEND ..\..\src\html\helpdata.cpp $(CXX) -zq -fo=$^@ $(MONODLL_CXXFLAGS) $< +$(OBJS)\monodll_helpdlg.obj : .AUTODEPEND ..\..\src\html\helpdlg.cpp + $(CXX) -zq -fo=$^@ $(MONODLL_CXXFLAGS) $< + $(OBJS)\monodll_helpfrm.obj : .AUTODEPEND ..\..\src\html\helpfrm.cpp $(CXX) -zq -fo=$^@ $(MONODLL_CXXFLAGS) $< @@ -5157,6 +5168,11 @@ $(OBJS)\monodll_helpwin.obj : .AUTODEPEND ..\..\src\msw\helpwin.cpp $(CXX) -zq -fo=$^@ $(MONODLL_CXXFLAGS) $< !endif +!ifeq USE_GUI 1 +$(OBJS)\monodll_helpwin.obj : .AUTODEPEND ..\..\src\html\helpwin.cpp + $(CXX) -zq -fo=$^@ $(MONODLL_CXXFLAGS) $< +!endif + !ifeq USE_GUI 1 $(OBJS)\monodll_automtn.obj : .AUTODEPEND ..\..\src\msw\ole\automtn.cpp $(CXX) -zq -fo=$^@ $(MONODLL_CXXFLAGS) $< @@ -6538,6 +6554,9 @@ $(OBJS)\monolib_helpctrl.obj : .AUTODEPEND ..\..\src\html\helpctrl.cpp $(OBJS)\monolib_helpdata.obj : .AUTODEPEND ..\..\src\html\helpdata.cpp $(CXX) -zq -fo=$^@ $(MONOLIB_CXXFLAGS) $< +$(OBJS)\monolib_helpdlg.obj : .AUTODEPEND ..\..\src\html\helpdlg.cpp + $(CXX) -zq -fo=$^@ $(MONOLIB_CXXFLAGS) $< + $(OBJS)\monolib_helpfrm.obj : .AUTODEPEND ..\..\src\html\helpfrm.cpp $(CXX) -zq -fo=$^@ $(MONOLIB_CXXFLAGS) $< @@ -6981,6 +7000,11 @@ $(OBJS)\monolib_helpwin.obj : .AUTODEPEND ..\..\src\msw\helpwin.cpp $(CXX) -zq -fo=$^@ $(MONOLIB_CXXFLAGS) $< !endif +!ifeq USE_GUI 1 +$(OBJS)\monolib_helpwin.obj : .AUTODEPEND ..\..\src\html\helpwin.cpp + $(CXX) -zq -fo=$^@ $(MONOLIB_CXXFLAGS) $< +!endif + !ifeq USE_GUI 1 $(OBJS)\monolib_automtn.obj : .AUTODEPEND ..\..\src\msw\ole\automtn.cpp $(CXX) -zq -fo=$^@ $(MONOLIB_CXXFLAGS) $< @@ -11188,9 +11212,15 @@ $(OBJS)\htmldll_helpctrl.obj : .AUTODEPEND ..\..\src\html\helpctrl.cpp $(OBJS)\htmldll_helpdata.obj : .AUTODEPEND ..\..\src\html\helpdata.cpp $(CXX) -zq -fo=$^@ $(HTMLDLL_CXXFLAGS) $< +$(OBJS)\htmldll_helpdlg.obj : .AUTODEPEND ..\..\src\html\helpdlg.cpp + $(CXX) -zq -fo=$^@ $(HTMLDLL_CXXFLAGS) $< + $(OBJS)\htmldll_helpfrm.obj : .AUTODEPEND ..\..\src\html\helpfrm.cpp $(CXX) -zq -fo=$^@ $(HTMLDLL_CXXFLAGS) $< +$(OBJS)\htmldll_helpwin.obj : .AUTODEPEND ..\..\src\html\helpwin.cpp + $(CXX) -zq -fo=$^@ $(HTMLDLL_CXXFLAGS) $< + $(OBJS)\htmldll_htmlcell.obj : .AUTODEPEND ..\..\src\html\htmlcell.cpp $(CXX) -zq -fo=$^@ $(HTMLDLL_CXXFLAGS) $< @@ -11257,9 +11287,15 @@ $(OBJS)\htmllib_helpctrl.obj : .AUTODEPEND ..\..\src\html\helpctrl.cpp $(OBJS)\htmllib_helpdata.obj : .AUTODEPEND ..\..\src\html\helpdata.cpp $(CXX) -zq -fo=$^@ $(HTMLLIB_CXXFLAGS) $< +$(OBJS)\htmllib_helpdlg.obj : .AUTODEPEND ..\..\src\html\helpdlg.cpp + $(CXX) -zq -fo=$^@ $(HTMLLIB_CXXFLAGS) $< + $(OBJS)\htmllib_helpfrm.obj : .AUTODEPEND ..\..\src\html\helpfrm.cpp $(CXX) -zq -fo=$^@ $(HTMLLIB_CXXFLAGS) $< +$(OBJS)\htmllib_helpwin.obj : .AUTODEPEND ..\..\src\html\helpwin.cpp + $(CXX) -zq -fo=$^@ $(HTMLLIB_CXXFLAGS) $< + $(OBJS)\htmllib_htmlcell.obj : .AUTODEPEND ..\..\src\html\htmlcell.cpp $(CXX) -zq -fo=$^@ $(HTMLLIB_CXXFLAGS) $< diff --git a/build/msw/wx_html.dsp b/build/msw/wx_html.dsp index af6726145b..90202374f9 100644 --- a/build/msw/wx_html.dsp +++ b/build/msw/wx_html.dsp @@ -545,10 +545,18 @@ SOURCE=..\..\src\html\helpdata.cpp # End Source File # Begin Source File +SOURCE=..\..\src\html\helpdlg.cpp +# End Source File +# Begin Source File + SOURCE=..\..\src\html\helpfrm.cpp # End Source File # Begin Source File +SOURCE=..\..\src\html\helpwin.cpp +# End Source File +# Begin Source File + SOURCE=..\..\src\html\htmlcell.cpp # End Source File # Begin Source File diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index 87eadfb919..a4ea217f34 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -5,10 +5,6 @@ \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller} -{\bf WARNING!} Although this class has an API compatible with other wxWidgets -help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it -is recommended that you use the enhanced capabilities of wxHtmlHelpController's API. - This help controller provides an easy way of displaying HTML help in your application (see {\it test} sample). The help system is based on {\bf books} (see \helpref{AddBook}{wxhtmlhelpcontrolleraddbook}). A book is a logical @@ -16,12 +12,16 @@ section of documentation (for example "User's Guide" or "Programmer's Guide" or "C++ Reference" or "wxWidgets Reference"). The help controller can handle as many books as you want. +Although this class has an API compatible with other wxWidgets +help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it +is recommended that you use the enhanced capabilities of wxHtmlHelpController's API. + wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its native format. The file format is described \helpref{here}{helpformat}. Have a look at docs/html/ directory where sample project files are stored. You can use Tex2RTF to produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in -your tex2rtf.ini file. +your tex2rtf.ini file. The commercial tool HelpBlocks (www.helpblocks.com) can also create these files. \wxheading{Note} @@ -34,7 +34,11 @@ sample for demonstration of its use. \wxheading{See also} -\helpref{Information about wxBestHelpController}{wxhelpcontroller} +\helpref{Information about wxBestHelpController}{wxhelpcontroller}, +\helpref{wxHtmlHelpFrame}{wxhtmlhelpframe}, +\helpref{wxHtmlHelpDialog}{wxhtmlhelpdialog}, +\helpref{wxHtmlHelpWindow}{wxhtmlhelpwindow}, +\helpref{wxHtmlModalHelp}{wxhtmlmodalhelp} \wxheading{Derived from} @@ -48,24 +52,24 @@ wxHelpControllerBase \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller} -\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULT\_STYLE}} +\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxWindow* }{parentWindow = NULL}} Constructor. \wxheading{Parameters} -{\it style} is combination of these flags: +{\it style} is a combination of these flags: \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.} -\twocolitem{\windowstyle{wxHF\_FLAT\_TOOLBAR}}{Help frame has toolbar with flat buttons (aka coolbar).} -\twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.} -\twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.} -\twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.} -\twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{Help frame has bookmarks controls.} -\twocolitem{\windowstyle{wxHF\_OPEN\_FILES}}{Allow user to open arbitrary HTML document.} -\twocolitem{\windowstyle{wxHF\_PRINT}}{Toolbar contains "print" button.} -\twocolitem{\windowstyle{wxHF\_MERGE\_BOOKS}}{Contents pane does not show +\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{The help window has a toolbar.} +\twocolitem{\windowstyle{wxHF\_FLAT\_TOOLBAR}}{The help window has a toolbar with flat buttons (aka coolbar).} +\twocolitem{\windowstyle{wxHF\_CONTENTS}}{The help window has a contents panel.} +\twocolitem{\windowstyle{wxHF\_INDEX}}{The help window has an index panel.} +\twocolitem{\windowstyle{wxHF\_SEARCH}}{The help window has a search panel.} +\twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{The help window has bookmarks controls.} +\twocolitem{\windowstyle{wxHF\_OPEN\_FILES}}{Allows user to open arbitrary HTML document.} +\twocolitem{\windowstyle{wxHF\_PRINT}}{The toolbar contains "print" button.} +\twocolitem{\windowstyle{wxHF\_MERGE\_BOOKS}}{The contents pane does not show book nodes. All books are merged together and appear as single book to the user.} \twocolitem{\windowstyle{wxHF\_ICONS\_BOOK}}{All nodes in contents pane @@ -75,32 +79,38 @@ a book icon, book's sections have a folder icon. This is the default.} \twocolitem{\windowstyle{wxHF\_ICONS\_BOOK\_CHAPTER}}{Both book nodes and nodes of top-level sections of a book (i.e. chapters) have a book icon, all other sections (sections, subsections, ...) have a folder icon.} +\twocolitem{\windowstyle{wxHF\_EMBEDDED}}{Specifies that the help controller controls an embedded window of class \helpref{wxHtmlHelpWindow}{wxhtmlhelpwindow} that +should not be destroyed when the controller is destroyed.} +\twocolitem{\windowstyle{wxHF\_DIALOG}}{Specifies that the help controller should create a dialog containing the help window.} +\twocolitem{\windowstyle{wxHF\_FRAME}}{Specifies that the help controller should create a frame containing the help window. This is the default if neither wxHF\_DIALOG nor wxHF\_EMBEDDED is specified.} +\twocolitem{\windowstyle{wxHF\_MODAL}}{Specifies that the help controller should create a modal dialog containing the help window (used with the wxHF\_DIALOG style).} \twocolitem{\windowstyle{wxHF\_DEFAULT\_STYLE}}{{\tt wxHF\_TOOLBAR | wxHF\_CONTENTS | wxHF\_INDEX | wxHF\_SEARCH | wxHF\_BOOKMARKS | wxHF\_PRINT}} \end{twocollist} +{\it parentWindow} is an optional window to be used as the parent for the help window. + \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook} -\func{bool}{AddBook}{\param{const wxFileName\& }{book\_file}, \param{bool }{show\_wait\_msg}} +\func{bool}{AddBook}{\param{const wxFileName\& }{bookFile}, \param{bool }{showWaitMsg}} -\func{bool}{AddBook}{\param{const wxString\& }{book\_url}, \param{bool }{show\_wait\_msg}} +\func{bool}{AddBook}{\param{const wxString\& }{bookUrl}, \param{bool }{showWaitMsg}} Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books. This must be called at least once before displaying any help. -{\it book\_file} or {\it book\_url} may be either .hhp file or ZIP archive +{\it bookFile} or {\it bookUrl} may be either .hhp file or ZIP archive that contains arbitrary number of .hhp files in top-level directory. This ZIP archive must have .zip or .htb extension -(the latter stands for "HTML book"). In other words, -{\tt AddBook(wxFileName("help.zip"))} -is possible and, in fact, recommended way. +(the latter stands for "HTML book"). In other words, {\tt AddBook(wxFileName("help.zip"))} +is possible and is the recommended way. \wxheading{Parameters} -\docparam{show\_wait\_msg}{If true then a decoration-less window with progress message is displayed.} -\docparam{book\_file}{Help book filename. It is recommended to use this prototype +\docparam{showWaitMsg}{If true then a decoration-less window with progress message is displayed.} +\docparam{bookFile}{Help book filename. It is recommended to use this prototype instead of the one taking URL, because it is less error-prone.} -\docparam{book\_url}{Help book URL (note that syntax of filename and URL is +\docparam{bookUrl}{Help book URL (note that syntax of filename and URL is different on most platforms)} \wxheading{Note} @@ -109,13 +119,19 @@ Don't forget to install wxFileSystem ZIP handler with {\tt wxFileSystem::AddHandler(new wxZipFSHandler);} before calling this method on a .zip or .htb file! +\membersection{wxHtmlHelpController::CreateHelpDialog}\label{wxhtmlhelpcontrollercreatehelpdialog} + +\func{virtual wxHtmlHelpDialog*}{CreateHelpDialog}{\param{wxHtmlHelpData * }{data}} + +This protected virtual method may be overridden so that when specifying the wxHF\_DIALOG style, the controller +uses a different dialog. + \membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe} \func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}} This protected virtual method may be overridden so that the controller -uses slightly different frame. See {\it samples/html/helpview} sample for -an example. +uses a different frame. \membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay} diff --git a/docs/latex/wx/hthlpfrm.tex b/docs/latex/wx/hthlpfrm.tex index 45cb90b3fb..c8bbe26441 100644 --- a/docs/latex/wx/hthlpfrm.tex +++ b/docs/latex/wx/hthlpfrm.tex @@ -3,6 +3,79 @@ % helpfrm.h at 24/Oct/99 18:03:10 % +\section{\class{wxHtmlHelpDialog}}\label{wxhtmlhelpdialog} + +This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} +to display help. +It is an internal class and should not be used directly - except for the case +when you're writing your own HTML help controller. + +\wxheading{Derived from} + +\helpref{wxFrame}{wxframe} + +\wxheading{Include files} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxHtmlHelpDialog::wxHtmlHelpDialog}\label{wxhtmlhelpdialogwxhtmlhelpdialog} + +\func{}{wxHtmlHelpDialog}{\param{wxHtmlHelpData* }{data = NULL}} + +\func{}{wxHtmlHelpDialog}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}} + +Constructor. For the values of {\it style}, please see the documentation for \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}. + +\membersection{wxHtmlHelpDialog::AddToolbarButtons}\label{wxhtmlhelpdialogaddtoolbarbuttons} + +\func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}} + +You may override this virtual method to add more buttons to the help window's +toolbar. {\it toolBar} is a pointer to the toolbar and {\it style} is the style +flag as passed to the Create method. + +wxToolBar::Realize is called immediately after returning from this function. + +\membersection{wxHtmlHelpDialog::Create}\label{wxhtmlhelpdialogcreate} + +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}} + +Creates the dialog. See \helpref{the constructor}{wxhtmlhelpdialogwxhtmlhelpdialog} +for a description of the parameters. + +\membersection{wxHtmlHelpDialog::GetController}\label{wxhtmlhelpdialoggetcontroller} + +\constfunc{wxHtmlHelpController* }{GetController}{\void} + +Returns the help controller associated with the dialog. + +\membersection{wxHtmlHelpDialog::ReadCustomization}\label{wxhtmlhelpdialogreadcustomization} + +\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}} + +Reads the user's settings for this dialog see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization}) + +\membersection{wxHtmlHelpDialog::SetController}\label{wxhtmlhelpdialogsetcontroller} + +\func{void}{SetController}{\param{wxHtmlHelpController* }{contoller}} + +Sets the help controller associated with the dialog. + +\membersection{wxHtmlHelpDialog::SetTitleFormat}\label{wxhtmlhelpdialogsettitleformat} + +\func{void}{SetTitleFormat}{\param{const wxString\& }{format}} + +Sets the dialog's title format. {\it format} must contain exactly one "\%s" +(it will be replaced by the page title). + +\membersection{wxHtmlHelpDialog::WriteCustomization}\label{wxhtmlhelpdialogwritecustomization} + +\func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}} + +Saves the user's settings for this dialog (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}). + \section{\class{wxHtmlHelpFrame}}\label{wxhtmlhelpframe} This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} @@ -26,41 +99,107 @@ when you're writing your own HTML help controller. \func{}{wxHtmlHelpFrame}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}} -Constructor. +Constructor. For the values of {\it style}, please see the documentation for \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}. + +\membersection{wxHtmlHelpFrame::AddToolbarButtons}\label{wxhtmlhelpframeaddtoolbarbuttons} + +\func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}} + +You may override this virtual method to add more buttons to the help window's +toolbar. {\it toolBar} is a pointer to the toolbar and {\it style} is the style +flag as passed to the Create method. -{\it style} is combination of these flags: - -\begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.} -\twocolitem{\windowstyle{wxHF\_FLAT\_TOOLBAR}}{Help frame has toolbar with flat buttons (aka coolbar).} -\twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.} -\twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.} -\twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.} -\twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{Help frame has bookmarks controls.} -\twocolitem{\windowstyle{wxHF\_OPEN\_FILES}}{Allow user to open arbitrary HTML document.} -\twocolitem{\windowstyle{wxHF\_PRINT}}{Toolbar contains "print" button.} -\twocolitem{\windowstyle{wxHF\_MERGE\_BOOKS}}{Contents pane does not show -book nodes. All books are merged together and appear as single book to the -user.} -\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK}}{All nodes in contents pane -have a book icon. This is how Microsoft's HTML help viewer behaves.} -\twocolitem{\windowstyle{wxHF\_ICONS\_FOLDER}}{Book nodes in contents pane have -a book icon, book's sections have a folder icon. This is the default.} -\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK\_CHAPTER}}{Both book nodes and -nodes of top-level sections of a book (i.e. chapters) have a book icon, -all other sections (sections, subsections, ...) have a folder icon.} -\twocolitem{\windowstyle{wxHF\_DEFAULT\_STYLE}}{{\tt wxHF\_TOOLBAR | wxHF\_CONTENTS -| wxHF\_INDEX | wxHF\_SEARCH | wxHF\_BOOKMARKS | wxHF\_PRINT}} -\end{twocollist} +wxToolBar::Realize is called immediately after returning from this function. \membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate} \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}} Creates the frame. See \helpref{the constructor}{wxhtmlhelpframewxhtmlhelpframe} -for parameters description. +for a description of the parameters. + +\membersection{wxHtmlHelpFrame::GetController}\label{wxhtmlhelpframegetcontroller} + +\constfunc{wxHtmlHelpController* }{GetController}{\void} + +Returns the help controller associated with the frame. + +\membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization} + +\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}} + +Reads the user's settings for this frame see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization}) -\membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents} +\membersection{wxHtmlHelpFrame::SetController}\label{wxhtmlhelpframesetcontroller} + +\func{void}{SetController}{\param{wxHtmlHelpController* }{contoller}} + +Sets the help controller associated with the frame. + +\membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat} + +\func{void}{SetTitleFormat}{\param{const wxString\& }{format}} + +Sets the frame's title format. {\it format} must contain exactly one "\%s" +(it will be replaced by the page title). + +\membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization} + +\func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}} + +Saves the user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}). + +\section{\class{wxHtmlHelpWindow}}\label{wxhtmlhelpwindow} + +This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} +to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window. + +For example: + +\begin{verbatim} + // m_embeddedHelpWindow is a wxHtmlHelpWindow + // m_embeddedHtmlHelp is a wxHtmlHelpController + + // Create embedded HTML Help window + m_embeddedHelpWindow = new wxHtmlHelpWindow; + m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config object here + m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow); + m_embeddedHelpWindow->Create(this, + wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE); + m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip"))); +\end{verbatim} + +You should pass the style wxHF\_EMBEDDED to the style parameter of wxHtmlHelpController to allow +the embedded window to be destroyed independently of the help controller. + +\wxheading{Derived from} + +\helpref{wxWindow}{wxwindow} + +\wxheading{Include files} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxHtmlHelpWindow::wxHtmlHelpWindow}\label{wxhtmlhelpwindowwxhtmlhelpwindow} + +\func{}{wxHtmlHelpWindow}{\param{wxHtmlHelpData* }{data = NULL}} + +\func{}{wxHtmlHelpWindow}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}} + +Constructor. + +Constructor. For the values of {\it style}, please see the documentation for \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}. + +\membersection{wxHtmlHelpWindow::Create}\label{wxhtmlhelpwindowcreate} + +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}} + +Creates the frame. See \helpref{the constructor}{wxhtmlhelpwindowwxhtmlhelpwindow} +for a description of the parameters. + +\membersection{wxHtmlHelpWindow::CreateContents}\label{wxhtmlhelpwindowcreatecontents} \func{void}{CreateContents}{\void} @@ -68,7 +207,7 @@ Creates contents panel. (May take some time.) Protected. -\membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex} +\membersection{wxHtmlHelpWindow::CreateIndex}\label{wxhtmlhelpwindowcreateindex} \func{void}{CreateIndex}{\void} @@ -76,13 +215,13 @@ Creates index panel. (May take some time.) Protected. -\membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch} +\membersection{wxHtmlHelpWindow::CreateSearch}\label{wxhtmlhelpwindowcreatesearch} \func{void}{CreateSearch}{\void} Creates search panel. -\membersection{wxHtmlHelpFrame::Display}\label{wxhtmlhelpframedisplay} +\membersection{wxHtmlHelpWindow::Display}\label{wxhtmlhelpwindowdisplay} \func{bool}{Display}{\param{const wxString\& }{x}} @@ -105,38 +244,38 @@ The second form takes numeric ID as the parameter. \pythonnote{The second form of this method is named DisplayId in wxPython.} -\membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents} +\membersection{wxHtmlHelpWindow::DisplayContents}\label{wxhtmlhelpwindowdisplaycontents} \func{bool}{DisplayContents}{\void} Displays contents panel. -\membersection{wxHtmlHelpFrame::DisplayIndex}\label{wxhtmlhelpframedisplayindex} +\membersection{wxHtmlHelpWindow::DisplayIndex}\label{wxhtmlhelpwindowdisplayindex} \func{bool}{DisplayIndex}{\void} Displays index panel. -\membersection{wxHtmlHelpFrame::GetData}\label{wxhtmlhelpframegetdata} +\membersection{wxHtmlHelpWindow::GetData}\label{wxhtmlhelpwindowgetdata} \func{wxHtmlHelpData*}{GetData}{\void} -Return wxHtmlHelpData object. +Returns the wxHtmlHelpData object, which is usually a pointer to the controller's data. -\membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch} +\membersection{wxHtmlHelpWindow::KeywordSearch}\label{wxhtmlhelpwindowkeywordsearch} \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}} Search for given keyword. Optionally it searches through the index (mode = wxHELP\_SEARCH\_INDEX), default the content (mode = wxHELP\_SEARCH\_ALL). -\membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization} +\membersection{wxHtmlHelpWindow::ReadCustomization}\label{wxhtmlhelpwindowreadcustomization} \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}} -Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization}) +Reads the user's settings for this window (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization}) -\membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists} +\membersection{wxHtmlHelpWindow::RefreshLists}\label{wxhtmlhelpwindowrefreshlists} \func{void}{RefreshLists}{\void} @@ -144,34 +283,75 @@ Refresh all panels. This is necessary if a new book was added. Protected. -\membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat} +\membersection{wxHtmlHelpWindow::SetTitleFormat}\label{wxhtmlhelpwindowsettitleformat} \func{void}{SetTitleFormat}{\param{const wxString\& }{format}} Sets the frame's title format. {\it format} must contain exactly one "\%s" (it will be replaced by the page title). -\membersection{wxHtmlHelpFrame::UseConfig}\label{wxhtmlhelpframeuseconfig} +\membersection{wxHtmlHelpWindow::UseConfig}\label{wxhtmlhelpwindowuseconfig} \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}} -Add books to search choice panel. +Associates a wxConfig object with the help window. It is recommended that you use \helpref{wxHtmlHelpController::UseConfig}{wxhtmlhelpcontrolleruseconfig} instead. -\membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization} +\membersection{wxHtmlHelpWindow::WriteCustomization}\label{wxhtmlhelpwindowwritecustomization} \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}} -Saves user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}). +Saves the user's settings for this window(see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}). -\membersection{wxHtmlHelpFrame::AddToolbarButtons}\label{wxhtmlhelpframeaddtoolbarbuttons} +\membersection{wxHtmlHelpWindow::AddToolbarButtons}\label{wxhtmlhelpwindowaddtoolbarbuttons} \func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}} -You may override this virtual method to add more buttons into help frame's +You may override this virtual method to add more buttons to the help window's toolbar. {\it toolBar} is a pointer to the toolbar and {\it style} is the style -flag as passed to Create method. +flag as passed to the Create method. wxToolBar::Realize is called immediately after returning from this function. See {\it samples/html/helpview} for an example. +\section{\class{wxHtmlModalHelp}}\label{wxhtmlmodalhelp} + +This class uses \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} +to display help in a modal dialog. This is useful on platforms such as wxMac +where if you display help from a modal dialog, the help window must itself be a modal +dialog. + +Create objects of this class on the stack, for example: + +\begin{verbatim} + // The help can be browsed during the lifetime of this object; when the user quits + // the help, program execution will continue. + wxHtmlModalHelp help(parent, wxT("help"), wxT("My topic")); +\end{verbatim} + +\wxheading{Derived from} + +None + +\wxheading{Include files} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxHtmlModalHelp::wxHtmlModalHelp}\label{wxhtmlmodalhelpctor} + +\func{}{wxHtmlModalHelp}{\param{wxWindow* }{parent}, \param{const wxString\& }{helpFile}, \param{const wxString\& }{topic = wxEmptyString}, + \param{int }{style = wxHF\_DEFAULT\_STYLE | wxHF\_DIALOG | wxHF\_MODAL}} + +\wxheading{Parameters} + +{\it parent} is the parent of the dialog. + +{\it helpFile} is the HTML help file to show. + +{\it topic} is an optional topic. If this is empty, the help contents will be shown. + +{\it style} is a combination of the flags described in the \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} documentation. + + diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h index a82c411e53..271bfd759f 100644 --- a/include/wx/html/helpctrl.h +++ b/include/wx/html/helpctrl.h @@ -21,6 +21,23 @@ #define wxID_HTML_HELPFRAME (wxID_HIGHEST + 1) +// This style indicates that the window is +// embedded in the application and must not be +// destroyed by the help controller. +#define wxHF_EMBEDDED 0x00008000 + +// Create a dialog for the help window. +#define wxHF_DIALOG 0x00010000 + +// Create a frame for the help window. +#define wxHF_FRAME 0x00020000 + +// Make the dialog modal when displaying help. +#define wxHF_MODAL 0x00040000 + +class WXDLLIMPEXP_HTML wxHtmlHelpDialog; +class WXDLLIMPEXP_HTML wxHtmlHelpWindow; + class WXDLLIMPEXP_HTML wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler { DECLARE_DYNAMIC_CLASS(wxHtmlHelpController) @@ -41,7 +58,9 @@ public: bool KeywordSearch(const wxString& keyword, wxHelpSearchMode mode = wxHELP_SEARCH_ALL); - wxHtmlHelpFrame* GetFrame() { return m_helpFrame; } + wxHtmlHelpWindow* GetHelpWindow() { return m_helpWindow; } + void SetHelpWindow(wxHtmlHelpWindow* helpWindow); + void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString); // Assigns config object to the Ctrl. This config is then @@ -81,16 +100,19 @@ public: // Make the help controller's frame 'modal' if // needed - void AddGrabIfNeeded(); + void MakeModalIfNeeded(); + + // Find the top-most parent window + wxWindow* FindTopLevelWindow(); protected: + virtual wxWindow* CreateHelpWindow(); virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data); - - virtual void CreateHelpWindow(); + virtual wxHtmlHelpDialog* CreateHelpDialog(wxHtmlHelpData *data); virtual void DestroyHelpWindow(); wxHtmlHelpData m_helpData; - wxHtmlHelpFrame* m_helpFrame; + wxHtmlHelpWindow* m_helpWindow; wxConfigBase * m_Config; wxString m_ConfigRoot; wxString m_titleFormat; @@ -100,6 +122,26 @@ protected: DECLARE_NO_COPY_CLASS(wxHtmlHelpController) }; +/* + * wxHtmlModalHelp + * A convenience class particularly for use on wxMac, + * where you can only show modal dialogs from a modal + * dialog. + * + * Use like this: + * + * wxHtmlModalHelp help(parent, filename, topic); + * + * If topic is empty, the help contents is displayed. + */ + +class WXDLLIMPEXP_HTML wxHtmlModalHelp +{ +public: + wxHtmlModalHelp(wxWindow* parent, const wxString& helpFile, const wxString& topic = wxEmptyString, + int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL); +}; + #endif // wxUSE_WXHTML_HELP #endif // _WX_HELPCTRL_H_ diff --git a/include/wx/html/helpdlg.h b/include/wx/html/helpdlg.h new file mode 100644 index 0000000000..7f9f154597 --- /dev/null +++ b/include/wx/html/helpdlg.h @@ -0,0 +1,94 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: helpdlg.h +// Purpose: wxHtmlHelpDialog +// Notes: Based on htmlhelp.cpp, implementing a monolithic +// HTML Help controller class, by Vaclav Slavik +// Author: Harm van der Heijden, Vaclav Slavik, Julian Smart +// RCS-ID: $Id$ +// Copyright: (c) Harm van der Heijden, Vaclav Slavik, Julian Smart +// Licence: wxWidgets licence +///////////////////////////////////////////////////////////////////////////// + +#ifndef _WX_HELPDLG_H_ +#define _WX_HELPDLG_H_ + +#if defined(__GNUG__) && !defined(__APPLE__) +#pragma interface "helpdlgex.h" +#endif + +#include "wx/defs.h" + +#if wxUSE_WXHTML_HELP + +#include "wx/html/helpdata.h" +#include "wx/window.h" +#include "wx/frame.h" +#include "wx/config.h" +#include "wx/splitter.h" +#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/helpwin.h" +#include "wx/html/htmprint.h" + +class WXDLLIMPEXP_HTML wxHtmlHelpController; +class WXDLLIMPEXP_HTML wxHtmlHelpWindow; + +class WXDLLIMPEXP_HTML wxHtmlHelpDialog : public wxDialog +{ + DECLARE_DYNAMIC_CLASS(wxHtmlHelpDialog) + +public: + wxHtmlHelpDialog(wxHtmlHelpData* data = NULL) { Init(data); } + wxHtmlHelpDialog(wxWindow* parent, wxWindowID wxWindowID, + const wxString& title = wxEmptyString, + int style = wxHF_DEFAULT_STYLE, wxHtmlHelpData* data = NULL); + ~wxHtmlHelpDialog(); + + bool Create(wxWindow* parent, wxWindowID id, const wxString& title = wxEmptyString, + int style = wxHF_DEFAULT_STYLE); + + /// Returns the data associated with this dialog. + wxHtmlHelpData* GetData() { return m_Data; } + + /// Returns the controller that created this dialog. + wxHtmlHelpController* GetController() const { return m_helpController; } + + /// Sets the controller associated with this dialog. + void SetController(wxHtmlHelpController* controller) { m_helpController = 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); + + // Override to add custom buttons to the toolbar + virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {}; + +protected: + void Init(wxHtmlHelpData* data = NULL); + + void OnCloseWindow(wxCloseEvent& event); + +protected: + // Temporary pointer to pass to window + wxHtmlHelpData* m_Data; + wxString m_TitleFormat; // title of the help frame + wxHtmlHelpWindow *m_HtmlHelpWin; + wxHtmlHelpController* m_helpController; + + DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxHtmlHelpDialog) +}; + +#endif + // wxUSE_WXHTML_HELP + +#endif + diff --git a/include/wx/html/helpfrm.h b/include/wx/html/helpfrm.h index 398ca7645a..4adbd42141 100644 --- a/include/wx/html/helpfrm.h +++ b/include/wx/html/helpfrm.h @@ -29,6 +29,7 @@ #include "wx/checkbox.h" #include "wx/stattext.h" #include "wx/html/htmlwin.h" +#include "wx/html/helpwin.h" #include "wx/html/htmprint.h" class WXDLLIMPEXP_CORE wxButton; @@ -58,18 +59,12 @@ class WXDLLIMPEXP_CORE wxTreeCtrl; #define wxHF_FLATTOOLBAR wxHF_FLAT_TOOLBAR #define wxHF_DEFAULTSTYLE wxHF_DEFAULT_STYLE - -struct wxHtmlHelpFrameCfg -{ - int x, y, w, h; - long sashpos; - bool navig_on; -}; - struct wxHtmlHelpMergedIndexItem; class wxHtmlHelpMergedIndex; class WXDLLIMPEXP_CORE wxHelpControllerBase; +class WXDLLIMPEXP_HTML wxHtmlHelpController; +class WXDLLIMPEXP_CORE wxHtmlHelpWindow; class WXDLLIMPEXP_HTML wxHtmlHelpFrame : public wxFrame { @@ -84,93 +79,35 @@ public: int style = wxHF_DEFAULT_STYLE); ~wxHtmlHelpFrame(); + /// Returns the data associated with the window. wxHtmlHelpData* GetData() { return m_Data; } - wxHelpControllerBase* GetController() const { return m_helpController; } - void SetController(wxHelpControllerBase* controller) { m_helpController = controller; } - // Sets format of title of the frame. Must contain exactly one "%s" - // (for title of displayed HTML page) - void SetTitleFormat(const wxString& format); + /// Returns the help controller associated with the window. + wxHtmlHelpController* GetController() const { return m_helpController; } - // 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 wxString& x); - - // Alternative version that works with numeric ID. - // (uses extension to MS format, , see docs) - bool Display(const int id); - - // Displays help window and focuses contents. - bool DisplayContents(); - - // Displays help window and focuses index. - bool DisplayIndex(); - - // 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 - bool KeywordSearch(const wxString& keyword, - wxHelpSearchMode mode = wxHELP_SEARCH_ALL); - - void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString) - { - m_Config = config; - m_ConfigRoot = rootpath; - ReadCustomization(config, rootpath); - } - - // 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 ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); - void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); - - // call this to let wxHtmlHelpFrame know page changed - void NotifyPageChanged(); - - // Refreshes Contents and Index tabs - void RefreshLists(); + /// Sets the help controller associated with the window. + void SetController(wxHtmlHelpController* controller) { m_helpController = controller; } -protected: - void Init(wxHtmlHelpData* data = NULL); + /// Returns the help window. + wxHtmlHelpWindow* GetHelpWindow() const { return m_HtmlHelpWin; } - // Adds items to m_Contents tree control - void CreateContents(); - - // Adds items to m_IndexList - void CreateIndex(); + // Sets format of title of the frame. Must contain exactly one "%s" + // (for title of displayed HTML page) + void SetTitleFormat(const wxString& format); - // Add books to search choice panel - void CreateSearch(); + // For compatibility + void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString); - // Updates "merged index" structure that combines indexes of all books - // into better searchable structure - void UpdateMergedIndex(); + // Make the help controller's frame 'modal' if + // needed + void AddGrabIfNeeded(); - // Add custom buttons to toolbar - virtual void AddToolbarButtons(wxToolBar *toolBar, int style); + // Override to add custom buttons to the toolbar + virtual void AddToolbarButtons(wxToolBar* WXUNUSED(toolBar), int WXUNUSED(style)) {}; - // Displays options dialog (fonts etc.) - virtual void OptionsDialog(); +protected: + void Init(wxHtmlHelpData* data = NULL); - void OnToolbar(wxCommandEvent& event); - void OnContentsSel(wxTreeEvent& event); - void OnIndexSel(wxCommandEvent& event); - void OnIndexFind(wxCommandEvent& event); - void OnIndexAll(wxCommandEvent& event); - void OnSearchSel(wxCommandEvent& event); - void OnSearch(wxCommandEvent& event); - void OnBookmarksSel(wxCommandEvent& event); void OnCloseWindow(wxCloseEvent& event); void OnActivate(wxActivateEvent& event); @@ -190,55 +127,10 @@ 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; - wxPanel *m_NavigPan; - wxNotebook *m_NavigNotebook; - wxTreeCtrl *m_ContentsBox; - wxTextCtrl *m_IndexText; - wxButton *m_IndexButton; - wxButton *m_IndexButtonAll; - wxListBox *m_IndexList; - wxTextCtrl *m_SearchText; - wxButton *m_SearchButton; - wxListBox *m_SearchList; - wxChoice *m_SearchChoice; - wxStaticText *m_IndexCountInfo; - wxCheckBox *m_SearchCaseSensitive; - wxCheckBox *m_SearchWholeWords; - - wxComboBox *m_Bookmarks; - wxArrayString m_BookmarksNames, m_BookmarksPages; - - 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; - - // lists of available fonts (used in options dialog) - wxArrayString *m_NormalFonts, *m_FixedFonts; - int m_FontSize; // 0,1,2 = small,medium,big - wxString m_NormalFace, m_FixedFace; - - bool m_UpdateContents; - -#if wxUSE_PRINTING_ARCHITECTURE - wxHtmlEasyPrinting *m_Printer; -#endif - wxHashTable *m_PagesHash; - wxHelpControllerBase* m_helpController; - - int m_hfStyle; + wxHtmlHelpWindow *m_HtmlHelpWin; + wxHtmlHelpController* m_helpController; private: - void DisplayIndexItem(const wxHtmlHelpMergedIndexItem *it); - wxHtmlHelpMergedIndex *m_mergedIndex; DECLARE_EVENT_TABLE() DECLARE_NO_COPY_CLASS(wxHtmlHelpFrame) diff --git a/include/wx/html/helpwin.h b/include/wx/html/helpwin.h new file mode 100644 index 0000000000..a991a87b94 --- /dev/null +++ b/include/wx/html/helpwin.h @@ -0,0 +1,286 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: helpwin.h +// Purpose: wxHtmlHelpWindow +// Notes: Based on htmlhelp.cpp, implementing a monolithic +// HTML Help controller class, by Vaclav Slavik +// Author: Harm van der Heijden and Vaclav Slavik +// RCS-ID: $Id$ +// Copyright: (c) Harm van der Heijden and Vaclav Slavik +// Licence: wxWindows licence +///////////////////////////////////////////////////////////////////////////// + +#ifndef _WX_HELPWIN_H_ +#define _WX_HELPWIN_H_ + +#include "wx/defs.h" + +#if wxUSE_WXHTML_HELP + +#include "wx/helpbase.h" +#include "wx/html/helpdata.h" +#include "wx/window.h" +#include "wx/frame.h" +#include "wx/config.h" +#include "wx/splitter.h" +#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/htmprint.h" + +class WXDLLIMPEXP_CORE wxButton; +class WXDLLIMPEXP_CORE wxTextCtrl; +class WXDLLIMPEXP_CORE wxTreeEvent; +class WXDLLIMPEXP_CORE wxTreeCtrl; + +// 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 wxHtmlHelpFrameCfg +{ + int x, y, w, h; + long sashpos; + bool navig_on; +}; + +struct wxHtmlHelpMergedIndexItem; +class wxHtmlHelpMergedIndex; + +class WXDLLIMPEXP_CORE wxHelpControllerBase; +class WXDLLIMPEXP_HTML wxHtmlHelpController; + +class WXDLLIMPEXP_HTML wxHtmlHelpWindow : public wxWindow +{ + DECLARE_DYNAMIC_CLASS(wxHtmlHelpWindow) + +public: + wxHtmlHelpWindow(wxHtmlHelpData* data = NULL) { Init(data); } + wxHtmlHelpWindow(wxWindow* parent, wxWindowID wxWindowID, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int style = wxTAB_TRAVERSAL|wxNO_BORDER, + int helpStyle = wxHF_DEFAULT_STYLE, + wxHtmlHelpData* data = NULL); + bool Create(wxWindow* parent, wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int style = wxTAB_TRAVERSAL|wxNO_BORDER, + int helpStyle = wxHF_DEFAULT_STYLE); + ~wxHtmlHelpWindow(); + + wxHtmlHelpData* GetData() { return m_Data; } + wxHtmlHelpController* GetController() const { return m_helpController; } + void SetController(wxHtmlHelpController* controller); + + // 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 wxString& x); + + // Alternative version that works with numeric ID. + // (uses extension to MS format, , see docs) + bool Display(const int id); + + // Displays help window and focuses contents. + bool DisplayContents(); + + // Displays help window and focuses index. + bool DisplayIndex(); + + // 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 + bool KeywordSearch(const wxString& keyword, + wxHelpSearchMode mode = wxHELP_SEARCH_ALL); + + void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString) + { + m_Config = config; + m_ConfigRoot = rootpath; + ReadCustomization(config, rootpath); + } + + // 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 ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); + void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString); + + // call this to let wxHtmlHelpWindow know page changed + void NotifyPageChanged(); + + // Refreshes Contents and Index tabs + void RefreshLists(); + + // Gets the HTML window + wxHtmlWindow* GetHtmlWindow() const { return m_HtmlWin; } + + // Gets the splitter window + wxSplitterWindow* GetSplitterWindow() const { return m_Splitter; } + + // Gets the toolbar + wxToolBar* GetToolBar() const { return m_toolBar; } + + // Gets the configuration data + wxHtmlHelpFrameCfg& GetCfgData() { return m_Cfg; } + + // Gets the tree control + wxTreeCtrl *GetTreeCtrl() const { return m_ContentsBox; } + +protected: + void Init(wxHtmlHelpData* data = NULL); + + // Adds items to m_Contents tree control + void CreateContents(); + + // Adds items to m_IndexList + void CreateIndex(); + + // Add books to search choice panel + void CreateSearch(); + + // Updates "merged index" structure that combines indexes of all books + // into better searchable structure + void UpdateMergedIndex(); + + // Add custom buttons to toolbar + virtual void AddToolbarButtons(wxToolBar *toolBar, int style); + + // Displays options dialog (fonts etc.) + virtual void OptionsDialog(); + + void OnToolbar(wxCommandEvent& event); + void OnContentsSel(wxTreeEvent& event); + void OnIndexSel(wxCommandEvent& event); + void OnIndexFind(wxCommandEvent& event); + void OnIndexAll(wxCommandEvent& event); + void OnSearchSel(wxCommandEvent& event); + void OnSearch(wxCommandEvent& event); + void OnBookmarksSel(wxCommandEvent& event); + void OnSize(wxSizeEvent& event); + + // Images: + enum { + 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; + wxPanel *m_NavigPan; + wxNotebook *m_NavigNotebook; + wxTreeCtrl *m_ContentsBox; + wxTextCtrl *m_IndexText; + wxButton *m_IndexButton; + wxButton *m_IndexButtonAll; + wxListBox *m_IndexList; + wxTextCtrl *m_SearchText; + wxButton *m_SearchButton; + wxListBox *m_SearchList; + wxChoice *m_SearchChoice; + wxStaticText *m_IndexCountInfo; + wxCheckBox *m_SearchCaseSensitive; + wxCheckBox *m_SearchWholeWords; + wxToolBar* m_toolBar; + + wxComboBox *m_Bookmarks; + wxArrayString m_BookmarksNames, m_BookmarksPages; + + 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; + + // lists of available fonts (used in options dialog) + wxArrayString *m_NormalFonts, *m_FixedFonts; + int m_FontSize; // 0,1,2 = small,medium,big + wxString m_NormalFace, m_FixedFace; + + bool m_UpdateContents; + +#if wxUSE_PRINTING_ARCHITECTURE + wxHtmlEasyPrinting *m_Printer; +#endif + wxHashTable *m_PagesHash; + wxHtmlHelpController* m_helpController; + + int m_hfStyle; + +private: + void DisplayIndexItem(const wxHtmlHelpMergedIndexItem *it); + wxHtmlHelpMergedIndex *m_mergedIndex; + + DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxHtmlHelpWindow) +}; + +class WXDLLIMPEXP_HTML wxHtmlWindowEvent: public wxNotifyEvent +{ +public: + wxHtmlWindowEvent(wxEventType commandType = wxEVT_NULL, int id = 0): + wxNotifyEvent(commandType, id) + { + + } + + void SetURL(const wxString& url) { m_url = url; } + const wxString& GetURL() const { return m_url; } + +private: + wxString m_url; + + DECLARE_DYNAMIC_CLASS(wxHtmlWindowEvent); +}; + +typedef void (wxEvtHandler::*wxHtmlWindowEventFunction)(wxHtmlWindowEvent&); + +BEGIN_DECLARE_EVENT_TYPES() + DECLARE_EVENT_TYPE(wxEVT_COMMAND_HTMLWINDOW_URL_CLICKED, 1000) +END_DECLARE_EVENT_TYPES() + +#define EVT_HTMLWINDOW_URL_CLICKED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_HTMLWINDOW_URL_CLICKED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxHtmlWindowEventFunction) & fn, (wxObject *) NULL ), + +#endif // wxUSE_WXHTML_HELP + +#endif diff --git a/samples/help/demo.cpp b/samples/help/demo.cpp index 2256106012..da378e4093 100644 --- a/samples/help/demo.cpp +++ b/samples/help/demo.cpp @@ -126,6 +126,9 @@ public: #if wxUSE_MS_HTML_HELP && wxUSE_WXHTML_HELP && !defined(__WXUNIVERSAL__) void OnBestHelp(wxCommandEvent& event); #endif +#if USE_HTML_HELP + void OnModalHtmlHelp(wxCommandEvent& event); +#endif void OnShowContextHelp(wxCommandEvent& event); void OnShowDialogContextHelp(wxCommandEvent& event); @@ -137,6 +140,8 @@ private: #if USE_HTML_HELP wxHtmlHelpController m_advancedHtmlHelp; + wxHtmlHelpController m_embeddedHtmlHelp; + wxHtmlHelpWindow* m_embeddedHelpWindow; #endif #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__) @@ -190,6 +195,7 @@ enum HelpDemo_Advanced_Html_Help_Functions, HelpDemo_Advanced_Html_Help_Help, HelpDemo_Advanced_Html_Help_Search, + HelpDemo_Advanced_Html_Help_Modal, HelpDemo_MS_Html_Help_Index, HelpDemo_MS_Html_Help_Classes, @@ -232,6 +238,9 @@ BEGIN_EVENT_TABLE(MyFrame, wxFrame) EVT_MENU(HelpDemo_Advanced_Html_Help_Functions, MyFrame::OnAdvancedHtmlHelp) EVT_MENU(HelpDemo_Advanced_Html_Help_Help, MyFrame::OnAdvancedHtmlHelp) EVT_MENU(HelpDemo_Advanced_Html_Help_Search, MyFrame::OnAdvancedHtmlHelp) +#if USE_HTML_HELP + EVT_MENU(HelpDemo_Advanced_Html_Help_Modal, MyFrame::OnModalHtmlHelp) +#endif #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__) EVT_MENU(HelpDemo_MS_Html_Help_Index, MyFrame::OnMSHtmlHelp) @@ -370,6 +379,9 @@ int MyApp::OnExit() // frame constructor MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) : wxFrame((wxFrame *)NULL, 300, title, pos, size) +#if USE_HTML_HELP + , m_embeddedHtmlHelp(wxHF_EMBEDDED|wxHF_DEFAULT_STYLE) +#endif { // set the frame icon SetIcon(wxICON(mondrian)); @@ -391,6 +403,7 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) menuFile->Append(HelpDemo_Advanced_Html_Help_Functions, _T("Advanced HTML &Help on Functions...")); menuFile->Append(HelpDemo_Advanced_Html_Help_Help, _T("Advanced HTML &About Help Demo...")); menuFile->Append(HelpDemo_Advanced_Html_Help_Search, _T("Advanced HTML &Search help...")); + menuFile->Append(HelpDemo_Advanced_Html_Help_Modal, _T("Advanced HTML Help &Modal Dialog...")); #endif #if wxUSE_MS_HTML_HELP && !defined(__WXUNIVERSAL__) @@ -431,6 +444,18 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) SetStatusText(_T("Welcome to wxWidgets!")); #endif // wxUSE_STATUSBAR +#if USE_HTML_HELP + // Create embedded HTML Help window + m_embeddedHelpWindow = new wxHtmlHelpWindow; + // m_embeddedHtmlHelp.UseConfig(config, rootPath); // Can set your own config object here + m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow); + + m_embeddedHelpWindow->Create(this, + wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE); + + m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip"))); + m_embeddedHtmlHelp.Display(_T("Introduction")); +#else // now create some controls // a panel first - if there were several controls, it would allow us to @@ -442,6 +467,7 @@ MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size) // and a static control whose parent is the panel wxStaticText* staticText = new wxStaticText(panel, 302, _T("Hello, world!"), wxPoint(10, 10)); staticText->SetHelpText(_("This static text control isn't doing a lot right now.")); +#endif } @@ -492,6 +518,13 @@ void MyFrame::OnBestHelp(wxCommandEvent& event) } #endif +#if USE_HTML_HELP +void MyFrame::OnModalHtmlHelp(wxCommandEvent& WXUNUSED(event)) +{ + wxHtmlModalHelp modalHelp(this, wxT("doc.zip"), wxT("Introduction")); +} +#endif + /* Notes: ShowHelp uses section ids for displaying particular topics, but you might want to use a unique keyword to display a topic, instead. diff --git a/src/html/helpctrl.cpp b/src/html/helpctrl.cpp index c52512ab36..cbb26b1b55 100644 --- a/src/html/helpctrl.cpp +++ b/src/html/helpctrl.cpp @@ -23,19 +23,16 @@ #include "wx/intl.h" #endif // WX_PRECOMP -#include "wx/html/helpctrl.h" #include "wx/busyinfo.h" - -#ifdef __WXGTK__ - // for the hack in AddGrabIfNeeded() - #include "wx/dialog.h" -#endif // __WXGTK__ +#include "wx/html/helpctrl.h" +#include "wx/html/helpwin.h" +#include "wx/html/helpfrm.h" +#include "wx/html/helpdlg.h" #if wxUSE_HELP #include "wx/tipwin.h" #endif - #if wxUSE_LIBMSPACK #include "wx/html/forcelnk.h" FORCE_LINK(wxhtml_chm_support) @@ -46,7 +43,7 @@ IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpController, wxHelpControllerBase) wxHtmlHelpController::wxHtmlHelpController(int style, wxWindow* parentWindow): wxHelpControllerBase(parentWindow) { - m_helpFrame = NULL; + m_helpWindow = NULL; m_Config = NULL; m_ConfigRoot = wxEmptyString; m_titleFormat = _("Help: %s"); @@ -57,35 +54,67 @@ wxHtmlHelpController::~wxHtmlHelpController() { if (m_Config) WriteCustomization(m_Config, m_ConfigRoot); - if (m_helpFrame) + if (m_helpWindow) DestroyHelpWindow(); } void wxHtmlHelpController::DestroyHelpWindow() { - //if (m_Config) WriteCustomization(m_Config, m_ConfigRoot); - if (m_helpFrame) - m_helpFrame->Destroy(); + if (m_FrameStyle & wxHF_EMBEDDED) + return; + + // Find top-most parent window + // If a modal dialog + wxWindow* parent = FindTopLevelWindow(); + if (parent) + { + wxDialog* dialog = wxDynamicCast(parent, wxDialog); + if (dialog && dialog->IsModal()) + { + dialog->EndModal(wxID_OK); + } + parent->Destroy(); + m_helpWindow = NULL; + } } void wxHtmlHelpController::OnCloseFrame(wxCloseEvent& evt) { + if (m_Config) + WriteCustomization(m_Config, m_ConfigRoot); + evt.Skip(); OnQuit(); - m_helpFrame->SetController((wxHelpControllerBase*) NULL); - m_helpFrame = NULL; + m_helpWindow->SetController(NULL); + m_helpWindow = NULL; } void wxHtmlHelpController::SetTitleFormat(const wxString& title) { m_titleFormat = title; - if (m_helpFrame) - m_helpFrame->SetTitleFormat(title); + wxHtmlHelpFrame* frame = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpFrame); + wxHtmlHelpDialog* dialog = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpDialog); + if (frame) + { + frame->SetTitleFormat(title); + } + else if (dialog) + dialog->SetTitleFormat(title); } +// Find the top-most parent window +wxWindow* wxHtmlHelpController::FindTopLevelWindow() +{ + wxWindow* parent = m_helpWindow; + while (parent && !parent->IsTopLevel()) + { + parent = parent->GetParent(); + } + return parent; +} bool wxHtmlHelpController::AddBook(const wxFileName& book_file, bool show_wait_msg) { @@ -111,25 +140,40 @@ bool wxHtmlHelpController::AddBook(const wxString& book, bool show_wait_msg) #else wxUnusedVar(show_wait_msg); #endif - if (m_helpFrame) - m_helpFrame->RefreshLists(); + if (m_helpWindow) + m_helpWindow->RefreshLists(); return retval; } - - -wxHtmlHelpFrame *wxHtmlHelpController::CreateHelpFrame(wxHtmlHelpData *data) +wxHtmlHelpFrame* wxHtmlHelpController::CreateHelpFrame(wxHtmlHelpData *data) { - return new wxHtmlHelpFrame(data); + wxHtmlHelpFrame* frame = new wxHtmlHelpFrame(data); + frame->SetController(this); + frame->SetTitleFormat(m_titleFormat); + frame->Create(m_parentWindow, -1, wxEmptyString, m_FrameStyle); + return frame; } +wxHtmlHelpDialog* wxHtmlHelpController::CreateHelpDialog(wxHtmlHelpData *data) +{ + wxHtmlHelpDialog* dialog = new wxHtmlHelpDialog(data); + dialog->SetController(this); + dialog->SetTitleFormat(m_titleFormat); + dialog->Create(m_parentWindow, -1, wxEmptyString, m_FrameStyle); + return dialog; +} -void wxHtmlHelpController::CreateHelpWindow() +wxWindow* wxHtmlHelpController::CreateHelpWindow() { - if (m_helpFrame) + if (m_helpWindow) { - m_helpFrame->Raise(); - return ; + if (m_FrameStyle & wxHF_EMBEDDED) + return m_helpWindow; + + wxWindow* topLevelWindow = FindTopLevelWindow(); + if (topLevelWindow) + topLevelWindow->Raise(); + return m_helpWindow; } if (m_Config == NULL) @@ -139,38 +183,46 @@ void wxHtmlHelpController::CreateHelpWindow() m_ConfigRoot = _T("wxWindows/wxHtmlHelpController"); } - m_helpFrame = CreateHelpFrame(&m_helpData); - m_helpFrame->SetController(this); - - if (m_Config) - m_helpFrame->UseConfig(m_Config, m_ConfigRoot); - - m_helpFrame->Create(GetParentWindow(), wxID_HTML_HELPFRAME, wxEmptyString, m_FrameStyle); - m_helpFrame->SetTitleFormat(m_titleFormat); + if (m_FrameStyle & wxHF_DIALOG) + { + wxHtmlHelpDialog* dialog = CreateHelpDialog(&m_helpData); + m_helpWindow = dialog->GetHelpWindow(); + } + else if ((m_FrameStyle & wxHF_EMBEDDED) && m_parentWindow) + { + m_helpWindow = new wxHtmlHelpWindow(m_parentWindow, -1, wxDefaultPosition, wxDefaultSize, + wxTAB_TRAVERSAL|wxNO_BORDER, m_FrameStyle, &m_helpData); + } + else // wxHF_FRAME + { + wxHtmlHelpFrame* frame = CreateHelpFrame(&m_helpData); + m_helpWindow = frame->GetHelpWindow(); + frame->Show(true); + } - m_helpFrame->Show(true); + return m_helpWindow; } 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 && cfg) - m_helpFrame->ReadCustomization(cfg, path); + if (m_helpWindow && cfg) + m_helpWindow->ReadCustomization(cfg, path); } void wxHtmlHelpController::WriteCustomization(wxConfigBase* cfg, const wxString& path) { /* typically called by the controllers OnCloseFrame handler */ - if (m_helpFrame && cfg) - m_helpFrame->WriteCustomization(cfg, path); + if (m_helpWindow && cfg) + m_helpWindow->WriteCustomization(cfg, path); } void wxHtmlHelpController::UseConfig(wxConfigBase *config, const wxString& rootpath) { m_Config = config; m_ConfigRoot = rootpath; - if (m_helpFrame) m_helpFrame->UseConfig(config, rootpath); + if (m_helpWindow) m_helpWindow->UseConfig(config, rootpath); ReadCustomization(config, rootpath); } @@ -243,16 +295,25 @@ bool wxHtmlHelpController::DisplayTextPopup(const wxString& text, const wxPoint& return false; } +void wxHtmlHelpController::SetHelpWindow(wxHtmlHelpWindow* helpWindow) +{ + m_helpWindow = helpWindow; + if (helpWindow) + helpWindow->SetController(this); +} + void wxHtmlHelpController::SetFrameParameters(const wxString& title, const wxSize& size, const wxPoint& pos, bool WXUNUSED(newFrameEachTime)) { SetTitleFormat(title); - if (m_helpFrame) - { - m_helpFrame->SetSize(pos.x, pos.y, size.x, size.y); - } + wxHtmlHelpFrame* frame = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpFrame); + wxHtmlHelpDialog* dialog = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpDialog); + if (frame) + frame->SetSize(pos.x, pos.y, size.x, size.y); + else if (dialog) + dialog->SetSize(pos.x, pos.y, size.x, size.y); } wxFrame* wxHtmlHelpController::GetFrameParameters(wxSize *size, @@ -261,11 +322,26 @@ wxFrame* wxHtmlHelpController::GetFrameParameters(wxSize *size, { if (newFrameEachTime) (* newFrameEachTime) = false; - if (size && m_helpFrame) - (* size) = m_helpFrame->GetSize(); - if (pos && m_helpFrame) - (* pos) = m_helpFrame->GetPosition(); - return m_helpFrame; + + wxHtmlHelpFrame* frame = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpFrame); + wxHtmlHelpDialog* dialog = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpDialog); + if (frame) + { + if (size) + (* size) = frame->GetSize(); + if (pos) + (* pos) = frame->GetPosition(); + return frame; + } + else if (dialog) + { + if (size) + (* size) = dialog->GetSize(); + if (pos) + (* pos) = dialog->GetPosition(); + return NULL; + } + return NULL; } bool wxHtmlHelpController::Quit() @@ -276,59 +352,50 @@ bool wxHtmlHelpController::Quit() // Make the help controller's frame 'modal' if // needed -void wxHtmlHelpController::AddGrabIfNeeded() +void wxHtmlHelpController::MakeModalIfNeeded() { - // 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() ) + if ((m_FrameStyle & wxHF_EMBEDDED) == 0) { - wxWindow *win = node->GetData(); - wxDialog *dialog = wxDynamicCast(win, wxDialog); - - if (dialog && dialog->IsModal()) - needGrab = true; + wxHtmlHelpFrame* frame = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpFrame); + wxHtmlHelpDialog* dialog = wxDynamicCast(FindTopLevelWindow(), wxHtmlHelpDialog); + if (frame) + frame->AddGrabIfNeeded(); + else if (dialog && (m_FrameStyle & wxHF_MODAL)) + { + dialog->ShowModal(); + } } - - if (needGrab && m_helpFrame) - m_helpFrame->AddGrab(); -#endif // __WXGTK__ } bool wxHtmlHelpController::Display(const wxString& x) { CreateHelpWindow(); - bool success = m_helpFrame->Display(x); - AddGrabIfNeeded(); + bool success = m_helpWindow->Display(x); + MakeModalIfNeeded(); return success; } bool wxHtmlHelpController::Display(int id) { CreateHelpWindow(); - bool success = m_helpFrame->Display(id); - AddGrabIfNeeded(); + bool success = m_helpWindow->Display(id); + MakeModalIfNeeded(); return success; } bool wxHtmlHelpController::DisplayContents() { CreateHelpWindow(); - bool success = m_helpFrame->DisplayContents(); - AddGrabIfNeeded(); + bool success = m_helpWindow->DisplayContents(); + MakeModalIfNeeded(); return success; } bool wxHtmlHelpController::DisplayIndex() { CreateHelpWindow(); - bool success = m_helpFrame->DisplayIndex(); - AddGrabIfNeeded(); + bool success = m_helpWindow->DisplayIndex(); + MakeModalIfNeeded(); return success; } @@ -336,10 +403,31 @@ bool wxHtmlHelpController::KeywordSearch(const wxString& keyword, wxHelpSearchMode mode) { CreateHelpWindow(); - bool success = m_helpFrame->KeywordSearch(keyword, mode); - AddGrabIfNeeded(); + bool success = m_helpWindow->KeywordSearch(keyword, mode); + MakeModalIfNeeded(); return success; } +/* + * wxHtmlModalHelp + * A convenience class, to use like this: + * + * wxHtmlModalHelp help(parent, helpFile, topic); + */ + +wxHtmlModalHelp::wxHtmlModalHelp(wxWindow* parent, const wxString& helpFile, const wxString& topic, int style) +{ + // Force some mandatory styles + style |= wxHF_DIALOG | wxHF_MODAL; + + wxHtmlHelpController controller(style, parent); + controller.Initialize(helpFile); + + if (topic.IsEmpty()) + controller.DisplayContents(); + else + controller.DisplaySection(topic); +} + #endif // wxUSE_WXHTML_HELP diff --git a/src/html/helpdlg.cpp b/src/html/helpdlg.cpp new file mode 100644 index 0000000000..d8d72d9afc --- /dev/null +++ b/src/html/helpdlg.cpp @@ -0,0 +1,140 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: helpdlg.cpp +// Purpose: wxHtmlHelpDialog +// Notes: Based on htmlhelp.cpp, implementing a monolithic +// HTML Help controller class, by Vaclav Slavik +// Author: Harm van der Heijden, Vaclav Slavik and Julian Smart +// RCS-ID: $Id$ +// Copyright: (c) Harm van der Heijden, Vaclav Slavik and Julian Smart +// Licence: wxWidgets licence +///////////////////////////////////////////////////////////////////////////// + +#if defined(__GNUG__) && !defined(__APPLE__) +#pragma implementation "helpdlgex.h" +#endif + +// For compilers that support precompilation, includes "wx.h" +#include "wx/wxprec.h" + +#ifdef __BORLANDC__ +#pragma hdrstop +#endif + +#if wxUSE_WXHTML_HELP + +#ifndef WXPRECOMP + #include "wx/intl.h" + #include "wx/log.h" + + #include "wx/object.h" + #include "wx/sizer.h" + + #include "wx/bmpbuttn.h" + #include "wx/statbox.h" + #include "wx/radiobox.h" +#endif // WXPRECOMP + +#ifdef __WXMAC__ + #include "wx/menu.h" + #include "wx/msgdlg.h" +#endif + +#include "wx/html/htmlwin.h" +#include "wx/html/helpdlg.h" +#include "wx/html/helpctrl.h" +#include "wx/artprov.h" + +IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpDialog, wxDialog) + +BEGIN_EVENT_TABLE(wxHtmlHelpDialog, wxDialog) + EVT_CLOSE(wxHtmlHelpDialog::OnCloseWindow) +END_EVENT_TABLE() + +wxHtmlHelpDialog::wxHtmlHelpDialog(wxWindow* parent, wxWindowID id, const wxString& title, + int style, wxHtmlHelpData* data) +{ + Init(data); + Create(parent, id, title, style); +} + +void wxHtmlHelpDialog::Init(wxHtmlHelpData* data) +{ + // Simply pass the pointer on to the help window + m_Data = data; + m_HtmlHelpWin = NULL; + m_helpController = NULL; +} + +// Create: builds the GUI components. +bool wxHtmlHelpDialog::Create(wxWindow* parent, wxWindowID id, + const wxString& WXUNUSED(title), int style) +{ + m_HtmlHelpWin = new wxHtmlHelpWindow(m_Data); + + wxDialog::Create(parent, id, _("Help"), + wxPoint(m_HtmlHelpWin->GetCfgData().x, m_HtmlHelpWin->GetCfgData().y), + wxSize(m_HtmlHelpWin->GetCfgData().w, m_HtmlHelpWin->GetCfgData().h), + wxDEFAULT_FRAME_STYLE|wxRESIZE_BORDER, wxT("wxHtmlHelp")); + m_HtmlHelpWin->Create(this, -1, wxDefaultPosition, GetClientSize(), + wxTAB_TRAVERSAL|wxNO_BORDER, style); + + GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData()).y); + + SetIcon(wxArtProvider::GetIcon(wxART_HELP, wxART_HELP_BROWSER)); + + wxWindow* item1 = this; + wxBoxSizer* item2 = new wxBoxSizer(wxVERTICAL); + item1->SetSizer(item2); + item1->SetAutoLayout(true); + + wxWindow* item3 = m_HtmlHelpWin; + item2->Add(item3, 1, wxGROW|wxALL, 5); + + wxBoxSizer* item4 = new wxBoxSizer(wxHORIZONTAL); + item2->Add(item4, 0, wxGROW, 5); + + item4->Add(5, 5, 1, wxALIGN_CENTER_VERTICAL|wxALL, 5); + + wxButton* item6 = new wxButton(item1, wxID_OK, _("&Close"), wxDefaultPosition, wxDefaultSize, 0); + item4->Add(item6, 0, wxALIGN_CENTER_VERTICAL|wxALL, 10); +#ifdef __WXMAC__ + // Add some space for the resize handle + item4->Add(5, 5, 0, wxALIGN_CENTER_VERTICAL, 0); +#endif + + Layout(); + Centre(); + + return true; +} + +wxHtmlHelpDialog::~wxHtmlHelpDialog() +{ +} + +void wxHtmlHelpDialog::SetTitleFormat(const wxString& format) +{ + m_TitleFormat = format; +} + +void wxHtmlHelpDialog::OnCloseWindow(wxCloseEvent& evt) +{ + if (!IsIconized()) + { + GetSize(& (m_HtmlHelpWin->GetCfgData().w), &(m_HtmlHelpWin->GetCfgData().h)); + GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData().y)); + } + + if (m_HtmlHelpWin->GetSplitterWindow() && m_HtmlHelpWin->GetCfgData().navig_on) + m_HtmlHelpWin->GetCfgData().sashpos = m_HtmlHelpWin->GetSplitterWindow()->GetSashPosition(); + + if (m_helpController) + { + m_helpController->OnCloseFrame(evt); + } + + evt.Skip(); +} + +#endif // wxUSE_WXHTML_HELP + diff --git a/src/html/helpfrm.cpp b/src/html/helpfrm.cpp index 3f403439b6..d01182f17f 100644 --- a/src/html/helpfrm.cpp +++ b/src/html/helpfrm.cpp @@ -57,183 +57,17 @@ #include "wx/choicdlg.h" #include "wx/settings.h" -// what is considered "small index"? -#define INDEX_IS_SMALL 100 - -/* Motif defines this as a macro */ -#ifdef Below -#undef Below -#endif - -//-------------------------------------------------------------------------- -// wxHtmlHelpTreeItemData (private) -//-------------------------------------------------------------------------- +IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame) -class wxHtmlHelpTreeItemData : public wxTreeItemData -{ - public: -#if defined(__VISAGECPP__) -// VA needs a default ctor for some reason.... - wxHtmlHelpTreeItemData() : wxTreeItemData() - { m_Id = 0; } +BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame) + EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate) + EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow) +#ifdef __WXMAC__ + EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose) + EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout) + EVT_MENU(wxID_HELP_CONTENTS, wxHtmlHelpFrame::OnAbout) #endif - wxHtmlHelpTreeItemData(int id) : wxTreeItemData() - { m_Id = id;} - - int m_Id; -}; - - -//-------------------------------------------------------------------------- -// wxHtmlHelpHashData (private) -//-------------------------------------------------------------------------- - -class wxHtmlHelpHashData : public wxObject -{ - public: - wxHtmlHelpHashData(int index, wxTreeItemId id) : wxObject() - { m_Index = index; m_Id = id;} - ~wxHtmlHelpHashData() {} - - int m_Index; - wxTreeItemId m_Id; -}; - - -//-------------------------------------------------------------------------- -// wxHtmlHelpHtmlWindow (private) -//-------------------------------------------------------------------------- - -class wxHtmlHelpHtmlWindow : public wxHtmlWindow -{ - public: - wxHtmlHelpHtmlWindow(wxHtmlHelpFrame *fr, wxWindow *parent) - : wxHtmlWindow(parent), m_Frame(fr) - { - SetStandardFonts(); - } - - virtual void OnLinkClicked(const wxHtmlLinkInfo& link) - { - wxHtmlWindow::OnLinkClicked(link); - const wxMouseEvent *e = link.GetEvent(); - if (e == NULL || e->LeftUp()) - m_Frame->NotifyPageChanged(); - } - - // Returns full location with anchor (helper) - static wxString GetOpenedPageWithAnchor(wxHtmlWindow *win) - { - if(!win) - return wxEmptyString; - - wxString an = win->GetOpenedAnchor(); - wxString pg = win->GetOpenedPage(); - if(!an.empty()) - { - pg << wxT("#"); - pg << an; - } - return pg; - } - - private: - wxHtmlHelpFrame *m_Frame; - - DECLARE_NO_COPY_CLASS(wxHtmlHelpHtmlWindow) -}; - - -//--------------------------------------------------------------------------- -// wxHtmlHelpFrame::m_mergedIndex -//--------------------------------------------------------------------------- - -WX_DEFINE_ARRAY_PTR(const wxHtmlHelpDataItem*, wxHtmlHelpDataItemPtrArray); - -struct wxHtmlHelpMergedIndexItem -{ - wxHtmlHelpMergedIndexItem *parent; - wxString name; - wxHtmlHelpDataItemPtrArray items; -}; - -WX_DECLARE_OBJARRAY(wxHtmlHelpMergedIndexItem, wxHtmlHelpMergedIndex); -#include "wx/arrimpl.cpp" -WX_DEFINE_OBJARRAY(wxHtmlHelpMergedIndex) - -void wxHtmlHelpFrame::UpdateMergedIndex() -{ - delete m_mergedIndex; - m_mergedIndex = new wxHtmlHelpMergedIndex; - wxHtmlHelpMergedIndex& merged = *m_mergedIndex; - - const wxHtmlHelpDataItems& items = m_Data->GetIndexArray(); - size_t len = items.size(); - - wxHtmlHelpMergedIndexItem *history[128] = {NULL}; - - for (size_t i = 0; i < len; i++) - { - const wxHtmlHelpDataItem& item = items[i]; - wxASSERT_MSG( item.level < 128, _T("nested index entries too deep") ); - - if (history[item.level] && - history[item.level]->items[0]->name == item.name) - { - // same index entry as previous one, update list of items - history[item.level]->items.Add(&item); - } - else - { - // new index entry - wxHtmlHelpMergedIndexItem *mi = new wxHtmlHelpMergedIndexItem(); - mi->name = item.GetIndentedName(); - mi->items.Add(&item); - mi->parent = (item.level == 0) ? NULL : history[item.level - 1]; - history[item.level] = mi; - merged.Add(mi); - } - } -} - - -//--------------------------------------------------------------------------- -// wxHtmlHelpFrame -//--------------------------------------------------------------------------- - -// Command IDs : -enum -{ - //wxID_HTML_HELPFRAME = wxID_HIGHEST + 1, - wxID_HTML_PANEL = wxID_HIGHEST + 2, - wxID_HTML_BACK, - wxID_HTML_FORWARD, - wxID_HTML_UPNODE, - wxID_HTML_UP, - wxID_HTML_DOWN, - wxID_HTML_PRINT, - wxID_HTML_OPENFILE, - wxID_HTML_OPTIONS, - wxID_HTML_BOOKMARKSLIST, - wxID_HTML_BOOKMARKSADD, - wxID_HTML_BOOKMARKSREMOVE, - wxID_HTML_TREECTRL, - wxID_HTML_INDEXPAGE, - wxID_HTML_INDEXLIST, - wxID_HTML_INDEXTEXT, - wxID_HTML_INDEXBUTTON, - wxID_HTML_INDEXBUTTONALL, - wxID_HTML_NOTEBOOK, - wxID_HTML_SEARCHPAGE, - wxID_HTML_SEARCHTEXT, - wxID_HTML_SEARCHLIST, - wxID_HTML_SEARCHBUTTON, - wxID_HTML_SEARCHCHOICE, - wxID_HTML_COUNTINFO -}; - - -IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpFrame, wxFrame) +END_EVENT_TABLE() wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString& title, int style, wxHtmlHelpData* data) @@ -244,101 +78,29 @@ wxHtmlHelpFrame::wxHtmlHelpFrame(wxWindow* parent, wxWindowID id, const wxString void wxHtmlHelpFrame::Init(wxHtmlHelpData* data) { - if (data) - { - m_Data = data; - m_DataCreated = false; - } else - { - m_Data = new wxHtmlHelpData(); - m_DataCreated = true; - } - - m_ContentsPage = 0; - m_IndexPage = 0; - m_SearchPage = 0; - - m_ContentsBox = NULL; - m_IndexList = NULL; - m_IndexButton = NULL; - m_IndexButtonAll = NULL; - m_IndexText = NULL; - m_SearchList = NULL; - m_SearchButton = NULL; - m_SearchText = NULL; - m_SearchChoice = NULL; - m_IndexCountInfo = NULL; - m_Splitter = NULL; - m_NavigPan = NULL; - m_NavigNotebook = NULL; - m_HtmlWin = NULL; - m_Bookmarks = NULL; - m_SearchCaseSensitive = NULL; - m_SearchWholeWords = NULL; - - m_mergedIndex = NULL; - - m_Config = NULL; - m_ConfigRoot = wxEmptyString; - - m_Cfg.x = m_Cfg.y = wxDefaultCoord; - m_Cfg.w = 700; - m_Cfg.h = 480; - m_Cfg.sashpos = 240; - m_Cfg.navig_on = true; - - m_NormalFonts = m_FixedFonts = NULL; - m_NormalFace = m_FixedFace = wxEmptyString; -#ifdef __WXMSW__ - m_FontSize = 10; -#else - m_FontSize = 14; -#endif - -#if wxUSE_PRINTING_ARCHITECTURE - m_Printer = NULL; -#endif - - m_PagesHash = NULL; - m_UpdateContents = true; - m_helpController = (wxHelpControllerBase*) NULL; + // Simply pass the pointer on to the help window + m_Data = data; + m_HtmlHelpWin = NULL; + m_helpController = (wxHtmlHelpController*) NULL; } // Create: builds the GUI components. -// with the style flag it's possible to toggle the toolbar, contents, index and search -// controls. -// m_HtmlWin will *always* be created, but it's important to realize that -// m_ContentsBox, m_IndexList, m_SearchList, m_SearchButton, m_SearchText and -// m_SearchButton may be NULL. -// moreover, if no contents, index or searchpage is needed, m_Splitter and -// m_NavigPan will be NULL too (with m_HtmlWin directly connected to the frame) - bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, const wxString& WXUNUSED(title), int style) { - m_hfStyle = style; - - wxImageList *ContentsImageList = new wxImageList(16, 16); - ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK, - wxART_HELP_BROWSER, - wxSize(16, 16))); - ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER, - wxART_HELP_BROWSER, - wxSize(16, 16))); - ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE, - wxART_HELP_BROWSER, - wxSize(16, 16))); + m_HtmlHelpWin = new wxHtmlHelpWindow(m_Data); - // Do the config in two steps. We read the HtmlWindow customization after we - // create the window. - if (m_Config) - ReadCustomization(m_Config, m_ConfigRoot); - - wxFrame::Create(parent, id, _("Help"), - wxPoint(m_Cfg.x, m_Cfg.y), wxSize(m_Cfg.w, m_Cfg.h), + wxFrame::Create(parent, id, _("Help"), + wxPoint(m_HtmlHelpWin->GetCfgData().x, m_HtmlHelpWin->GetCfgData().y), + wxSize(m_HtmlHelpWin->GetCfgData().w, m_HtmlHelpWin->GetCfgData().h), wxDEFAULT_FRAME_STYLE, wxT("wxHtmlHelp")); +#if wxUSE_STATUSBAR + CreateStatusBar(); +#endif + m_HtmlHelpWin->Create(this, -1, wxDefaultPosition, wxDefaultSize, + wxTAB_TRAVERSAL|wxNO_BORDER, style); - GetPosition(&m_Cfg.x, &m_Cfg.y); + GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData()).y); SetIcon(wxArtProvider::GetIcon(wxART_HELP, wxART_HELP_BROWSER)); @@ -363,1030 +125,24 @@ bool wxHtmlHelpFrame::Create(wxWindow* parent, wxWindowID id, SetMenuBar(menuBar); #endif - int notebook_page = 0; - -#if wxUSE_STATUSBAR - CreateStatusBar(); -#endif // wxUSE_STATUSBAR - -#if wxUSE_TOOLBAR - // toolbar? - if (style & (wxHF_TOOLBAR | wxHF_FLAT_TOOLBAR)) - { - wxToolBar *toolBar = CreateToolBar(wxNO_BORDER | wxTB_HORIZONTAL | - wxTB_DOCKABLE | - (style & wxHF_FLAT_TOOLBAR ? wxTB_FLAT : 0)); - toolBar->SetMargins( 2, 2 ); - AddToolbarButtons(toolBar, style); - toolBar->Realize(); - } -#endif //wxUSE_TOOLBAR - - wxSizer *navigSizer = NULL; - - if (style & (wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH)) - { - // traditional help controller; splitter window with html page on the - // right and a notebook containing various pages on the left - m_Splitter = new wxSplitterWindow(this); - - m_HtmlWin = new wxHtmlHelpHtmlWindow(this, m_Splitter); - m_NavigPan = new wxPanel(m_Splitter, wxID_ANY); - m_NavigNotebook = new wxNotebook(m_NavigPan, wxID_HTML_NOTEBOOK, - wxDefaultPosition, wxDefaultSize); - - navigSizer = new wxBoxSizer(wxVERTICAL); - navigSizer->Add(m_NavigNotebook, 1, wxEXPAND); - - m_NavigPan->SetSizer(navigSizer); - } - else - { // only html window, no notebook with index,contents etc - m_HtmlWin = new wxHtmlWindow(this); - } - - m_HtmlWin->SetRelatedFrame(this, m_TitleFormat); + m_HtmlHelpWin->GetHtmlWindow()->SetRelatedFrame(this, m_TitleFormat); #if wxUSE_STATUSBAR - m_HtmlWin->SetRelatedStatusBar(0); -#endif // wxUSE_STATUSBAR - if ( m_Config ) - m_HtmlWin->ReadCustomization(m_Config, m_ConfigRoot); - - // contents tree panel? - if ( style & wxHF_CONTENTS ) - { - wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); - wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); - - topsizer->Add(0, 10); - - dummy->SetSizer(topsizer); - - if ( style & wxHF_BOOKMARKS ) - { - m_Bookmarks = new wxComboBox(dummy, wxID_HTML_BOOKMARKSLIST, - wxEmptyString, - wxDefaultPosition, wxDefaultSize, - 0, NULL, wxCB_READONLY | wxCB_SORT); - m_Bookmarks->Append(_("(bookmarks)")); - for (unsigned i = 0; i < m_BookmarksNames.GetCount(); i++) - m_Bookmarks->Append(m_BookmarksNames[i]); - m_Bookmarks->SetSelection(0); - - wxBitmapButton *bmpbt1, *bmpbt2; - bmpbt1 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD, - wxArtProvider::GetBitmap(wxART_ADD_BOOKMARK, - wxART_BUTTON)); - bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE, - wxArtProvider::GetBitmap(wxART_DEL_BOOKMARK, - wxART_BUTTON)); -#if wxUSE_TOOLTIPS - bmpbt1->SetToolTip(_("Add current page to bookmarks")); - bmpbt2->SetToolTip(_("Remove current page from bookmarks")); -#endif // wxUSE_TOOLTIPS - - wxSizer *sizer = new wxBoxSizer(wxHORIZONTAL); - - sizer->Add(m_Bookmarks, 1, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 5); - sizer->Add(bmpbt1, 0, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 2); - sizer->Add(bmpbt2, 0, wxALIGN_CENTRE_VERTICAL, 0); - - topsizer->Add(sizer, 0, wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, 10); - } - - m_ContentsBox = new wxTreeCtrl(dummy, wxID_HTML_TREECTRL, - wxDefaultPosition, wxDefaultSize, -#ifdef __WXGTK20__ - wxSUNKEN_BORDER | - wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT | - wxTR_NO_LINES -#else - wxSUNKEN_BORDER | - wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT | - wxTR_LINES_AT_ROOT + m_HtmlHelpWin->GetHtmlWindow()->SetRelatedStatusBar(0); #endif - ); - - m_ContentsBox->AssignImageList(ContentsImageList); - - topsizer->Add(m_ContentsBox, 1, - wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, - 2); - - m_NavigNotebook->AddPage(dummy, _("Contents")); - m_ContentsPage = notebook_page++; - } - - // index listbox panel? - if ( style & wxHF_INDEX ) - { - wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); - wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); - - dummy->SetSizer(topsizer); - - m_IndexText = new wxTextCtrl(dummy, wxID_HTML_INDEXTEXT, wxEmptyString, - wxDefaultPosition, wxDefaultSize, - wxTE_PROCESS_ENTER); - m_IndexButton = new wxButton(dummy, wxID_HTML_INDEXBUTTON, _("Find")); - m_IndexButtonAll = new wxButton(dummy, wxID_HTML_INDEXBUTTONALL, - _("Show all")); - m_IndexCountInfo = new wxStaticText(dummy, wxID_HTML_COUNTINFO, - wxEmptyString, wxDefaultPosition, - wxDefaultSize, - wxALIGN_RIGHT | wxST_NO_AUTORESIZE); - m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST, - wxDefaultPosition, wxDefaultSize, - 0, NULL, wxLB_SINGLE); - -#if wxUSE_TOOLTIPS - m_IndexButton->SetToolTip(_("Display all index items that contain given substring. Search is case insensitive.")); - m_IndexButtonAll->SetToolTip(_("Show all items in index")); -#endif //wxUSE_TOOLTIPS - - topsizer->Add(m_IndexText, 0, wxEXPAND | wxALL, 10); - wxSizer *btsizer = new wxBoxSizer(wxHORIZONTAL); - btsizer->Add(m_IndexButton, 0, wxRIGHT, 2); - btsizer->Add(m_IndexButtonAll); - topsizer->Add(btsizer, 0, - wxALIGN_RIGHT | wxLEFT | wxRIGHT | wxBOTTOM, 10); - topsizer->Add(m_IndexCountInfo, 0, wxEXPAND | wxLEFT | wxRIGHT, 2); - topsizer->Add(m_IndexList, 1, wxEXPAND | wxALL, 2); - - m_NavigNotebook->AddPage(dummy, _("Index")); - m_IndexPage = notebook_page++; - } - - // search list panel? - if ( style & wxHF_SEARCH ) - { - wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); - wxSizer *sizer = new wxBoxSizer(wxVERTICAL); - - dummy->SetSizer(sizer); - - m_SearchText = new wxTextCtrl(dummy, wxID_HTML_SEARCHTEXT, - wxEmptyString, - wxDefaultPosition, wxDefaultSize, - wxTE_PROCESS_ENTER); - m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE, - wxDefaultPosition, wxSize(125,wxDefaultCoord)); - m_SearchCaseSensitive = new wxCheckBox(dummy, wxID_ANY, _("Case sensitive")); - m_SearchWholeWords = new wxCheckBox(dummy, wxID_ANY, _("Whole words only")); - m_SearchButton = new wxButton(dummy, wxID_HTML_SEARCHBUTTON, _("Search")); -#if wxUSE_TOOLTIPS - m_SearchButton->SetToolTip(_("Search contents of help book(s) for all occurences of the text you typed above")); -#endif //wxUSE_TOOLTIPS - m_SearchList = new wxListBox(dummy, wxID_HTML_SEARCHLIST, - wxDefaultPosition, wxDefaultSize, - 0, NULL, wxLB_SINGLE); - - sizer->Add(m_SearchText, 0, wxEXPAND | wxALL, 10); - sizer->Add(m_SearchChoice, 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 10); - sizer->Add(m_SearchCaseSensitive, 0, wxLEFT | wxRIGHT, 10); - sizer->Add(m_SearchWholeWords, 0, wxLEFT | wxRIGHT, 10); - sizer->Add(m_SearchButton, 0, wxALL | wxALIGN_RIGHT, 8); - sizer->Add(m_SearchList, 1, wxALL | wxEXPAND, 2); - - m_NavigNotebook->AddPage(dummy, _("Search")); - m_SearchPage = notebook_page; - } - - m_HtmlWin->Show(); - - RefreshLists(); - - if ( navigSizer ) - { - navigSizer->SetSizeHints(m_NavigPan); - m_NavigPan->Layout(); - } - - // showtime - if ( m_NavigPan && m_Splitter ) - { - m_Splitter->SetMinimumPaneSize(20); - if ( m_Cfg.navig_on ) - m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - - if ( m_Cfg.navig_on ) - { - m_NavigPan->Show(); - m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - } - else - { - m_NavigPan->Show(false); - m_Splitter->Initialize(m_HtmlWin); - } - } - - // Reduce flicker by updating the splitter pane sizes before the - // frame is shown - wxSizeEvent sizeEvent(GetSize(), GetId()); - ProcessEvent(sizeEvent); - - m_Splitter->UpdateSize(); - return true; } wxHtmlHelpFrame::~wxHtmlHelpFrame() { - delete m_mergedIndex; - - // PopEventHandler(); // wxhtmlhelpcontroller (not any more!) - if (m_DataCreated) - delete m_Data; - if (m_NormalFonts) delete m_NormalFonts; - if (m_FixedFonts) delete m_FixedFonts; - if (m_PagesHash) - { - WX_CLEAR_HASH_TABLE(*m_PagesHash); - delete m_PagesHash; - } -#if wxUSE_PRINTING_ARCHITECTURE - if (m_Printer) delete m_Printer; -#endif -} - - -#if wxUSE_TOOLBAR -void wxHtmlHelpFrame::AddToolbarButtons(wxToolBar *toolBar, int style) -{ - wxBitmap wpanelBitmap = - wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_TOOLBAR); - wxBitmap wbackBitmap = - wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_TOOLBAR); - wxBitmap wforwardBitmap = - wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_TOOLBAR); - wxBitmap wupnodeBitmap = - wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_TOOLBAR); - wxBitmap wupBitmap = - wxArtProvider::GetBitmap(wxART_GO_UP, wxART_TOOLBAR); - wxBitmap wdownBitmap = - wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_TOOLBAR); - wxBitmap wopenBitmap = - wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_TOOLBAR); - wxBitmap wprintBitmap = - wxArtProvider::GetBitmap(wxART_PRINT, wxART_TOOLBAR); - wxBitmap woptionsBitmap = - wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_TOOLBAR); - - wxASSERT_MSG( (wpanelBitmap.Ok() && wbackBitmap.Ok() && - wforwardBitmap.Ok() && wupnodeBitmap.Ok() && - wupBitmap.Ok() && wdownBitmap.Ok() && - wopenBitmap.Ok() && wprintBitmap.Ok() && - woptionsBitmap.Ok()), - wxT("One or more HTML help frame toolbar bitmap could not be loaded.")) ; - - - toolBar->AddTool(wxID_HTML_PANEL, wpanelBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Show/hide navigation panel")); - - toolBar->AddSeparator(); - toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Go back")); - toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Go forward")); - toolBar->AddSeparator(); - - toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Go one level up in document hierarchy")); - toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Previous page")); - toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Next page")); - - if ((style & wxHF_PRINT) || (style & wxHF_OPEN_FILES)) - toolBar->AddSeparator(); - - if (style & wxHF_OPEN_FILES) - toolBar->AddTool(wxID_HTML_OPENFILE, wopenBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Open HTML document")); - -#if wxUSE_PRINTING_ARCHITECTURE - if (style & wxHF_PRINT) - toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Print this page")); -#endif - - toolBar->AddSeparator(); - toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap, - false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, - _("Display options dialog")); } -#endif //wxUSE_TOOLBAR - void wxHtmlHelpFrame::SetTitleFormat(const wxString& format) { - if (m_HtmlWin) - m_HtmlWin->SetRelatedFrame(this, format); + if (GetHelpWindow() && GetHelpWindow()->GetHtmlWindow()) + GetHelpWindow()->GetHtmlWindow()->SetRelatedFrame(this, format); m_TitleFormat = format; } - -bool wxHtmlHelpFrame::Display(const wxString& x) -{ - wxString url = m_Data->FindPageByName(x); - if (!url.empty()) - { - m_HtmlWin->LoadPage(url); - NotifyPageChanged(); - return true; - } - - return false; -} - -bool wxHtmlHelpFrame::Display(const int id) -{ - wxString url = m_Data->FindPageById(id); - if (!url.empty()) - { - m_HtmlWin->LoadPage(url); - NotifyPageChanged(); - return true; - } - - return false; -} - - - -bool wxHtmlHelpFrame::DisplayContents() -{ - if (! m_ContentsBox) - return false; - - if (!m_Splitter->IsSplit()) - { - m_NavigPan->Show(); - m_HtmlWin->Show(); - m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - m_Cfg.navig_on = true; - } - - m_NavigNotebook->SetSelection(m_ContentsPage); - - if (m_Data->GetBookRecArray().GetCount() > 0) - { - wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0]; - if (!book.GetStart().empty()) - m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart())); - } - - return true; -} - - - -bool wxHtmlHelpFrame::DisplayIndex() -{ - if (! m_IndexList) - return false; - - if (!m_Splitter->IsSplit()) - { - m_NavigPan->Show(); - m_HtmlWin->Show(); - m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - } - - m_NavigNotebook->SetSelection(m_IndexPage); - - if (m_Data->GetBookRecArray().GetCount() > 0) - { - wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0]; - if (!book.GetStart().empty()) - m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart())); - } - - return true; -} - -void wxHtmlHelpFrame::DisplayIndexItem(const wxHtmlHelpMergedIndexItem *it) -{ - if (it->items.size() == 1) - { - if (!it->items[0]->page.empty()) - { - m_HtmlWin->LoadPage(it->items[0]->GetFullPath()); - NotifyPageChanged(); - } - } - else - { - wxBusyCursor busy_cursor; - - // more pages associated with this index item -- let the user choose - // which one she/he wants from a list: - wxArrayString arr; - size_t len = it->items.size(); - for (size_t i = 0; i < len; i++) - { - wxString page = it->items[i]->page; - // try to find page's title in contents: - const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); - size_t clen = contents.size(); - for (size_t j = 0; j < clen; j++) - { - if (contents[j].page == page) - { - page = contents[j].name; - break; - } - } - arr.push_back(page); - } - - wxSingleChoiceDialog dlg(this, - _("Please choose the page to display:"), - _("Help Topics"), - arr, NULL, wxCHOICEDLG_STYLE & ~wxCENTRE); - if (dlg.ShowModal() == wxID_OK) - { - m_HtmlWin->LoadPage(it->items[dlg.GetSelection()]->GetFullPath()); - NotifyPageChanged(); - } - } -} - - -bool wxHtmlHelpFrame::KeywordSearch(const wxString& keyword, - wxHelpSearchMode mode) -{ - if (mode == wxHELP_SEARCH_ALL) - { - if ( !(m_SearchList && - m_SearchButton && m_SearchText && m_SearchChoice) ) - return false; - } - else if (mode == wxHELP_SEARCH_INDEX) - { - if ( !(m_IndexList && - m_IndexButton && m_IndexButtonAll && m_IndexText) ) - return false; - } - - int foundcnt = 0; - wxString foundstr; - wxString book = wxEmptyString; - - if (!m_Splitter->IsSplit()) - { - m_NavigPan->Show(); - m_HtmlWin->Show(); - m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - } - - if (mode == wxHELP_SEARCH_ALL) - { - m_NavigNotebook->SetSelection(m_SearchPage); - m_SearchList->Clear(); - m_SearchText->SetValue(keyword); - m_SearchButton->Disable(); - - if (m_SearchChoice->GetSelection() != 0) - book = m_SearchChoice->GetStringSelection(); - - wxHtmlSearchStatus status(m_Data, keyword, - m_SearchCaseSensitive->GetValue(), - m_SearchWholeWords->GetValue(), - book); - -#if wxUSE_PROGRESSDLG - wxProgressDialog progress(_("Searching..."), - _("No matching page found yet"), - status.GetMaxIndex(), this, - wxPD_APP_MODAL | wxPD_CAN_ABORT | wxPD_AUTO_HIDE); -#endif - - int curi; - while (status.IsActive()) - { - curi = status.GetCurIndex(); - if (curi % 32 == 0 -#if wxUSE_PROGRESSDLG - && !progress.Update(curi) -#endif - ) - break; - if (status.Search()) - { - foundstr.Printf(_("Found %i matches"), ++foundcnt); -#if wxUSE_PROGRESSDLG - progress.Update(status.GetCurIndex(), foundstr); -#endif - m_SearchList->Append(status.GetName(), (void*)status.GetCurItem()); - } - } - - m_SearchButton->Enable(); - m_SearchText->SetSelection(0, keyword.Length()); - m_SearchText->SetFocus(); - } - else if (mode == wxHELP_SEARCH_INDEX) - { - m_NavigNotebook->SetSelection(m_IndexPage); - m_IndexList->Clear(); - m_IndexButton->Disable(); - m_IndexButtonAll->Disable(); - m_IndexText->SetValue(keyword); - - wxCommandEvent dummy; - OnIndexFind(dummy); // what a hack... - m_IndexButton->Enable(); - m_IndexButtonAll->Enable(); - foundcnt = m_IndexList->GetCount(); - } - - if (foundcnt) - { - switch ( mode ) - { - default: - wxFAIL_MSG( _T("unknown help search mode") ); - // fall back - - case wxHELP_SEARCH_ALL: - { - wxHtmlHelpDataItem *it = - (wxHtmlHelpDataItem*) m_SearchList->GetClientData(0); - if (it) - { - m_HtmlWin->LoadPage(it->GetFullPath()); - NotifyPageChanged(); - } - break; - } - - case wxHELP_SEARCH_INDEX: - { - wxHtmlHelpMergedIndexItem* it = - (wxHtmlHelpMergedIndexItem*) m_IndexList->GetClientData(0); - if (it) - DisplayIndexItem(it); - break; - } - } - - } - - return foundcnt > 0; -} - -void wxHtmlHelpFrame::CreateContents() -{ - if (! m_ContentsBox) - return ; - - if (m_PagesHash) - { - WX_CLEAR_HASH_TABLE(*m_PagesHash); - delete m_PagesHash; - } - - const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); - - size_t cnt = contents.size(); - - m_PagesHash = new wxHashTable(wxKEY_STRING, 2 * cnt); - - const int MAX_ROOTS = 64; - wxTreeItemId roots[MAX_ROOTS]; - // VS: this array holds information about whether we've set item icon at - // given level. This is necessary because m_Data has a flat structure - // and there's no way of recognizing if some item has subitems or not. - // We set the icon later: when we find an item with level=n, we know - // that the last item with level=n-1 was afolder with subitems, so we - // set its icon accordingly - bool imaged[MAX_ROOTS]; - m_ContentsBox->DeleteAllItems(); - - roots[0] = m_ContentsBox->AddRoot(_("(Help)")); - imaged[0] = true; - - for (size_t i = 0; i < cnt; i++) - { - wxHtmlHelpDataItem *it = &contents[i]; - // Handle books: - if (it->level == 0) - { - if (m_hfStyle & wxHF_MERGE_BOOKS) - // VS: we don't want book nodes, books' content should - // appear under tree's root. This line will create a "fake" - // record about book node so that the rest of this look - // will believe there really _is_ a book node and will - // behave correctly. - roots[1] = roots[0]; - else - { - roots[1] = m_ContentsBox->AppendItem(roots[0], - it->name, IMG_Book, -1, - new wxHtmlHelpTreeItemData(i)); - m_ContentsBox->SetItemBold(roots[1], true); - } - imaged[1] = true; - } - // ...and their contents: - else - { - roots[it->level + 1] = m_ContentsBox->AppendItem( - roots[it->level], it->name, IMG_Page, - -1, new wxHtmlHelpTreeItemData(i)); - imaged[it->level + 1] = false; - } - - m_PagesHash->Put(it->GetFullPath(), - new wxHtmlHelpHashData(i, roots[it->level + 1])); - - // Set the icon for the node one level up in the hierarchy, - // unless already done (see comment above imaged[] declaration) - if (!imaged[it->level]) - { - int image = IMG_Folder; - if (m_hfStyle & wxHF_ICONS_BOOK) - image = IMG_Book; - else if (m_hfStyle & wxHF_ICONS_BOOK_CHAPTER) - image = (it->level == 1) ? IMG_Book : IMG_Folder; - m_ContentsBox->SetItemImage(roots[it->level], image); - m_ContentsBox->SetItemImage(roots[it->level], image, - wxTreeItemIcon_Selected); - imaged[it->level] = true; - } - } -} - - -void wxHtmlHelpFrame::CreateIndex() -{ - if (! m_IndexList) - return ; - - m_IndexList->Clear(); - - size_t cnt = m_mergedIndex->size(); - - wxString cnttext; - if (cnt > INDEX_IS_SMALL) - cnttext.Printf(_("%i of %i"), 0, cnt); - else - cnttext.Printf(_("%i of %i"), cnt, cnt); - m_IndexCountInfo->SetLabel(cnttext); - if (cnt > INDEX_IS_SMALL) - return; - - for (size_t i = 0; i < cnt; i++) - m_IndexList->Append((*m_mergedIndex)[i].name, - (char*)(&(*m_mergedIndex)[i])); -} - -void wxHtmlHelpFrame::CreateSearch() -{ - if (! (m_SearchList && m_SearchChoice)) - return ; - m_SearchList->Clear(); - m_SearchChoice->Clear(); - m_SearchChoice->Append(_("Search in all books")); - const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray(); - int i, cnt = bookrec.GetCount(); - for (i = 0; i < cnt; i++) - m_SearchChoice->Append(bookrec[i].GetTitle()); - m_SearchChoice->SetSelection(0); -} - - -void wxHtmlHelpFrame::RefreshLists() -{ - // Update m_mergedIndex: - UpdateMergedIndex(); - // Update the controls - CreateContents(); - CreateIndex(); - CreateSearch(); -} - -void wxHtmlHelpFrame::ReadCustomization(wxConfigBase *cfg, const wxString& path) -{ - wxString oldpath; - wxString tmp; - - if (path != wxEmptyString) - { - oldpath = cfg->GetPath(); - cfg->SetPath(_T("/") + path); - } - - m_Cfg.navig_on = cfg->Read(wxT("hcNavigPanel"), m_Cfg.navig_on) != 0; - m_Cfg.sashpos = cfg->Read(wxT("hcSashPos"), m_Cfg.sashpos); - m_Cfg.x = cfg->Read(wxT("hcX"), m_Cfg.x); - m_Cfg.y = cfg->Read(wxT("hcY"), m_Cfg.y); - m_Cfg.w = cfg->Read(wxT("hcW"), m_Cfg.w); - m_Cfg.h = cfg->Read(wxT("hcH"), m_Cfg.h); - - m_FixedFace = cfg->Read(wxT("hcFixedFace"), m_FixedFace); - m_NormalFace = cfg->Read(wxT("hcNormalFace"), m_NormalFace); - m_FontSize = cfg->Read(wxT("hcBaseFontSize"), m_FontSize); - - { - int i; - int cnt; - wxString val, s; - - cnt = cfg->Read(wxT("hcBookmarksCnt"), 0L); - if (cnt != 0) - { - m_BookmarksNames.Clear(); - m_BookmarksPages.Clear(); - if (m_Bookmarks) - { - m_Bookmarks->Clear(); - m_Bookmarks->Append(_("(bookmarks)")); - } - - for (i = 0; i < cnt; i++) - { - val.Printf(wxT("hcBookmark_%i"), i); - s = cfg->Read(val); - m_BookmarksNames.Add(s); - if (m_Bookmarks) m_Bookmarks->Append(s); - val.Printf(wxT("hcBookmark_%i_url"), i); - s = cfg->Read(val); - m_BookmarksPages.Add(s); - } - } - } - - if (m_HtmlWin) - m_HtmlWin->ReadCustomization(cfg); - - if (path != wxEmptyString) - cfg->SetPath(oldpath); -} - -void wxHtmlHelpFrame::WriteCustomization(wxConfigBase *cfg, const wxString& path) -{ - wxString oldpath; - wxString tmp; - - if (path != wxEmptyString) - { - oldpath = cfg->GetPath(); - cfg->SetPath(_T("/") + path); - } - - cfg->Write(wxT("hcNavigPanel"), m_Cfg.navig_on); - cfg->Write(wxT("hcSashPos"), (long)m_Cfg.sashpos); - if ( !IsIconized() ) - { - // Don't write if iconized as this would make the window - // disappear next time it is shown! - cfg->Write(wxT("hcX"), (long)m_Cfg.x); - cfg->Write(wxT("hcY"), (long)m_Cfg.y); - cfg->Write(wxT("hcW"), (long)m_Cfg.w); - cfg->Write(wxT("hcH"), (long)m_Cfg.h); - } - cfg->Write(wxT("hcFixedFace"), m_FixedFace); - cfg->Write(wxT("hcNormalFace"), m_NormalFace); - cfg->Write(wxT("hcBaseFontSize"), (long)m_FontSize); - - if (m_Bookmarks) - { - int i; - int cnt = m_BookmarksNames.GetCount(); - wxString val; - - cfg->Write(wxT("hcBookmarksCnt"), (long)cnt); - for (i = 0; i < cnt; i++) - { - val.Printf(wxT("hcBookmark_%i"), i); - cfg->Write(val, m_BookmarksNames[i]); - val.Printf(wxT("hcBookmark_%i_url"), i); - cfg->Write(val, m_BookmarksPages[i]); - } - } - - if (m_HtmlWin) - m_HtmlWin->WriteCustomization(cfg); - - if (path != wxEmptyString) - cfg->SetPath(oldpath); -} - - - - - -static void SetFontsToHtmlWin(wxHtmlWindow *win, const wxString& scalf, const wxString& fixf, int size) -{ - int f_sizes[7]; - f_sizes[0] = int(size * 0.6); - f_sizes[1] = int(size * 0.8); - f_sizes[2] = size; - f_sizes[3] = int(size * 1.2); - f_sizes[4] = int(size * 1.4); - f_sizes[5] = int(size * 1.6); - f_sizes[6] = int(size * 1.8); - - win->SetFonts(scalf, fixf, f_sizes); -} - - -class wxHtmlHelpFrameOptionsDialog : public wxDialog -{ -public: - wxComboBox *NormalFont, *FixedFont; - wxSpinCtrl *FontSize; - wxHtmlWindow *TestWin; - - wxHtmlHelpFrameOptionsDialog(wxWindow *parent) - : wxDialog(parent, wxID_ANY, wxString(_("Help Browser Options"))) - { - wxBoxSizer *topsizer = new wxBoxSizer(wxVERTICAL); - wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 3, 2, 5); - - sizer->Add(new wxStaticText(this, wxID_ANY, _("Normal font:"))); - sizer->Add(new wxStaticText(this, wxID_ANY, _("Fixed font:"))); - sizer->Add(new wxStaticText(this, wxID_ANY, _("Font size:"))); - - sizer->Add(NormalFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition, - wxSize(200, wxDefaultCoord), - 0, NULL, wxCB_DROPDOWN | wxCB_READONLY)); - - sizer->Add(FixedFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition, - wxSize(200, wxDefaultCoord), - 0, NULL, wxCB_DROPDOWN | wxCB_READONLY)); - - sizer->Add(FontSize = new wxSpinCtrl(this, wxID_ANY)); - FontSize->SetRange(2, 100); - - topsizer->Add(sizer, 0, wxLEFT|wxRIGHT|wxTOP, 10); - - topsizer->Add(new wxStaticText(this, wxID_ANY, _("Preview:")), - 0, wxLEFT | wxTOP, 10); - topsizer->Add(TestWin = new wxHtmlWindow(this, wxID_ANY, wxDefaultPosition, wxSize(20, 150), - wxHW_SCROLLBAR_AUTO | wxSUNKEN_BORDER), - 1, wxEXPAND | wxLEFT|wxTOP|wxRIGHT, 10); - - wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL); - wxButton *ok; - sizer2->Add(ok = new wxButton(this, wxID_OK), 0, wxALL, 10); - ok->SetDefault(); - sizer2->Add(new wxButton(this, wxID_CANCEL), 0, wxALL, 10); - topsizer->Add(sizer2, 0, wxALIGN_RIGHT); - - SetSizer(topsizer); - topsizer->Fit(this); - Centre(wxBOTH); - } - - - void UpdateTestWin() - { - wxBusyCursor bcur; - SetFontsToHtmlWin(TestWin, - NormalFont->GetStringSelection(), - FixedFont->GetStringSelection(), - FontSize->GetValue()); - - wxString content(_("font size")); - - content = _T("") + content + _T(" -2
") - _T("") + content + _T(" -1
") - _T("") + content + _T(" +0
") - _T("") + content + _T(" +1
") - _T("") + content + _T(" +2
") - _T("") + content + _T(" +3
") - _T("") + content + _T(" +4
") ; - - content = wxString( _T("
") ) + - _("Normal face
and underlined. ") + - _("Italic face. ") + - _("Bold face. ") + - _("Bold italic face.
") + - content + - wxString( _T("		") ) + - _("Fixed size face.
bold italic ") + - _("bold italic underlined
") + - content + - _T("
"); - - TestWin->SetPage( content ); - } - - void OnUpdate(wxCommandEvent& WXUNUSED(event)) - { - UpdateTestWin(); - } - void OnUpdateSpin(wxSpinEvent& WXUNUSED(event)) - { - UpdateTestWin(); - } - - DECLARE_EVENT_TABLE() - DECLARE_NO_COPY_CLASS(wxHtmlHelpFrameOptionsDialog) -}; - -BEGIN_EVENT_TABLE(wxHtmlHelpFrameOptionsDialog, wxDialog) - EVT_COMBOBOX(wxID_ANY, wxHtmlHelpFrameOptionsDialog::OnUpdate) - EVT_SPINCTRL(wxID_ANY, wxHtmlHelpFrameOptionsDialog::OnUpdateSpin) -END_EVENT_TABLE() - -void wxHtmlHelpFrame::OptionsDialog() -{ - wxHtmlHelpFrameOptionsDialog dlg(this); - unsigned i; - - if (m_NormalFonts == NULL) - { - wxFontEnumerator enu; - enu.EnumerateFacenames(); - m_NormalFonts = new wxArrayString; - *m_NormalFonts = *enu.GetFacenames(); - m_NormalFonts->Sort(); // ascending sort - } - if (m_FixedFonts == NULL) - { - wxFontEnumerator enu; - enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, true /*enum fixed width only*/); - m_FixedFonts = new wxArrayString; - *m_FixedFonts = *enu.GetFacenames(); - m_FixedFonts->Sort(); // ascending sort - } - - // VS: We want to show the font that is actually used by wxHtmlWindow. - // If customization dialog wasn't used yet, facenames are empty and - // wxHtmlWindow uses default fonts -- let's find out what they - // are so that we can pass them to the dialog: - if (m_NormalFace.empty()) - { - wxFont fnt(m_FontSize, wxSWISS, wxNORMAL, wxNORMAL, false); - m_NormalFace = fnt.GetFaceName(); - } - if (m_FixedFace.empty()) - { - wxFont fnt(m_FontSize, wxMODERN, wxNORMAL, wxNORMAL, false); - m_FixedFace = fnt.GetFaceName(); - } - - for (i = 0; i < m_NormalFonts->GetCount(); i++) - dlg.NormalFont->Append((*m_NormalFonts)[i]); - for (i = 0; i < m_FixedFonts->GetCount(); i++) - dlg.FixedFont->Append((*m_FixedFonts)[i]); - if (!m_NormalFace.empty()) - dlg.NormalFont->SetStringSelection(m_NormalFace); - else - dlg.NormalFont->SetSelection(0); - if (!m_FixedFace.empty()) - dlg.FixedFont->SetStringSelection(m_FixedFace); - else - dlg.FixedFont->SetSelection(0); - dlg.FontSize->SetValue(m_FontSize); - dlg.UpdateTestWin(); - - if (dlg.ShowModal() == wxID_OK) - { - m_NormalFace = dlg.NormalFont->GetStringSelection(); - m_FixedFace = dlg.FixedFont->GetStringSelection(); - m_FontSize = dlg.FontSize->GetValue(); - SetFontsToHtmlWin(m_HtmlWin, m_NormalFace, m_FixedFace, m_FontSize); - } -} - - - -void wxHtmlHelpFrame::NotifyPageChanged() -{ - if (m_UpdateContents && m_PagesHash) - { - wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin); - wxHtmlHelpHashData *ha = NULL; - if (!page.empty()) - ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page); - - if (ha) - { - bool olduc = m_UpdateContents; - m_UpdateContents = false; - m_ContentsBox->SelectItem(ha->m_Id); - m_ContentsBox->EnsureVisible(ha->m_Id); - m_UpdateContents = olduc; - } - } -} - - - /* EVENT HANDLING : */ @@ -1399,398 +155,70 @@ void wxHtmlHelpFrame::OnActivate(wxActivateEvent& event) #ifndef __WXGTK__ // NB: wxActivateEvent is a bit broken in wxGTK // and is sometimes sent when it should not be - if (event.GetActive() && m_HtmlWin) - m_HtmlWin->SetFocus(); + if (event.GetActive() && m_HtmlHelpWin) + m_HtmlHelpWin->GetHtmlWindow()->SetFocus(); #endif event.Skip(); } -void wxHtmlHelpFrame::OnToolbar(wxCommandEvent& event) +void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt) { - switch (event.GetId()) + if (!IsIconized()) { - case wxID_HTML_BACK : - m_HtmlWin->HistoryBack(); - NotifyPageChanged(); - break; - - case wxID_HTML_FORWARD : - m_HtmlWin->HistoryForward(); - NotifyPageChanged(); - break; - - case wxID_HTML_UP : - if (m_PagesHash) - { - wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin); - wxHtmlHelpHashData *ha = NULL; - if (!page.empty()) - ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page); - if (ha && ha->m_Index > 0) - { - const wxHtmlHelpDataItem& it = m_Data->GetContentsArray()[ha->m_Index - 1]; - if (!it.page.empty()) - { - m_HtmlWin->LoadPage(it.GetFullPath()); - NotifyPageChanged(); - } - } - } - break; - - case wxID_HTML_UPNODE : - if (m_PagesHash) - { - wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin); - wxHtmlHelpHashData *ha = NULL; - if (!page.empty()) - ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page); - if (ha && ha->m_Index > 0) - { - int level = - m_Data->GetContentsArray()[ha->m_Index].level - 1; - int ind = ha->m_Index - 1; - - const wxHtmlHelpDataItem *it = - &m_Data->GetContentsArray()[ind]; - while (ind >= 0 && it->level != level) - { - ind--; - it = &m_Data->GetContentsArray()[ind]; - } - if (ind >= 0) - { - if (!it->page.empty()) - { - m_HtmlWin->LoadPage(it->GetFullPath()); - NotifyPageChanged(); - } - } - } - } - break; - - case wxID_HTML_DOWN : - if (m_PagesHash) - { - wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin); - wxHtmlHelpHashData *ha = NULL; - if (!page.empty()) - ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page); - - const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); - if (ha && ha->m_Index < (int)contents.size() - 1) - { - size_t idx = ha->m_Index + 1; - - while (contents[idx].GetFullPath() == page) idx++; - - if (!contents[idx].page.empty()) - { - m_HtmlWin->LoadPage(contents[idx].GetFullPath()); - NotifyPageChanged(); - } - } - } - break; - - case wxID_HTML_PANEL : - { - if (! (m_Splitter && m_NavigPan)) - return ; - if (m_Splitter->IsSplit()) - { - m_Cfg.sashpos = m_Splitter->GetSashPosition(); - m_Splitter->Unsplit(m_NavigPan); - m_Cfg.navig_on = false; - } - else - { - m_NavigPan->Show(); - m_HtmlWin->Show(); - m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); - m_Cfg.navig_on = true; - } - } - break; - - case wxID_HTML_OPTIONS : - OptionsDialog(); - break; - - case wxID_HTML_BOOKMARKSADD : - { - wxString item; - wxString url; - - item = m_HtmlWin->GetOpenedPageTitle(); - url = m_HtmlWin->GetOpenedPage(); - if (item == wxEmptyString) - item = url.AfterLast(wxT('/')); - if (m_BookmarksPages.Index(url) == wxNOT_FOUND) - { - m_Bookmarks->Append(item); - m_BookmarksNames.Add(item); - m_BookmarksPages.Add(url); - } - } - break; - - case wxID_HTML_BOOKMARKSREMOVE : - { - wxString item; - int pos; - - item = m_Bookmarks->GetStringSelection(); - pos = m_BookmarksNames.Index(item); - if (pos != wxNOT_FOUND) - { - m_BookmarksNames.RemoveAt(pos); - m_BookmarksPages.RemoveAt(pos); - m_Bookmarks->Delete(m_Bookmarks->GetSelection()); - } - } - break; - -#if wxUSE_PRINTING_ARCHITECTURE - case wxID_HTML_PRINT : - { - if (m_Printer == NULL) - m_Printer = new wxHtmlEasyPrinting(_("Help Printing"), this); - if (!m_HtmlWin->GetOpenedPage()) - wxLogWarning(_("Cannot print empty page.")); - else - m_Printer->PrintFile(m_HtmlWin->GetOpenedPage()); - } - break; -#endif - - case wxID_HTML_OPENFILE : - { - wxString filemask = wxString( - _("HTML files (*.html;*.htm)|*.html;*.htm|")) + - _("Help books (*.htb)|*.htb|Help books (*.zip)|*.zip|") + - _("HTML Help Project (*.hhp)|*.hhp|") + -#if wxUSE_LIBMSPACK - _("Compressed HTML Help file (*.chm)|*.chm|") + -#endif - _("All files (*.*)|*"); - wxString s = wxFileSelector(_("Open HTML document"), - wxEmptyString, - wxEmptyString, - wxEmptyString, - filemask, - wxOPEN | wxFILE_MUST_EXIST, - this); - if (!s.empty()) - { - wxString ext = s.Right(4).Lower(); - if (ext == _T(".zip") || ext == _T(".htb") || -#if wxUSE_LIBMSPACK - ext == _T(".chm") || -#endif - ext == _T(".hhp")) - { - wxBusyCursor bcur; - m_Data->AddBook(s); - RefreshLists(); - } - else - m_HtmlWin->LoadPage(s); - } - } - break; + GetSize(& (m_HtmlHelpWin->GetCfgData().w), &(m_HtmlHelpWin->GetCfgData().h)); + GetPosition(& (m_HtmlHelpWin->GetCfgData().x), & (m_HtmlHelpWin->GetCfgData().y)); } -} - - - -void wxHtmlHelpFrame::OnContentsSel(wxTreeEvent& event) -{ - wxHtmlHelpTreeItemData *pg; - pg = (wxHtmlHelpTreeItemData*) m_ContentsBox->GetItemData(event.GetItem()); - - if (pg && m_UpdateContents) +#ifdef __WXGTK__ + if (IsGrabbed()) { - const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); - m_UpdateContents = false; - if (!contents[pg->m_Id].page.empty()) - m_HtmlWin->LoadPage(contents[pg->m_Id].GetFullPath()); - m_UpdateContents = true; + RemoveGrab(); } -} - - - -void wxHtmlHelpFrame::OnIndexSel(wxCommandEvent& WXUNUSED(event)) -{ - wxHtmlHelpMergedIndexItem *it = (wxHtmlHelpMergedIndexItem*) - m_IndexList->GetClientData(m_IndexList->GetSelection()); - if (it) - DisplayIndexItem(it); -} +#endif + if (m_HtmlHelpWin->GetSplitterWindow() && m_HtmlHelpWin->GetCfgData().navig_on) + m_HtmlHelpWin->GetCfgData().sashpos = m_HtmlHelpWin->GetSplitterWindow()->GetSashPosition(); -void wxHtmlHelpFrame::OnIndexFind(wxCommandEvent& event) -{ - wxString sr = m_IndexText->GetLineText(0); - sr.MakeLower(); - if (sr == wxEmptyString) + if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController))) { - OnIndexAll(event); + ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt); } - else - { - wxBusyCursor bcur; - - m_IndexList->Clear(); - const wxHtmlHelpMergedIndex& index = *m_mergedIndex; - size_t cnt = index.size(); - - int displ = 0; - for (size_t i = 0; i < cnt; i++) - { - if (index[i].name.Lower().find(sr) != wxString::npos) - { - int pos = m_IndexList->Append(index[i].name, - (char*)(&index[i])); - - if (displ++ == 0) - { - // don't automatically show topic selector if this - // item points to multiple pages: - if (index[i].items.size() == 1) - { - m_IndexList->SetSelection(0); - DisplayIndexItem(&index[i]); - } - } - - // if this is nested item of the index, show its parent(s) - // as well, otherwise it would not be clear what entry is - // shown: - wxHtmlHelpMergedIndexItem *parent = index[i].parent; - while (parent) - { - if (pos == 0 || - (index.Index(*(wxHtmlHelpMergedIndexItem*)m_IndexList->GetClientData(pos-1))) < index.Index(*parent)) - { - m_IndexList->Insert(parent->name, - pos, (char*)parent); - parent = parent->parent; - } - else break; - } - - // finally, it the item we just added is itself a parent for - // other items, show them as well, because they are refinements - // of the displayed index entry (i.e. it is implicitly contained - // in them: "foo" with parent "bar" reads as "bar, foo"): - int level = index[i].items[0]->level; - i++; - while (i < cnt && index[i].items[0]->level > level) - { - m_IndexList->Append(index[i].name, (char*)(&index[i])); - i++; - } - i--; - } - } - - wxString cnttext; - cnttext.Printf(_("%i of %i"), displ, cnt); - m_IndexCountInfo->SetLabel(cnttext); - m_IndexText->SetSelection(0, sr.Length()); - m_IndexText->SetFocus(); - } + evt.Skip(); } -void wxHtmlHelpFrame::OnIndexAll(wxCommandEvent& WXUNUSED(event)) +// Make the help controller's frame 'modal' if +// needed +void wxHtmlHelpFrame::AddGrabIfNeeded() { - wxBusyCursor bcur; - - m_IndexList->Clear(); - const wxHtmlHelpMergedIndex& index = *m_mergedIndex; - size_t cnt = index.size(); - bool first = true; - - for (size_t i = 0; i < cnt; i++) + // 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() ) { - m_IndexList->Append(index[i].name, (char*)(&index[i])); - if (first) - { - // don't automatically show topic selector if this - // item points to multiple pages: - if (index[i].items.size() == 1) - { - DisplayIndexItem(&index[i]); - } - first = false; - } - } - - wxString cnttext; - cnttext.Printf(_("%i of %i"), cnt, cnt); - m_IndexCountInfo->SetLabel(cnttext); -} - + wxWindow *win = node->GetData(); + wxDialog *dialog = wxDynamicCast(win, wxDialog); -void wxHtmlHelpFrame::OnSearchSel(wxCommandEvent& WXUNUSED(event)) -{ - wxHtmlHelpDataItem *it = (wxHtmlHelpDataItem*) m_SearchList->GetClientData(m_SearchList->GetSelection()); - if (it) - { - if (!it->page.empty()) - m_HtmlWin->LoadPage(it->GetFullPath()); - NotifyPageChanged(); + if (dialog && dialog->IsModal()) + needGrab = TRUE; } -} - -void wxHtmlHelpFrame::OnSearch(wxCommandEvent& WXUNUSED(event)) -{ - wxString sr = m_SearchText->GetLineText(0); - if (!sr.empty()) - KeywordSearch(sr, wxHELP_SEARCH_ALL); + if (needGrab) + AddGrab(); +#endif // __WXGTK__ } -void wxHtmlHelpFrame::OnBookmarksSel(wxCommandEvent& WXUNUSED(event)) +// For compatibility +void wxHtmlHelpFrame::UseConfig(wxConfigBase *config, const wxString& rootPath) { - wxString sr = m_Bookmarks->GetStringSelection(); - - if (sr != wxEmptyString && sr != _("(bookmarks)")) - { - m_HtmlWin->LoadPage(m_BookmarksPages[m_BookmarksNames.Index(sr)]); - NotifyPageChanged(); - } -} - -void wxHtmlHelpFrame::OnCloseWindow(wxCloseEvent& evt) -{ - GetSize(&m_Cfg.w, &m_Cfg.h); - GetPosition(&m_Cfg.x, &m_Cfg.y); - -#ifdef __WXGTK__ - if (IsGrabbed()) - { - RemoveGrab(); - } -#endif - - if (m_Splitter && m_Cfg.navig_on) m_Cfg.sashpos = m_Splitter->GetSashPosition(); - - if (m_Config) - WriteCustomization(m_Config, m_ConfigRoot); - - if (m_helpController && m_helpController->IsKindOf(CLASSINFO(wxHtmlHelpController))) - { - ((wxHtmlHelpController*) m_helpController)->OnCloseFrame(evt); - } - - evt.Skip(); + if (m_HtmlHelpWin) + m_HtmlHelpWin->UseConfig(config, rootPath); } #ifdef __WXMAC__ @@ -1801,32 +229,9 @@ void wxHtmlHelpFrame::OnClose(wxCommandEvent& event) void wxHtmlHelpFrame::OnAbout(wxCommandEvent& event) { - wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2004, Vaclav Slavik et al"), wxT("HelpView"), + wxMessageBox(wxT("wxWidgets HTML Help Viewer (c) 1998-2006, Vaclav Slavik et al"), wxT("HelpView"), wxICON_INFORMATION|wxOK, this); } #endif -BEGIN_EVENT_TABLE(wxHtmlHelpFrame, wxFrame) - EVT_ACTIVATE(wxHtmlHelpFrame::OnActivate) - EVT_TOOL_RANGE(wxID_HTML_PANEL, wxID_HTML_OPTIONS, wxHtmlHelpFrame::OnToolbar) - EVT_BUTTON(wxID_HTML_BOOKMARKSREMOVE, wxHtmlHelpFrame::OnToolbar) - EVT_BUTTON(wxID_HTML_BOOKMARKSADD, wxHtmlHelpFrame::OnToolbar) - EVT_TREE_SEL_CHANGED(wxID_HTML_TREECTRL, wxHtmlHelpFrame::OnContentsSel) - EVT_LISTBOX(wxID_HTML_INDEXLIST, wxHtmlHelpFrame::OnIndexSel) - EVT_LISTBOX(wxID_HTML_SEARCHLIST, wxHtmlHelpFrame::OnSearchSel) - EVT_BUTTON(wxID_HTML_SEARCHBUTTON, wxHtmlHelpFrame::OnSearch) - EVT_TEXT_ENTER(wxID_HTML_SEARCHTEXT, wxHtmlHelpFrame::OnSearch) - EVT_BUTTON(wxID_HTML_INDEXBUTTON, wxHtmlHelpFrame::OnIndexFind) - EVT_TEXT_ENTER(wxID_HTML_INDEXTEXT, wxHtmlHelpFrame::OnIndexFind) - EVT_BUTTON(wxID_HTML_INDEXBUTTONALL, wxHtmlHelpFrame::OnIndexAll) - EVT_COMBOBOX(wxID_HTML_BOOKMARKSLIST, wxHtmlHelpFrame::OnBookmarksSel) - EVT_CLOSE(wxHtmlHelpFrame::OnCloseWindow) -#ifdef __WXMAC__ - EVT_MENU(wxID_CLOSE, wxHtmlHelpFrame::OnClose) - EVT_MENU(wxID_ABOUT, wxHtmlHelpFrame::OnAbout) - EVT_MENU(wxID_HELP_CONTENTS, wxHtmlHelpFrame::OnAbout) -#endif - -END_EVENT_TABLE() - #endif // wxUSE_WXHTML_HELP diff --git a/src/html/helpwin.cpp b/src/html/helpwin.cpp new file mode 100644 index 0000000000..3dcc4b774e --- /dev/null +++ b/src/html/helpwin.cpp @@ -0,0 +1,1757 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: helpwin.cpp +// Purpose: wxHtmlHelpWindow +// Notes: Based on htmlhelp.cpp, implementing a monolithic +// HTML Help controller class, by Vaclav Slavik +// Author: Harm van der Heijden and Vaclav Slavik +// RCS-ID: $Id$ +// Copyright: (c) Harm van der Heijden and Vaclav Slavik +// Licence: wxWindows licence +///////////////////////////////////////////////////////////////////////////// + +// For compilers that support precompilation, includes "wx.h" + +#include "wx/wxprec.h" + +#ifdef __BORLANDC__ +#pragma hdrstop +#endif + +#if wxUSE_WXHTML_HELP + +#ifndef WXPRECOMP + #include "wx/intl.h" + #include "wx/log.h" + + #include "wx/object.h" + #include "wx/sizer.h" + + #include "wx/bmpbuttn.h" + #include "wx/statbox.h" + #include "wx/radiobox.h" +#endif // WXPRECOMP + +#ifdef __WXMAC__ + #include "wx/menu.h" + #include "wx/msgdlg.h" +#endif + +#include "wx/html/helpfrm.h" +#include "wx/html/helpdlg.h" +#include "wx/html/helpctrl.h" +#include "wx/textctrl.h" +#include "wx/notebook.h" +#include "wx/imaglist.h" +#include "wx/treectrl.h" +#include "wx/tokenzr.h" +#include "wx/wfstream.h" +#include "wx/html/htmlwin.h" +#include "wx/busyinfo.h" +#include "wx/progdlg.h" +#include "wx/toolbar.h" +#include "wx/fontenum.h" +#include "wx/stream.h" +#include "wx/filedlg.h" +#include "wx/artprov.h" +#include "wx/spinctrl.h" +#include "wx/dynarray.h" +#include "wx/choicdlg.h" +#include "wx/settings.h" + +// what is considered "small index"? +#define INDEX_IS_SMALL 100 + +/* Motif defines this as a macro */ +#ifdef Below +#undef Below +#endif + +//-------------------------------------------------------------------------- +// wxHtmlHelpTreeItemData (private) +//-------------------------------------------------------------------------- + +class wxHtmlHelpTreeItemData : public wxTreeItemData +{ + public: +#if defined(__VISAGECPP__) +// VA needs a default ctor for some reason.... + wxHtmlHelpTreeItemData() : wxTreeItemData() + { m_Id = 0; } +#endif + wxHtmlHelpTreeItemData(int id) : wxTreeItemData() + { m_Id = id;} + + int m_Id; +}; + + +//-------------------------------------------------------------------------- +// wxHtmlHelpHashData (private) +//-------------------------------------------------------------------------- + +class wxHtmlHelpHashData : public wxObject +{ + public: + wxHtmlHelpHashData(int index, wxTreeItemId id) : wxObject() + { m_Index = index; m_Id = id;} + ~wxHtmlHelpHashData() {} + + int m_Index; + wxTreeItemId m_Id; +}; + + +//-------------------------------------------------------------------------- +// wxHtmlHelpHtmlWindow (private) +//-------------------------------------------------------------------------- + +DEFINE_EVENT_TYPE(wxEVT_COMMAND_HTMLWINDOW_URL_CLICKED) +IMPLEMENT_DYNAMIC_CLASS(wxHtmlWindowEvent, wxNotifyEvent) + +class wxHtmlHelpHtmlWindow : public wxHtmlWindow +{ + public: + wxHtmlHelpHtmlWindow(wxHtmlHelpWindow *win, wxWindow *parent) + : wxHtmlWindow(parent), m_Window(win) + { + SetStandardFonts(); + } + + virtual void OnLinkClicked(const wxHtmlLinkInfo& link) + { + wxHtmlWindowEvent event(wxEVT_COMMAND_HTMLWINDOW_URL_CLICKED, GetId()); + event.SetURL(link.GetHref()); + if (!ProcessEvent(event)) + { + wxHtmlWindow::OnLinkClicked(link); + } + const wxMouseEvent *e = link.GetEvent(); + if (e == NULL || e->LeftUp()) + m_Window->NotifyPageChanged(); + } + + // Returns full location with anchor (helper) + static wxString GetOpenedPageWithAnchor(wxHtmlWindow *win) + { + if(!win) + return wxEmptyString; + + wxString an = win->GetOpenedAnchor(); + wxString pg = win->GetOpenedPage(); + if(!an.empty()) + { + pg << wxT("#"); + pg << an; + } + return pg; + } + + private: + wxHtmlHelpWindow *m_Window; + + DECLARE_NO_COPY_CLASS(wxHtmlHelpHtmlWindow) +}; + + +//--------------------------------------------------------------------------- +// wxHtmlHelpWindow::m_mergedIndex +//--------------------------------------------------------------------------- + +WX_DEFINE_ARRAY_PTR(const wxHtmlHelpDataItem*, wxHtmlHelpDataItemPtrArray); + +struct wxHtmlHelpMergedIndexItem +{ + wxHtmlHelpMergedIndexItem *parent; + wxString name; + wxHtmlHelpDataItemPtrArray items; +}; + +WX_DECLARE_OBJARRAY(wxHtmlHelpMergedIndexItem, wxHtmlHelpMergedIndex); +#include "wx/arrimpl.cpp" +WX_DEFINE_OBJARRAY(wxHtmlHelpMergedIndex) + +void wxHtmlHelpWindow::UpdateMergedIndex() +{ + delete m_mergedIndex; + m_mergedIndex = new wxHtmlHelpMergedIndex; + wxHtmlHelpMergedIndex& merged = *m_mergedIndex; + + const wxHtmlHelpDataItems& items = m_Data->GetIndexArray(); + size_t len = items.size(); + + wxHtmlHelpMergedIndexItem *history[128] = {NULL}; + + for (size_t i = 0; i < len; i++) + { + const wxHtmlHelpDataItem& item = items[i]; + wxASSERT_MSG( item.level < 128, _T("nested index entries too deep") ); + + if (history[item.level] && + history[item.level]->items[0]->name == item.name) + { + // same index entry as previous one, update list of items + history[item.level]->items.Add(&item); + } + else + { + // new index entry + wxHtmlHelpMergedIndexItem *mi = new wxHtmlHelpMergedIndexItem(); + mi->name = item.GetIndentedName(); + mi->items.Add(&item); + mi->parent = (item.level == 0) ? NULL : history[item.level - 1]; + history[item.level] = mi; + merged.Add(mi); + } + } +} + +//--------------------------------------------------------------------------- +// wxHtmlHelpWindow +//--------------------------------------------------------------------------- + +// Command IDs : +enum +{ + //wxID_HTML_HELPFRAME = wxID_HIGHEST + 1, + wxID_HTML_PANEL = wxID_HIGHEST + 2, + wxID_HTML_BACK, + wxID_HTML_FORWARD, + wxID_HTML_UPNODE, + wxID_HTML_UP, + wxID_HTML_DOWN, + wxID_HTML_PRINT, + wxID_HTML_OPENFILE, + wxID_HTML_OPTIONS, + wxID_HTML_BOOKMARKSLIST, + wxID_HTML_BOOKMARKSADD, + wxID_HTML_BOOKMARKSREMOVE, + wxID_HTML_TREECTRL, + wxID_HTML_INDEXPAGE, + wxID_HTML_INDEXLIST, + wxID_HTML_INDEXTEXT, + wxID_HTML_INDEXBUTTON, + wxID_HTML_INDEXBUTTONALL, + wxID_HTML_NOTEBOOK, + wxID_HTML_SEARCHPAGE, + wxID_HTML_SEARCHTEXT, + wxID_HTML_SEARCHLIST, + wxID_HTML_SEARCHBUTTON, + wxID_HTML_SEARCHCHOICE, + wxID_HTML_COUNTINFO +}; + +IMPLEMENT_DYNAMIC_CLASS(wxHtmlHelpWindow, wxWindow) + +BEGIN_EVENT_TABLE(wxHtmlHelpWindow, wxWindow) + EVT_TOOL_RANGE(wxID_HTML_PANEL, wxID_HTML_OPTIONS, wxHtmlHelpWindow::OnToolbar) + EVT_BUTTON(wxID_HTML_BOOKMARKSREMOVE, wxHtmlHelpWindow::OnToolbar) + EVT_BUTTON(wxID_HTML_BOOKMARKSADD, wxHtmlHelpWindow::OnToolbar) + EVT_TREE_SEL_CHANGED(wxID_HTML_TREECTRL, wxHtmlHelpWindow::OnContentsSel) + EVT_LISTBOX(wxID_HTML_INDEXLIST, wxHtmlHelpWindow::OnIndexSel) + EVT_LISTBOX(wxID_HTML_SEARCHLIST, wxHtmlHelpWindow::OnSearchSel) + EVT_BUTTON(wxID_HTML_SEARCHBUTTON, wxHtmlHelpWindow::OnSearch) + EVT_TEXT_ENTER(wxID_HTML_SEARCHTEXT, wxHtmlHelpWindow::OnSearch) + EVT_BUTTON(wxID_HTML_INDEXBUTTON, wxHtmlHelpWindow::OnIndexFind) + EVT_TEXT_ENTER(wxID_HTML_INDEXTEXT, wxHtmlHelpWindow::OnIndexFind) + EVT_BUTTON(wxID_HTML_INDEXBUTTONALL, wxHtmlHelpWindow::OnIndexAll) + EVT_COMBOBOX(wxID_HTML_BOOKMARKSLIST, wxHtmlHelpWindow::OnBookmarksSel) + EVT_SIZE(wxHtmlHelpWindow::OnSize) +END_EVENT_TABLE() + +wxHtmlHelpWindow::wxHtmlHelpWindow(wxWindow* parent, wxWindowID id, + const wxPoint& pos, + const wxSize& size, + int style, int helpStyle, wxHtmlHelpData* data) +{ + Init(data); + Create(parent, id, pos, size, style, helpStyle); +} + +void wxHtmlHelpWindow::Init(wxHtmlHelpData* data) +{ + if (data) + { + m_Data = data; + m_DataCreated = false; + } + else + { + m_Data = new wxHtmlHelpData(); + m_DataCreated = true; + } + + m_ContentsPage = 0; + m_IndexPage = 0; + m_SearchPage = 0; + + m_ContentsBox = NULL; + m_IndexList = NULL; + m_IndexButton = NULL; + m_IndexButtonAll = NULL; + m_IndexText = NULL; + m_SearchList = NULL; + m_SearchButton = NULL; + m_SearchText = NULL; + m_SearchChoice = NULL; + m_IndexCountInfo = NULL; + m_Splitter = NULL; + m_NavigPan = NULL; + m_NavigNotebook = NULL; + m_HtmlWin = NULL; + m_Bookmarks = NULL; + m_SearchCaseSensitive = NULL; + m_SearchWholeWords = NULL; + + m_mergedIndex = NULL; + + m_Config = NULL; + m_ConfigRoot = wxEmptyString; + + m_Cfg.x = m_Cfg.y = wxDefaultCoord; + m_Cfg.w = 700; + m_Cfg.h = 480; + m_Cfg.sashpos = 240; + m_Cfg.navig_on = true; + + m_NormalFonts = m_FixedFonts = NULL; + m_NormalFace = m_FixedFace = wxEmptyString; +#ifdef __WXMSW__ + m_FontSize = 10; +#else + m_FontSize = 14; +#endif + +#if wxUSE_PRINTING_ARCHITECTURE + m_Printer = NULL; +#endif + + m_PagesHash = NULL; + m_UpdateContents = true; + m_toolBar = NULL; + m_helpController = (wxHtmlHelpController*) NULL; +} + +// Create: builds the GUI components. +// with the style flag it's possible to toggle the toolbar, contents, index and search +// controls. +// m_HtmlWin will *always* be created, but it's important to realize that +// m_ContentsBox, m_IndexList, m_SearchList, m_SearchButton, m_SearchText and +// m_SearchButton may be NULL. +// moreover, if no contents, index or searchpage is needed, m_Splitter and +// m_NavigPan will be NULL too (with m_HtmlWin directly connected to the frame) + +bool wxHtmlHelpWindow::Create(wxWindow* parent, wxWindowID id, + const wxPoint& pos, const wxSize& size, + int style, int helpStyle) +{ + m_hfStyle = helpStyle; + + wxImageList *ContentsImageList = new wxImageList(16, 16); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_BOOK, + wxART_HELP_BROWSER, + wxSize(16, 16))); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_FOLDER, + wxART_HELP_BROWSER, + wxSize(16, 16))); + ContentsImageList->Add(wxArtProvider::GetIcon(wxART_HELP_PAGE, + wxART_HELP_BROWSER, + wxSize(16, 16))); + + // Do the config in two steps. We read the HtmlWindow customization after we + // create the window. + if (m_Config) + ReadCustomization(m_Config, m_ConfigRoot); + + wxWindow::Create(parent, id, pos, size, style, wxT("wxHtmlHelp")); + + SetHelpText(_("Displays help as you browse the books on the left.")); + + GetPosition(&m_Cfg.x, &m_Cfg.y); + + int notebook_page = 0; + + // The sizer for the whole top-level window. + wxSizer *topWindowSizer = new wxBoxSizer(wxVERTICAL); + SetSizer(topWindowSizer); + SetAutoLayout(TRUE); + +#if wxUSE_TOOLBAR + // toolbar? + if (helpStyle & (wxHF_TOOLBAR | wxHF_FLAT_TOOLBAR)) + { + wxToolBar *toolBar = new wxToolBar(this, -1, wxDefaultPosition, wxDefaultSize, + wxNO_BORDER | wxTB_HORIZONTAL | + wxTB_DOCKABLE | wxTB_NODIVIDER | + (helpStyle & wxHF_FLAT_TOOLBAR ? wxTB_FLAT : 0)); + toolBar->SetMargins( 2, 2 ); + AddToolbarButtons(toolBar, helpStyle); + toolBar->Realize(); + topWindowSizer->Add(toolBar, 0, wxEXPAND); + m_toolBar = toolBar; + } +#endif //wxUSE_TOOLBAR + + wxSizer *navigSizer = NULL; + + if (helpStyle & (wxHF_CONTENTS | wxHF_INDEX | wxHF_SEARCH)) + { + // traditional help controller; splitter window with html page on the + // right and a notebook containing various pages on the left + m_Splitter = new wxSplitterWindow(this); + + topWindowSizer->Add(m_Splitter, 1, wxEXPAND); + + m_HtmlWin = new wxHtmlHelpHtmlWindow(this, m_Splitter); + m_NavigPan = new wxPanel(m_Splitter, wxID_ANY); + m_NavigNotebook = new wxNotebook(m_NavigPan, wxID_HTML_NOTEBOOK, + wxDefaultPosition, wxDefaultSize); + + navigSizer = new wxBoxSizer(wxVERTICAL); + navigSizer->Add(m_NavigNotebook, 1, wxEXPAND); + + m_NavigPan->SetSizer(navigSizer); + } + else + { + // only html window, no notebook with index,contents etc + m_HtmlWin = new wxHtmlWindow(this); + topWindowSizer->Add(m_HtmlWin, 1, wxEXPAND); + } + + if ( m_Config ) + m_HtmlWin->ReadCustomization(m_Config, m_ConfigRoot); + + // contents tree panel? + if ( helpStyle & wxHF_CONTENTS ) + { + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); + + topsizer->Add(0, 10); + + dummy->SetSizer(topsizer); + + if ( helpStyle & wxHF_BOOKMARKS ) + { + m_Bookmarks = new wxComboBox(dummy, wxID_HTML_BOOKMARKSLIST, + wxEmptyString, + wxDefaultPosition, wxDefaultSize, + 0, NULL, wxCB_READONLY | wxCB_SORT); + m_Bookmarks->Append(_("(bookmarks)")); + for (unsigned i = 0; i < m_BookmarksNames.GetCount(); i++) + m_Bookmarks->Append(m_BookmarksNames[i]); + m_Bookmarks->SetSelection(0); + + wxBitmapButton *bmpbt1, *bmpbt2; + bmpbt1 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSADD, + wxArtProvider::GetBitmap(wxART_ADD_BOOKMARK, + wxART_BUTTON)); + bmpbt2 = new wxBitmapButton(dummy, wxID_HTML_BOOKMARKSREMOVE, + wxArtProvider::GetBitmap(wxART_DEL_BOOKMARK, + wxART_BUTTON)); +#if wxUSE_TOOLTIPS + bmpbt1->SetToolTip(_("Add current page to bookmarks")); + bmpbt2->SetToolTip(_("Remove current page from bookmarks")); +#endif // wxUSE_TOOLTIPS + + wxSizer *sizer = new wxBoxSizer(wxHORIZONTAL); + + sizer->Add(m_Bookmarks, 1, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 5); + sizer->Add(bmpbt1, 0, wxALIGN_CENTRE_VERTICAL | wxRIGHT, 2); + sizer->Add(bmpbt2, 0, wxALIGN_CENTRE_VERTICAL, 0); + + topsizer->Add(sizer, 0, wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, 10); + } + + m_ContentsBox = new wxTreeCtrl(dummy, wxID_HTML_TREECTRL, + wxDefaultPosition, wxDefaultSize, +#ifdef __WXGTK20__ + wxSUNKEN_BORDER | + wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT | + wxTR_NO_LINES +#else + wxSUNKEN_BORDER | + wxTR_HAS_BUTTONS | wxTR_HIDE_ROOT | + wxTR_LINES_AT_ROOT +#endif + ); + + m_ContentsBox->AssignImageList(ContentsImageList); + + topsizer->Add(m_ContentsBox, 1, + wxEXPAND | wxLEFT | wxBOTTOM | wxRIGHT, + 2); + + m_NavigNotebook->AddPage(dummy, _("Contents")); + m_ContentsPage = notebook_page++; + } + + // index listbox panel? + if ( helpStyle & wxHF_INDEX ) + { + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxSizer *topsizer = new wxBoxSizer(wxVERTICAL); + + dummy->SetSizer(topsizer); + + m_IndexText = new wxTextCtrl(dummy, wxID_HTML_INDEXTEXT, wxEmptyString, + wxDefaultPosition, wxDefaultSize, + wxTE_PROCESS_ENTER); + m_IndexButton = new wxButton(dummy, wxID_HTML_INDEXBUTTON, _("Find")); + m_IndexButtonAll = new wxButton(dummy, wxID_HTML_INDEXBUTTONALL, + _("Show all")); + m_IndexCountInfo = new wxStaticText(dummy, wxID_HTML_COUNTINFO, + wxEmptyString, wxDefaultPosition, + wxDefaultSize, + wxALIGN_RIGHT | wxST_NO_AUTORESIZE); + m_IndexList = new wxListBox(dummy, wxID_HTML_INDEXLIST, + wxDefaultPosition, wxDefaultSize, + 0, NULL, wxLB_SINGLE); + +#if wxUSE_TOOLTIPS + m_IndexButton->SetToolTip(_("Display all index items that contain given substring. Search is case insensitive.")); + m_IndexButtonAll->SetToolTip(_("Show all items in index")); +#endif //wxUSE_TOOLTIPS + + topsizer->Add(m_IndexText, 0, wxEXPAND | wxALL, 10); + wxSizer *btsizer = new wxBoxSizer(wxHORIZONTAL); + btsizer->Add(m_IndexButton, 0, wxRIGHT, 2); + btsizer->Add(m_IndexButtonAll); + topsizer->Add(btsizer, 0, + wxALIGN_RIGHT | wxLEFT | wxRIGHT | wxBOTTOM, 10); + topsizer->Add(m_IndexCountInfo, 0, wxEXPAND | wxLEFT | wxRIGHT, 2); + topsizer->Add(m_IndexList, 1, wxEXPAND | wxALL, 2); + + m_NavigNotebook->AddPage(dummy, _("Index")); + m_IndexPage = notebook_page++; + } + + // search list panel? + if ( helpStyle & wxHF_SEARCH ) + { + wxWindow *dummy = new wxPanel(m_NavigNotebook, wxID_HTML_INDEXPAGE); + wxSizer *sizer = new wxBoxSizer(wxVERTICAL); + + dummy->SetSizer(sizer); + + m_SearchText = new wxTextCtrl(dummy, wxID_HTML_SEARCHTEXT, + wxEmptyString, + wxDefaultPosition, wxDefaultSize, + wxTE_PROCESS_ENTER); + m_SearchChoice = new wxChoice(dummy, wxID_HTML_SEARCHCHOICE, + wxDefaultPosition, wxSize(125,wxDefaultCoord)); + m_SearchCaseSensitive = new wxCheckBox(dummy, wxID_ANY, _("Case sensitive")); + m_SearchWholeWords = new wxCheckBox(dummy, wxID_ANY, _("Whole words only")); + m_SearchButton = new wxButton(dummy, wxID_HTML_SEARCHBUTTON, _("Search")); +#if wxUSE_TOOLTIPS + m_SearchButton->SetToolTip(_("Search contents of help book(s) for all occurences of the text you typed above")); +#endif //wxUSE_TOOLTIPS + m_SearchList = new wxListBox(dummy, wxID_HTML_SEARCHLIST, + wxDefaultPosition, wxDefaultSize, + 0, NULL, wxLB_SINGLE); + + sizer->Add(m_SearchText, 0, wxEXPAND | wxALL, 10); + sizer->Add(m_SearchChoice, 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 10); + sizer->Add(m_SearchCaseSensitive, 0, wxLEFT | wxRIGHT, 10); + sizer->Add(m_SearchWholeWords, 0, wxLEFT | wxRIGHT, 10); + sizer->Add(m_SearchButton, 0, wxALL | wxALIGN_RIGHT, 8); + sizer->Add(m_SearchList, 1, wxALL | wxEXPAND, 2); + + m_NavigNotebook->AddPage(dummy, _("Search")); + m_SearchPage = notebook_page; + } + + m_HtmlWin->Show(); + + RefreshLists(); + + if ( navigSizer ) + { + navigSizer->SetSizeHints(m_NavigPan); + m_NavigPan->Layout(); + } + + // showtime + if ( m_NavigPan && m_Splitter ) + { + m_Splitter->SetMinimumPaneSize(20); + if ( m_Cfg.navig_on ) + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + + if ( m_Cfg.navig_on ) + { + m_NavigPan->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + } + else + { + m_NavigPan->Show(false); + m_Splitter->Initialize(m_HtmlWin); + } + } + + // Reduce flicker by updating the splitter pane sizes before the + // frame is shown + wxSizeEvent sizeEvent(GetSize(), GetId()); + ProcessEvent(sizeEvent); + + if (m_Splitter) + m_Splitter->UpdateSize(); + + return true; +} + +wxHtmlHelpWindow::~wxHtmlHelpWindow() +{ + delete m_mergedIndex; + + // PopEventHandler(); // wxhtmlhelpcontroller (not any more!) + if (m_DataCreated) + delete m_Data; + if (m_NormalFonts) delete m_NormalFonts; + if (m_FixedFonts) delete m_FixedFonts; + if (m_PagesHash) + { + WX_CLEAR_HASH_TABLE(*m_PagesHash); + delete m_PagesHash; + } +#if wxUSE_PRINTING_ARCHITECTURE + if (m_Printer) delete m_Printer; +#endif +} + +void wxHtmlHelpWindow::SetController(wxHtmlHelpController* controller) +{ + if (m_DataCreated) + delete m_Data; + m_helpController = controller; + m_Data = controller->GetHelpData(); + m_DataCreated = false; +} + +#if wxUSE_TOOLBAR +void wxHtmlHelpWindow::AddToolbarButtons(wxToolBar *toolBar, int style) +{ + wxBitmap wpanelBitmap = + wxArtProvider::GetBitmap(wxART_HELP_SIDE_PANEL, wxART_TOOLBAR); + wxBitmap wbackBitmap = + wxArtProvider::GetBitmap(wxART_GO_BACK, wxART_TOOLBAR); + wxBitmap wforwardBitmap = + wxArtProvider::GetBitmap(wxART_GO_FORWARD, wxART_TOOLBAR); + wxBitmap wupnodeBitmap = + wxArtProvider::GetBitmap(wxART_GO_TO_PARENT, wxART_TOOLBAR); + wxBitmap wupBitmap = + wxArtProvider::GetBitmap(wxART_GO_UP, wxART_TOOLBAR); + wxBitmap wdownBitmap = + wxArtProvider::GetBitmap(wxART_GO_DOWN, wxART_TOOLBAR); + wxBitmap wopenBitmap = + wxArtProvider::GetBitmap(wxART_FILE_OPEN, wxART_TOOLBAR); + wxBitmap wprintBitmap = + wxArtProvider::GetBitmap(wxART_PRINT, wxART_TOOLBAR); + wxBitmap woptionsBitmap = + wxArtProvider::GetBitmap(wxART_HELP_SETTINGS, wxART_TOOLBAR); + + wxASSERT_MSG( (wpanelBitmap.Ok() && wbackBitmap.Ok() && + wforwardBitmap.Ok() && wupnodeBitmap.Ok() && + wupBitmap.Ok() && wdownBitmap.Ok() && + wopenBitmap.Ok() && wprintBitmap.Ok() && + woptionsBitmap.Ok()), + wxT("One or more HTML help frame toolbar bitmap could not be loaded.")) ; + + + toolBar->AddTool(wxID_HTML_PANEL, wpanelBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Show/hide navigation panel")); + + toolBar->AddSeparator(); + toolBar->AddTool(wxID_HTML_BACK, wbackBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Go back")); + toolBar->AddTool(wxID_HTML_FORWARD, wforwardBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Go forward")); + toolBar->AddSeparator(); + + toolBar->AddTool(wxID_HTML_UPNODE, wupnodeBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Go one level up in document hierarchy")); + toolBar->AddTool(wxID_HTML_UP, wupBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Previous page")); + toolBar->AddTool(wxID_HTML_DOWN, wdownBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Next page")); + + if ((style & wxHF_PRINT) || (style & wxHF_OPEN_FILES)) + toolBar->AddSeparator(); + + if (style & wxHF_OPEN_FILES) + toolBar->AddTool(wxID_HTML_OPENFILE, wopenBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Open HTML document")); + +#if wxUSE_PRINTING_ARCHITECTURE + if (style & wxHF_PRINT) + toolBar->AddTool(wxID_HTML_PRINT, wprintBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Print this page")); +#endif + + toolBar->AddSeparator(); + toolBar->AddTool(wxID_HTML_OPTIONS, woptionsBitmap, wxNullBitmap, + false, wxDefaultCoord, wxDefaultCoord, (wxObject *) NULL, + _("Display options dialog")); + + // Allow application to add custom buttons + wxHtmlHelpFrame* parentFrame = wxDynamicCast(GetParent(), wxHtmlHelpFrame); + wxHtmlHelpDialog* parentDialog = wxDynamicCast(GetParent(), wxHtmlHelpDialog); + if (parentFrame) + parentFrame->AddToolbarButtons(toolBar, style); + if (parentDialog) + parentDialog->AddToolbarButtons(toolBar, style); +} +#endif //wxUSE_TOOLBAR + + +bool wxHtmlHelpWindow::Display(const wxString& x) +{ + wxString url = m_Data->FindPageByName(x); + if (!url.empty()) + { + m_HtmlWin->LoadPage(url); + NotifyPageChanged(); + return true; + } + + return false; +} + +bool wxHtmlHelpWindow::Display(const int id) +{ + wxString url = m_Data->FindPageById(id); + if (!url.empty()) + { + m_HtmlWin->LoadPage(url); + NotifyPageChanged(); + return true; + } + + return false; +} + +bool wxHtmlHelpWindow::DisplayContents() +{ + if (! m_ContentsBox) + return false; + + if (!m_Splitter->IsSplit()) + { + m_NavigPan->Show(); + m_HtmlWin->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + m_Cfg.navig_on = true; + } + + m_NavigNotebook->SetSelection(m_ContentsPage); + + if (m_Data->GetBookRecArray().GetCount() > 0) + { + wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0]; + if (!book.GetStart().empty()) + m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart())); + } + + return true; +} + +bool wxHtmlHelpWindow::DisplayIndex() +{ + if (! m_IndexList) + return false; + + if (!m_Splitter->IsSplit()) + { + m_NavigPan->Show(); + m_HtmlWin->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + } + + m_NavigNotebook->SetSelection(m_IndexPage); + + if (m_Data->GetBookRecArray().GetCount() > 0) + { + wxHtmlBookRecord& book = m_Data->GetBookRecArray()[0]; + if (!book.GetStart().empty()) + m_HtmlWin->LoadPage(book.GetFullPath(book.GetStart())); + } + + return true; +} + +void wxHtmlHelpWindow::DisplayIndexItem(const wxHtmlHelpMergedIndexItem *it) +{ + if (it->items.size() == 1) + { + if (!it->items[0]->page.empty()) + { + m_HtmlWin->LoadPage(it->items[0]->GetFullPath()); + NotifyPageChanged(); + } + } + else + { + wxBusyCursor busy_cursor; + + // more pages associated with this index item -- let the user choose + // which one she/he wants from a list: + wxArrayString arr; + size_t len = it->items.size(); + for (size_t i = 0; i < len; i++) + { + wxString page = it->items[i]->page; + // try to find page's title in contents: + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + size_t clen = contents.size(); + for (size_t j = 0; j < clen; j++) + { + if (contents[j].page == page) + { + page = contents[j].name; + break; + } + } + arr.push_back(page); + } + + wxSingleChoiceDialog dlg(this, + _("Please choose the page to display:"), + _("Help Topics"), + arr, NULL, wxCHOICEDLG_STYLE & ~wxCENTRE); + if (dlg.ShowModal() == wxID_OK) + { + m_HtmlWin->LoadPage(it->items[dlg.GetSelection()]->GetFullPath()); + NotifyPageChanged(); + } + } +} + +bool wxHtmlHelpWindow::KeywordSearch(const wxString& keyword, + wxHelpSearchMode mode) +{ + if (mode == wxHELP_SEARCH_ALL) + { + if ( !(m_SearchList && + m_SearchButton && m_SearchText && m_SearchChoice) ) + return false; + } + else if (mode == wxHELP_SEARCH_INDEX) + { + if ( !(m_IndexList && + m_IndexButton && m_IndexButtonAll && m_IndexText) ) + return false; + } + + int foundcnt = 0; + wxString foundstr; + wxString book = wxEmptyString; + + if (!m_Splitter->IsSplit()) + { + m_NavigPan->Show(); + m_HtmlWin->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + } + + if (mode == wxHELP_SEARCH_ALL) + { + m_NavigNotebook->SetSelection(m_SearchPage); + m_SearchList->Clear(); + m_SearchText->SetValue(keyword); + m_SearchButton->Disable(); + + if (m_SearchChoice->GetSelection() != 0) + book = m_SearchChoice->GetStringSelection(); + + wxHtmlSearchStatus status(m_Data, keyword, + m_SearchCaseSensitive->GetValue(), + m_SearchWholeWords->GetValue(), + book); + +#if wxUSE_PROGRESSDLG + wxProgressDialog progress(_("Searching..."), + _("No matching page found yet"), + status.GetMaxIndex(), this, + wxPD_APP_MODAL | wxPD_CAN_ABORT | wxPD_AUTO_HIDE); +#endif + + int curi; + while (status.IsActive()) + { + curi = status.GetCurIndex(); + if (curi % 32 == 0 +#if wxUSE_PROGRESSDLG + && !progress.Update(curi) +#endif + ) + break; + if (status.Search()) + { + foundstr.Printf(_("Found %i matches"), ++foundcnt); +#if wxUSE_PROGRESSDLG + progress.Update(status.GetCurIndex(), foundstr); +#endif + m_SearchList->Append(status.GetName(), (void*)status.GetCurItem()); + } + } + + m_SearchButton->Enable(); + m_SearchText->SetSelection(0, keyword.Length()); + m_SearchText->SetFocus(); + } + else if (mode == wxHELP_SEARCH_INDEX) + { + m_NavigNotebook->SetSelection(m_IndexPage); + m_IndexList->Clear(); + m_IndexButton->Disable(); + m_IndexButtonAll->Disable(); + m_IndexText->SetValue(keyword); + + wxCommandEvent dummy; + OnIndexFind(dummy); // what a hack... + m_IndexButton->Enable(); + m_IndexButtonAll->Enable(); + foundcnt = m_IndexList->GetCount(); + } + + if (foundcnt) + { + switch ( mode ) + { + default: + wxFAIL_MSG( _T("unknown help search mode") ); + // fall back + + case wxHELP_SEARCH_ALL: + { + wxHtmlHelpDataItem *it = + (wxHtmlHelpDataItem*) m_SearchList->GetClientData(0); + if (it) + { + m_HtmlWin->LoadPage(it->GetFullPath()); + NotifyPageChanged(); + } + break; + } + + case wxHELP_SEARCH_INDEX: + { + wxHtmlHelpMergedIndexItem* it = + (wxHtmlHelpMergedIndexItem*) m_IndexList->GetClientData(0); + if (it) + DisplayIndexItem(it); + break; + } + } + + } + + return foundcnt > 0; +} + +void wxHtmlHelpWindow::CreateContents() +{ + if (! m_ContentsBox) + return ; + + if (m_PagesHash) + { + WX_CLEAR_HASH_TABLE(*m_PagesHash); + delete m_PagesHash; + } + + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + + size_t cnt = contents.size(); + + m_PagesHash = new wxHashTable(wxKEY_STRING, 2 * cnt); + + const int MAX_ROOTS = 64; + wxTreeItemId roots[MAX_ROOTS]; + // VS: this array holds information about whether we've set item icon at + // given level. This is necessary because m_Data has a flat structure + // and there's no way of recognizing if some item has subitems or not. + // We set the icon later: when we find an item with level=n, we know + // that the last item with level=n-1 was afolder with subitems, so we + // set its icon accordingly + bool imaged[MAX_ROOTS]; + m_ContentsBox->DeleteAllItems(); + + roots[0] = m_ContentsBox->AddRoot(_("(Help)")); + imaged[0] = true; + + for (size_t i = 0; i < cnt; i++) + { + wxHtmlHelpDataItem *it = &contents[i]; + // Handle books: + if (it->level == 0) + { + if (m_hfStyle & wxHF_MERGE_BOOKS) + // VS: we don't want book nodes, books' content should + // appear under tree's root. This line will create a "fake" + // record about book node so that the rest of this look + // will believe there really _is_ a book node and will + // behave correctly. + roots[1] = roots[0]; + else + { + roots[1] = m_ContentsBox->AppendItem(roots[0], + it->name, IMG_Book, -1, + new wxHtmlHelpTreeItemData(i)); + m_ContentsBox->SetItemBold(roots[1], true); + } + imaged[1] = true; + } + // ...and their contents: + else + { + roots[it->level + 1] = m_ContentsBox->AppendItem( + roots[it->level], it->name, IMG_Page, + -1, new wxHtmlHelpTreeItemData(i)); + imaged[it->level + 1] = false; + } + + m_PagesHash->Put(it->GetFullPath(), + new wxHtmlHelpHashData(i, roots[it->level + 1])); + + // Set the icon for the node one level up in the hierarchy, + // unless already done (see comment above imaged[] declaration) + if (!imaged[it->level]) + { + int image = IMG_Folder; + if (m_hfStyle & wxHF_ICONS_BOOK) + image = IMG_Book; + else if (m_hfStyle & wxHF_ICONS_BOOK_CHAPTER) + image = (it->level == 1) ? IMG_Book : IMG_Folder; + m_ContentsBox->SetItemImage(roots[it->level], image); + m_ContentsBox->SetItemImage(roots[it->level], image, + wxTreeItemIcon_Selected); + imaged[it->level] = true; + } + } +} + +void wxHtmlHelpWindow::CreateIndex() +{ + if (! m_IndexList) + return ; + + m_IndexList->Clear(); + + size_t cnt = m_mergedIndex->size(); + + wxString cnttext; + if (cnt > INDEX_IS_SMALL) + cnttext.Printf(_("%i of %i"), 0, cnt); + else + cnttext.Printf(_("%i of %i"), cnt, cnt); + m_IndexCountInfo->SetLabel(cnttext); + if (cnt > INDEX_IS_SMALL) + return; + + for (size_t i = 0; i < cnt; i++) + m_IndexList->Append((*m_mergedIndex)[i].name, + (char*)(&(*m_mergedIndex)[i])); +} + +void wxHtmlHelpWindow::CreateSearch() +{ + if (! (m_SearchList && m_SearchChoice)) + return ; + m_SearchList->Clear(); + m_SearchChoice->Clear(); + m_SearchChoice->Append(_("Search in all books")); + const wxHtmlBookRecArray& bookrec = m_Data->GetBookRecArray(); + int i, cnt = bookrec.GetCount(); + for (i = 0; i < cnt; i++) + m_SearchChoice->Append(bookrec[i].GetTitle()); + m_SearchChoice->SetSelection(0); +} + +void wxHtmlHelpWindow::RefreshLists() +{ + // Update m_mergedIndex: + UpdateMergedIndex(); + // Update the controls + CreateContents(); + CreateIndex(); + CreateSearch(); +} + +void wxHtmlHelpWindow::ReadCustomization(wxConfigBase *cfg, const wxString& path) +{ + wxString oldpath; + wxString tmp; + + if (path != wxEmptyString) + { + oldpath = cfg->GetPath(); + cfg->SetPath(_T("/") + path); + } + + m_Cfg.navig_on = cfg->Read(wxT("hcNavigPanel"), m_Cfg.navig_on) != 0; + m_Cfg.sashpos = cfg->Read(wxT("hcSashPos"), m_Cfg.sashpos); + m_Cfg.x = cfg->Read(wxT("hcX"), m_Cfg.x); + m_Cfg.y = cfg->Read(wxT("hcY"), m_Cfg.y); + m_Cfg.w = cfg->Read(wxT("hcW"), m_Cfg.w); + m_Cfg.h = cfg->Read(wxT("hcH"), m_Cfg.h); + + m_FixedFace = cfg->Read(wxT("hcFixedFace"), m_FixedFace); + m_NormalFace = cfg->Read(wxT("hcNormalFace"), m_NormalFace); + m_FontSize = cfg->Read(wxT("hcBaseFontSize"), m_FontSize); + + { + int i; + int cnt; + wxString val, s; + + cnt = cfg->Read(wxT("hcBookmarksCnt"), 0L); + if (cnt != 0) + { + m_BookmarksNames.Clear(); + m_BookmarksPages.Clear(); + if (m_Bookmarks) + { + m_Bookmarks->Clear(); + m_Bookmarks->Append(_("(bookmarks)")); + } + + for (i = 0; i < cnt; i++) + { + val.Printf(wxT("hcBookmark_%i"), i); + s = cfg->Read(val); + m_BookmarksNames.Add(s); + if (m_Bookmarks) m_Bookmarks->Append(s); + val.Printf(wxT("hcBookmark_%i_url"), i); + s = cfg->Read(val); + m_BookmarksPages.Add(s); + } + } + } + + if (m_HtmlWin) + m_HtmlWin->ReadCustomization(cfg); + + if (path != wxEmptyString) + cfg->SetPath(oldpath); +} + +void wxHtmlHelpWindow::WriteCustomization(wxConfigBase *cfg, const wxString& path) +{ + wxString oldpath; + wxString tmp; + + if (path != wxEmptyString) + { + oldpath = cfg->GetPath(); + cfg->SetPath(_T("/") + path); + } + + cfg->Write(wxT("hcNavigPanel"), m_Cfg.navig_on); + cfg->Write(wxT("hcSashPos"), (long)m_Cfg.sashpos); + + // Don't write if iconized as this would make the window + // disappear next time it is shown! + cfg->Write(wxT("hcX"), (long)m_Cfg.x); + cfg->Write(wxT("hcY"), (long)m_Cfg.y); + cfg->Write(wxT("hcW"), (long)m_Cfg.w); + cfg->Write(wxT("hcH"), (long)m_Cfg.h); + + cfg->Write(wxT("hcFixedFace"), m_FixedFace); + cfg->Write(wxT("hcNormalFace"), m_NormalFace); + cfg->Write(wxT("hcBaseFontSize"), (long)m_FontSize); + + if (m_Bookmarks) + { + int i; + int cnt = m_BookmarksNames.GetCount(); + wxString val; + + cfg->Write(wxT("hcBookmarksCnt"), (long)cnt); + for (i = 0; i < cnt; i++) + { + val.Printf(wxT("hcBookmark_%i"), i); + cfg->Write(val, m_BookmarksNames[i]); + val.Printf(wxT("hcBookmark_%i_url"), i); + cfg->Write(val, m_BookmarksPages[i]); + } + } + + if (m_HtmlWin) + m_HtmlWin->WriteCustomization(cfg); + + if (path != wxEmptyString) + cfg->SetPath(oldpath); +} + +static void SetFontsToHtmlWin(wxHtmlWindow *win, const wxString& scalf, const wxString& fixf, int size) +{ + int f_sizes[7]; + f_sizes[0] = int(size * 0.6); + f_sizes[1] = int(size * 0.8); + f_sizes[2] = size; + f_sizes[3] = int(size * 1.2); + f_sizes[4] = int(size * 1.4); + f_sizes[5] = int(size * 1.6); + f_sizes[6] = int(size * 1.8); + + win->SetFonts(scalf, fixf, f_sizes); +} + +class wxHtmlHelpWindowOptionsDialog : public wxDialog +{ +public: + wxComboBox *NormalFont, *FixedFont; + wxSpinCtrl *FontSize; + wxHtmlWindow *TestWin; + + wxHtmlHelpWindowOptionsDialog(wxWindow *parent) + : wxDialog(parent, wxID_ANY, wxString(_("Help Browser Options"))) + { + wxBoxSizer *topsizer = new wxBoxSizer(wxVERTICAL); + wxFlexGridSizer *sizer = new wxFlexGridSizer(2, 3, 2, 5); + + sizer->Add(new wxStaticText(this, wxID_ANY, _("Normal font:"))); + sizer->Add(new wxStaticText(this, wxID_ANY, _("Fixed font:"))); + sizer->Add(new wxStaticText(this, wxID_ANY, _("Font size:"))); + + sizer->Add(NormalFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition, + wxSize(200, wxDefaultCoord), + 0, NULL, wxCB_DROPDOWN | wxCB_READONLY)); + + sizer->Add(FixedFont = new wxComboBox(this, wxID_ANY, wxEmptyString, wxDefaultPosition, + wxSize(200, wxDefaultCoord), + 0, NULL, wxCB_DROPDOWN | wxCB_READONLY)); + + sizer->Add(FontSize = new wxSpinCtrl(this, wxID_ANY)); + FontSize->SetRange(2, 100); + + topsizer->Add(sizer, 0, wxLEFT|wxRIGHT|wxTOP, 10); + + topsizer->Add(new wxStaticText(this, wxID_ANY, _("Preview:")), + 0, wxLEFT | wxTOP, 10); + topsizer->Add(TestWin = new wxHtmlWindow(this, wxID_ANY, wxDefaultPosition, wxSize(20, 150), + wxHW_SCROLLBAR_AUTO | wxSUNKEN_BORDER), + 1, wxEXPAND | wxLEFT|wxTOP|wxRIGHT, 10); + + wxBoxSizer *sizer2 = new wxBoxSizer(wxHORIZONTAL); + wxButton *ok; + sizer2->Add(ok = new wxButton(this, wxID_OK), 0, wxALL, 10); + ok->SetDefault(); + sizer2->Add(new wxButton(this, wxID_CANCEL), 0, wxALL, 10); + topsizer->Add(sizer2, 0, wxALIGN_RIGHT); + + SetSizer(topsizer); + topsizer->Fit(this); + Centre(wxBOTH); + } + + + void UpdateTestWin() + { + wxBusyCursor bcur; + SetFontsToHtmlWin(TestWin, + NormalFont->GetStringSelection(), + FixedFont->GetStringSelection(), + FontSize->GetValue()); + + wxString content(_("font size")); + + content = _T("") + content + _T(" -2
") + _T("") + content + _T(" -1
") + _T("") + content + _T(" +0
") + _T("") + content + _T(" +1
") + _T("") + content + _T(" +2
") + _T("") + content + _T(" +3
") + _T("") + content + _T(" +4
") ; + + content = wxString( _T("
") ) + + _("Normal face
and underlined. ") + + _("Italic face. ") + + _("Bold face. ") + + _("Bold italic face.
") + + content + + wxString( _T("		") ) + + _("Fixed size face.
bold italic ") + + _("bold italic underlined
") + + content + + _T("
"); + + TestWin->SetPage( content ); + } + + void OnUpdate(wxCommandEvent& WXUNUSED(event)) + { + UpdateTestWin(); + } + void OnUpdateSpin(wxSpinEvent& WXUNUSED(event)) + { + UpdateTestWin(); + } + + DECLARE_EVENT_TABLE() + DECLARE_NO_COPY_CLASS(wxHtmlHelpWindowOptionsDialog) +}; + +BEGIN_EVENT_TABLE(wxHtmlHelpWindowOptionsDialog, wxDialog) + EVT_COMBOBOX(wxID_ANY, wxHtmlHelpWindowOptionsDialog::OnUpdate) + EVT_SPINCTRL(wxID_ANY, wxHtmlHelpWindowOptionsDialog::OnUpdateSpin) +END_EVENT_TABLE() + +void wxHtmlHelpWindow::OptionsDialog() +{ + wxHtmlHelpWindowOptionsDialog dlg(this); + unsigned i; + + if (m_NormalFonts == NULL) + { + wxFontEnumerator enu; + enu.EnumerateFacenames(); + m_NormalFonts = new wxArrayString; + *m_NormalFonts = *enu.GetFacenames(); + m_NormalFonts->Sort(); // ascending sort + } + if (m_FixedFonts == NULL) + { + wxFontEnumerator enu; + enu.EnumerateFacenames(wxFONTENCODING_SYSTEM, true /*enum fixed width only*/); + m_FixedFonts = new wxArrayString; + *m_FixedFonts = *enu.GetFacenames(); + m_FixedFonts->Sort(); // ascending sort + } + + // VS: We want to show the font that is actually used by wxHtmlWindow. + // If customization dialog wasn't used yet, facenames are empty and + // wxHtmlWindow uses default fonts -- let's find out what they + // are so that we can pass them to the dialog: + if (m_NormalFace.empty()) + { + wxFont fnt(m_FontSize, wxSWISS, wxNORMAL, wxNORMAL, false); + m_NormalFace = fnt.GetFaceName(); + } + if (m_FixedFace.empty()) + { + wxFont fnt(m_FontSize, wxMODERN, wxNORMAL, wxNORMAL, false); + m_FixedFace = fnt.GetFaceName(); + } + + for (i = 0; i < m_NormalFonts->GetCount(); i++) + dlg.NormalFont->Append((*m_NormalFonts)[i]); + for (i = 0; i < m_FixedFonts->GetCount(); i++) + dlg.FixedFont->Append((*m_FixedFonts)[i]); + if (!m_NormalFace.empty()) + dlg.NormalFont->SetStringSelection(m_NormalFace); + else + dlg.NormalFont->SetSelection(0); + if (!m_FixedFace.empty()) + dlg.FixedFont->SetStringSelection(m_FixedFace); + else + dlg.FixedFont->SetSelection(0); + dlg.FontSize->SetValue(m_FontSize); + dlg.UpdateTestWin(); + + if (dlg.ShowModal() == wxID_OK) + { + m_NormalFace = dlg.NormalFont->GetStringSelection(); + m_FixedFace = dlg.FixedFont->GetStringSelection(); + m_FontSize = dlg.FontSize->GetValue(); + SetFontsToHtmlWin(m_HtmlWin, m_NormalFace, m_FixedFace, m_FontSize); + } +} + +void wxHtmlHelpWindow::NotifyPageChanged() +{ + if (m_UpdateContents && m_PagesHash) + { + wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin); + wxHtmlHelpHashData *ha = NULL; + if (!page.empty()) + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page); + + if (ha) + { + bool olduc = m_UpdateContents; + m_UpdateContents = false; + m_ContentsBox->SelectItem(ha->m_Id); + m_ContentsBox->EnsureVisible(ha->m_Id); + m_UpdateContents = olduc; + } + } +} + +/* +EVENT HANDLING : +*/ + + +void wxHtmlHelpWindow::OnToolbar(wxCommandEvent& event) +{ + switch (event.GetId()) + { + case wxID_HTML_BACK : + m_HtmlWin->HistoryBack(); + NotifyPageChanged(); + break; + + case wxID_HTML_FORWARD : + m_HtmlWin->HistoryForward(); + NotifyPageChanged(); + break; + + case wxID_HTML_UP : + if (m_PagesHash) + { + wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin); + wxHtmlHelpHashData *ha = NULL; + if (!page.empty()) + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page); + if (ha && ha->m_Index > 0) + { + const wxHtmlHelpDataItem& it = m_Data->GetContentsArray()[ha->m_Index - 1]; + if (!it.page.empty()) + { + m_HtmlWin->LoadPage(it.GetFullPath()); + NotifyPageChanged(); + } + } + } + break; + + case wxID_HTML_UPNODE : + if (m_PagesHash) + { + wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin); + wxHtmlHelpHashData *ha = NULL; + if (!page.empty()) + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page); + if (ha && ha->m_Index > 0) + { + int level = + m_Data->GetContentsArray()[ha->m_Index].level - 1; + int ind = ha->m_Index - 1; + + const wxHtmlHelpDataItem *it = + &m_Data->GetContentsArray()[ind]; + while (ind >= 0 && it->level != level) + { + ind--; + it = &m_Data->GetContentsArray()[ind]; + } + if (ind >= 0) + { + if (!it->page.empty()) + { + m_HtmlWin->LoadPage(it->GetFullPath()); + NotifyPageChanged(); + } + } + } + } + break; + + case wxID_HTML_DOWN : + if (m_PagesHash) + { + wxString page = wxHtmlHelpHtmlWindow::GetOpenedPageWithAnchor(m_HtmlWin); + wxHtmlHelpHashData *ha = NULL; + if (!page.empty()) + ha = (wxHtmlHelpHashData*) m_PagesHash->Get(page); + + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + if (ha && ha->m_Index < (int)contents.size() - 1) + { + size_t idx = ha->m_Index + 1; + + while (contents[idx].GetFullPath() == page) idx++; + + if (!contents[idx].page.empty()) + { + m_HtmlWin->LoadPage(contents[idx].GetFullPath()); + NotifyPageChanged(); + } + } + } + break; + + case wxID_HTML_PANEL : + { + if (! (m_Splitter && m_NavigPan)) + return ; + if (m_Splitter->IsSplit()) + { + m_Cfg.sashpos = m_Splitter->GetSashPosition(); + m_Splitter->Unsplit(m_NavigPan); + m_Cfg.navig_on = false; + } + else + { + m_NavigPan->Show(); + m_HtmlWin->Show(); + m_Splitter->SplitVertically(m_NavigPan, m_HtmlWin, m_Cfg.sashpos); + m_Cfg.navig_on = true; + } + } + break; + + case wxID_HTML_OPTIONS : + OptionsDialog(); + break; + + case wxID_HTML_BOOKMARKSADD : + { + wxString item; + wxString url; + + item = m_HtmlWin->GetOpenedPageTitle(); + url = m_HtmlWin->GetOpenedPage(); + if (item == wxEmptyString) + item = url.AfterLast(wxT('/')); + if (m_BookmarksPages.Index(url) == wxNOT_FOUND) + { + m_Bookmarks->Append(item); + m_BookmarksNames.Add(item); + m_BookmarksPages.Add(url); + } + } + break; + + case wxID_HTML_BOOKMARKSREMOVE : + { + wxString item; + int pos; + + item = m_Bookmarks->GetStringSelection(); + pos = m_BookmarksNames.Index(item); + if (pos != wxNOT_FOUND) + { + m_BookmarksNames.RemoveAt(pos); + m_BookmarksPages.RemoveAt(pos); + m_Bookmarks->Delete(m_Bookmarks->GetSelection()); + } + } + break; + +#if wxUSE_PRINTING_ARCHITECTURE + case wxID_HTML_PRINT : + { + if (m_Printer == NULL) + m_Printer = new wxHtmlEasyPrinting(_("Help Printing"), this); + if (!m_HtmlWin->GetOpenedPage()) + wxLogWarning(_("Cannot print empty page.")); + else + m_Printer->PrintFile(m_HtmlWin->GetOpenedPage()); + } + break; +#endif + + case wxID_HTML_OPENFILE : + { + wxString filemask = wxString( + _("HTML files (*.html;*.htm)|*.html;*.htm|")) + + _("Help books (*.htb)|*.htb|Help books (*.zip)|*.zip|") + + _("HTML Help Project (*.hhp)|*.hhp|") + +#if wxUSE_LIBMSPACK + _("Compressed HTML Help file (*.chm)|*.chm|") + +#endif + _("All files (*.*)|*"); + wxString s = wxFileSelector(_("Open HTML document"), + wxEmptyString, + wxEmptyString, + wxEmptyString, + filemask, + wxOPEN | wxFILE_MUST_EXIST, + this); + if (!s.empty()) + { + wxString ext = s.Right(4).Lower(); + if (ext == _T(".zip") || ext == _T(".htb") || +#if wxUSE_LIBMSPACK + ext == _T(".chm") || +#endif + ext == _T(".hhp")) + { + wxBusyCursor bcur; + m_Data->AddBook(s); + RefreshLists(); + } + else + m_HtmlWin->LoadPage(s); + } + } + break; + } +} + +void wxHtmlHelpWindow::OnContentsSel(wxTreeEvent& event) +{ + wxHtmlHelpTreeItemData *pg; + + pg = (wxHtmlHelpTreeItemData*) m_ContentsBox->GetItemData(event.GetItem()); + + if (pg && m_UpdateContents) + { + const wxHtmlHelpDataItems& contents = m_Data->GetContentsArray(); + m_UpdateContents = false; + if (!contents[pg->m_Id].page.empty()) + m_HtmlWin->LoadPage(contents[pg->m_Id].GetFullPath()); + m_UpdateContents = true; + } +} + +void wxHtmlHelpWindow::OnIndexSel(wxCommandEvent& WXUNUSED(event)) +{ + wxHtmlHelpMergedIndexItem *it = (wxHtmlHelpMergedIndexItem*) + m_IndexList->GetClientData(m_IndexList->GetSelection()); + if (it) + DisplayIndexItem(it); +} + +void wxHtmlHelpWindow::OnIndexFind(wxCommandEvent& event) +{ + wxString sr = m_IndexText->GetLineText(0); + sr.MakeLower(); + if (sr == wxEmptyString) + { + OnIndexAll(event); + } + else + { + wxBusyCursor bcur; + + m_IndexList->Clear(); + const wxHtmlHelpMergedIndex& index = *m_mergedIndex; + size_t cnt = index.size(); + + int displ = 0; + for (size_t i = 0; i < cnt; i++) + { + if (index[i].name.Lower().find(sr) != wxString::npos) + { + int pos = m_IndexList->Append(index[i].name, + (char*)(&index[i])); + + if (displ++ == 0) + { + // don't automatically show topic selector if this + // item points to multiple pages: + if (index[i].items.size() == 1) + { + m_IndexList->SetSelection(0); + DisplayIndexItem(&index[i]); + } + } + + // if this is nested item of the index, show its parent(s) + // as well, otherwise it would not be clear what entry is + // shown: + wxHtmlHelpMergedIndexItem *parent = index[i].parent; + while (parent) + { + if (pos == 0 || + (index.Index(*(wxHtmlHelpMergedIndexItem*)m_IndexList->GetClientData(pos-1))) < index.Index(*parent)) + { + m_IndexList->Insert(parent->name, + pos, (char*)parent); + parent = parent->parent; + } + else break; + } + + // finally, it the item we just added is itself a parent for + // other items, show them as well, because they are refinements + // of the displayed index entry (i.e. it is implicitly contained + // in them: "foo" with parent "bar" reads as "bar, foo"): + int level = index[i].items[0]->level; + i++; + while (i < cnt && index[i].items[0]->level > level) + { + m_IndexList->Append(index[i].name, (char*)(&index[i])); + i++; + } + i--; + } + } + + wxString cnttext; + cnttext.Printf(_("%i of %i"), displ, cnt); + m_IndexCountInfo->SetLabel(cnttext); + + m_IndexText->SetSelection(0, sr.Length()); + m_IndexText->SetFocus(); + } +} + +void wxHtmlHelpWindow::OnIndexAll(wxCommandEvent& WXUNUSED(event)) +{ + wxBusyCursor bcur; + + m_IndexList->Clear(); + const wxHtmlHelpMergedIndex& index = *m_mergedIndex; + size_t cnt = index.size(); + bool first = true; + + for (size_t i = 0; i < cnt; i++) + { + m_IndexList->Append(index[i].name, (char*)(&index[i])); + if (first) + { + // don't automatically show topic selector if this + // item points to multiple pages: + if (index[i].items.size() == 1) + { + DisplayIndexItem(&index[i]); + } + first = false; + } + } + + wxString cnttext; + cnttext.Printf(_("%i of %i"), cnt, cnt); + m_IndexCountInfo->SetLabel(cnttext); +} + +void wxHtmlHelpWindow::OnSearchSel(wxCommandEvent& WXUNUSED(event)) +{ + wxHtmlHelpDataItem *it = (wxHtmlHelpDataItem*) m_SearchList->GetClientData(m_SearchList->GetSelection()); + if (it) + { + if (!it->page.empty()) + m_HtmlWin->LoadPage(it->GetFullPath()); + NotifyPageChanged(); + } +} + +void wxHtmlHelpWindow::OnSearch(wxCommandEvent& WXUNUSED(event)) +{ + wxString sr = m_SearchText->GetLineText(0); + + if (!sr.empty()) + KeywordSearch(sr, wxHELP_SEARCH_ALL); +} + +void wxHtmlHelpWindow::OnBookmarksSel(wxCommandEvent& WXUNUSED(event)) +{ + wxString sr = m_Bookmarks->GetStringSelection(); + + if (sr != wxEmptyString && sr != _("(bookmarks)")) + { + m_HtmlWin->LoadPage(m_BookmarksPages[m_BookmarksNames.Index(sr)]); + NotifyPageChanged(); + } +} + +void wxHtmlHelpWindow::OnSize(wxSizeEvent& WXUNUSED(event)) +{ + Layout(); +} + +#endif // wxUSE_WXHTML_HELP -- 2.45.2