From 09397bc6e9b3137904d1ddfafaa1d5f73830df60 Mon Sep 17 00:00:00 2001
From: =?utf8?q?V=C3=A1clav=20Slav=C3=ADk?= <vslavik@fastmail.fm>
Date: Wed, 27 Oct 1999 23:30:38 +0000
Subject: [PATCH] documented Harm's changes to wxHTML help

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@4229 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/classes.tex  |   2 +
 docs/latex/wx/hthelpct.tex |  15 +++-
 docs/latex/wx/hthlpdat.tex | 110 ++++++++++++++++++++++++++
 docs/latex/wx/hthlpfrm.tex | 154 +++++++++++++++++++++++++++++++++++++
 docs/latex/wx/htprint.tex  |  62 ++++++++-------
 5 files changed, 315 insertions(+), 28 deletions(-)
 create mode 100644 docs/latex/wx/hthlpdat.tex
 create mode 100644 docs/latex/wx/hthlpfrm.tex

diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index b3b967630e..8092cfb7db 100644
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -94,6 +94,8 @@
 \input hteasypr.tex
 \input htfilter.tex
 \input hthelpct.tex
+\input hthlpdat.tex
+\input hthlpfrm.tex
 \input htparser.tex
 \input htprint.tex
 \input httag.tex
diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex
index 1e42b78f9a..fab6403bc2 100644
--- a/docs/latex/wx/hthelpct.tex
+++ b/docs/latex/wx/hthelpct.tex
@@ -36,10 +36,23 @@ wxEvtHandler
 
 \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
 
-\func{}{wxHtmlHelpController}{\void}
+\func{}{wxHtmlHelpController}{\param{int }{style = wxHF_DEFAULTSTYLE}}
 
 Constructor.
 
+\wxheading{Parameters}
+
+{\it style} is combination of these flags:
+
+\begin{twocollist}
+\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
+\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.}
+\end{twocollist}
+
+Default value : everything enabled.
+
 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 
 \func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}}
diff --git a/docs/latex/wx/hthlpdat.tex b/docs/latex/wx/hthlpdat.tex
new file mode 100644
index 0000000000..672591c25b
--- /dev/null
+++ b/docs/latex/wx/hthlpdat.tex
@@ -0,0 +1,110 @@
+%
+% automatically generated by HelpGen from
+% helpdata.h at 24/Oct/99 18:03:10
+%
+
+\section{\class{wxHtmlHelpData}}\label{wxhtmlhelpdata}
+
+This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
+and \helpref{wxHtmlHelpFrame}{wxhtmlhelpframe} to access HTML help items.
+It is internal class and should not be used directly - except for the case 
+you're writing your own HTML help controller.
+
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+\membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata}
+
+\func{}{wxHtmlHelpData}{\void}
+
+Constructor.
+
+
+\membersection{wxHtmlHelpData::AddBook}\label{wxhtmlhelpdataaddbook}
+
+\func{bool}{AddBook}{\param{const wxString\& }{book}}
+
+Adds new book. 'book' is location of HTML help project (hhp) or ZIP file
+that contains arbitrary number of .hhp projects (this zip file can have
+either .zip or .htb extension, htb stands for "html book").
+Returns success.
+
+
+\membersection{wxHtmlHelpData::FindPageById}\label{wxhtmlhelpdatafindpagebyid}
+
+\func{wxString}{FindPageById}{\param{int }{id}}
+
+Returns page's URL based on integer ID stored in project.
+
+
+\membersection{wxHtmlHelpData::FindPageByName}\label{wxhtmlhelpdatafindpagebyname}
+
+\func{wxString}{FindPageByName}{\param{const wxString\& }{page}}
+
+Returns page's URL based on its (file)name.
+
+
+\membersection{wxHtmlHelpData::GetBookRecArray}\label{wxhtmlhelpdatagetbookrecarray}
+
+\func{const wxHtmlBookRecArray\&}{GetBookRecArray}{\void}
+
+Returns array with help books info.
+
+\membersection{wxHtmlHelpData::GetContents}\label{wxhtmlhelpdatagetcontents}
+
+\func{wxHtmlContentsItem*}{GetContents}{\void}
+
+Returns contents lists pointer.
+
+\membersection{wxHtmlHelpData::GetContentsCnt}\label{wxhtmlhelpdatagetcontentscnt}
+
+\func{int}{GetContentsCnt}{\void}
+
+Returns size of contents list.
+
+\membersection{wxHtmlHelpData::GetIndex}\label{wxhtmlhelpdatagetindex}
+
+\func{wxHtmlContentsItem*}{GetIndex}{\void}
+
+Returns pointer to index items list.
+
+\membersection{wxHtmlHelpData::GetIndexCnt}\label{wxhtmlhelpdatagetindexcnt}
+
+\func{int}{GetIndexCnt}{\void}
+
+Returns size of index list.
+
+\membersection{wxHtmlHelpData::LoadCachedBook}\label{wxhtmlhelpdataloadcachedbook}
+
+\func{bool}{LoadCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxInputStream* }{f}}
+
+Reads binary cached book.
+
+
+\membersection{wxHtmlHelpData::LoadMSProject}\label{wxhtmlhelpdataloadmsproject}
+
+\func{bool}{LoadMSProject}{\param{wxHtmlBookRecord* }{book}, \param{wxFileSystem\& }{fsys}, \param{const wxString\& }{indexfile}, \param{const wxString\& }{contentsfile}}
+
+Imports .hhp files (MS HTML Help Workshop).
+
+\membersection{wxHtmlHelpData::SaveCachedBook}\label{wxhtmlhelpdatasavecachedbook}
+
+\func{bool}{SaveCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxOutputStream* }{f}}
+
+Saves binary cached book. (Internal - this methods is used automatically
+if you call SetTempDir!)
+
+\membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}
+
+\func{void}{SetTempDir}{\param{const wxString\& }{path}}
+
+Sets temporary directory where binary cached versions of MS HTML Workshop
+files will be stored. (This is turned off by default and you can enable
+this feature by setting non-empty temp dir.)
+
diff --git a/docs/latex/wx/hthlpfrm.tex b/docs/latex/wx/hthlpfrm.tex
new file mode 100644
index 0000000000..309630c65a
--- /dev/null
+++ b/docs/latex/wx/hthlpfrm.tex
@@ -0,0 +1,154 @@
+%
+% automatically generated by HelpGen from
+% helpfrm.h at 24/Oct/99 18:03:10
+%
+
+
+\section{\class{wxHtmlHelpFrame}}\label{wxhtmlhelpframe}
+
+This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
+to display help.
+It is internal class and should not be used directly - except for the case 
+you're writing your own HTML help controller.
+
+
+\wxheading{Derived from}
+
+\helpref{wxFrame}{wxframe}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+
+
+\membersection{wxHtmlHelpFrame::wxHtmlHelpFrame}\label{wxhtmlhelpframewxhtmlhelpframe}
+
+\func{}{wxHtmlHelpFrame}{\param{wxHtmlHelpData* }{data = NULL}}
+
+\func{}{wxHtmlHelpFrame}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}, \param{wxHtmlHelpData* }{data = NULL}}
+
+Constructor.
+
+{\it style} is combination of these flags:
+
+\begin{twocollist}
+\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
+\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.}
+\end{twocollist}
+
+
+\membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate}
+
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}}
+
+Creates the frame.
+
+{\it style} is combination of these flags:
+
+\begin{twocollist}
+\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
+\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.}
+\end{twocollist}
+
+
+
+\membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
+
+\func{void}{CreateContents}{\param{bool }{show\_progress = FALSE}}
+
+Creates contents panel. (May take some time.)
+
+
+\membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
+
+\func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}}
+
+Creates index panel. (May take some time.)
+
+
+\membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch}
+
+\func{void}{CreateSearch}{\void}
+
+Creates search panel.
+
+
+\membersection{wxHtmlHelpFrame::Display}\label{wxhtmlhelpframedisplay}
+
+\func{bool}{Display}{\param{const wxString\& }{x}}
+
+\func{bool}{Display}{\param{const int }{id}}
+
+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 ...")
+
+The second form takes numeric ID as the parameter.
+(uses extension to MS format, <param name="ID" value=id>)
+
+\membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents}
+
+\func{bool}{DisplayContents}{\void}
+
+Displays contents panel.
+
+\membersection{wxHtmlHelpFrame::DisplayIndex}\label{wxhtmlhelpframedisplayindex}
+
+\func{bool}{DisplayIndex}{\void}
+
+Displays index panel.
+
+
+\membersection{wxHtmlHelpFrame::GetData}\label{wxhtmlhelpframegetdata}
+
+\func{wxHtmlHelpData*}{GetData}{\void}
+
+Return wxHtmlHelpData object.
+
+\membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch}
+
+\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
+
+Search for given keyword.
+
+
+\membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
+
+\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
+
+Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
+
+\membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
+
+\func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}}
+
+Refresh all panels. This is neccessary if new book was added.
+
+\membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat}
+
+\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
+
+Sets frame's title format. {\it format} must contain exactly one "\%s"
+(it will be replaced by page's title).
+
+\membersection{wxHtmlHelpFrame::UseConfig}\label{wxhtmlhelpframeuseconfig}
+
+\func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
+
+Add books to search choice panel
+
+
+\membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization}
+
+\func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
+
+Saves user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization})
+
+
diff --git a/docs/latex/wx/htprint.tex b/docs/latex/wx/htprint.tex
index 262cee2815..d81a124e99 100644
--- a/docs/latex/wx/htprint.tex
+++ b/docs/latex/wx/htprint.tex
@@ -3,44 +3,44 @@
 % htmprint.h at 17/Oct/99 12:48:02
 %
 
+
 \section{\class{wxHtmlPrintout}}\label{wxhtmlprintout}
 
-This class serves as a printout class for HTML documents.
+This class serves as printout class for HTML documents.
 
 \wxheading{Derived from}
 
 \helpref{wxPrintout}{wxprintout}
 
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxHtmlPrintout::wxHtmlPrintout}\label{wxhtmlprintoutwxhtmlprintout}
 
 \func{}{wxHtmlPrintout}{\param{const wxString\& }{title = "Printout"}}
 
 Constructor. 
 
-\membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext}
 
-\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}}
-
-Prepare the class for printing this HTML text.
 
-\wxheading{Parameters}
+\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}
 
-\docparam{html}{HTML text. (NOT file!)}
+\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
 
-\docparam{basepath}{base directory (html string would be stored there if it was in
-file). It is used to determine path for loading images, for example.}
+Sets page footer.
 
-\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name
-(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
+\wxheading{Parameters}
 
-\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}
+\docparam{footer}{HTML text to be used as footer. You can use macros in it:
+\begin{itemize}
+\item @PAGENUM@ is replaced by page number
+\item @PAGESCNT@ is replaced by total number of pages
+\end{itemize}
+}
 
-\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}}
+\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 
-Prepare the class for printing this HTML {\bf file}. The file may be located on 
-any virtual file system or it may be normal file.
 
 \membersection{wxHtmlPrintout::SetHeader}\label{wxhtmlprintoutsetheader}
 
@@ -51,8 +51,7 @@ Sets page header.
 \wxheading{Parameters}
 
 \docparam{header}{HTML text to be used as header. You can use macros in it:
-
-\begin{itemize}\itemsep=0pt
+\begin{itemize}
 \item @PAGENUM@ is replaced by page number
 \item @PAGESCNT@ is replaced by total number of pages
 \end{itemize}
@@ -61,23 +60,32 @@ Sets page header.
 \docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 
 
-\membersection{wxHtmlPrintout::SetFooter}\label{wxhtmlprintoutsetfooter}
+\membersection{wxHtmlPrintout::SetHtmlFile}\label{wxhtmlprintoutsethtmlfile}
 
-\func{void}{SetFooter}{\param{const wxString\& }{footer}, \param{int }{pg = wxPAGE\_ALL}}
+\func{void}{SetHtmlFile}{\param{const wxString\& }{htmlfile}}
 
-Sets page footer.
+Prepare the class for printing this HTML {\bf file}. The file may be located on 
+any virtual file system or it may be normal file.
+
+
+
+\membersection{wxHtmlPrintout::SetHtmlText}\label{wxhtmlprintoutsethtmltext}
+
+\func{void}{SetHtmlText}{\param{const wxString\& }{html}, \param{const wxString\& }{basepath = wxEmptyString}, \param{bool }{isdir = TRUE}}
+
+Prepare the class for printing this HTML text.
 
 \wxheading{Parameters}
 
-\docparam{footer}{HTML text to be used as footer. You can use macros in it:
+\docparam{html}{HTML text. (NOT file!)}
+
+\docparam{basepath}{base directory (html string would be stored there if it was in
+file). It is used to determine path for loading images, for example.}
+
+\docparam{isdir}{FALSE if basepath is filename, TRUE if it is directory name
+(see \helpref{wxFileSystem}{wxfilesystem} for detailed explanation)}
 
-\begin{itemize}\itemsep=0pt
-\item @PAGENUM@ is replaced by page number
-\item @PAGESCNT@ is replaced by total number of pages
-\end{itemize}
-}
 
-\docparam{pg}{one of wxPAGE\_ODD, wxPAGE\_EVEN and wxPAGE\_ALL constants.}
 
 \membersection{wxHtmlPrintout::SetMargins}\label{wxhtmlprintoutsetmargins}
 
-- 
2.50.0

