Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Mmedia, OGL lib directory changes; omitted naughty wxGA_SMOOTH style from wxProgressDialog;

Browse Source 
wxMotif toolbar fix; ~wxWindow Motif fix


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6558 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2000-03-09 20:15:44 +00:00
parent b4414c1f37
commit 7b28757f5e
21 changed files with 232 additions and 166 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
docs/latex/wx/helpinst.tex
View File

@@ -38,8 +38,7 @@ is reasonably close to the wxWindows help controller API; see {\tt wx/helpwxht.h
details of use.
\item \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}, a more sophisticated help controller using \helpref{wxHTML}{wxhtml}, in
a similar style to the Windows HTML Help viewer and using some of the same files.
The API is not the same as the standard API, which is why it is documented separately.
\item wxXLPHelpController, for controlling wxHelp (from wxWindows 1). Obsolete.
%The API is not the same as the standard API, which is why it is documented separately.
\end{itemize}
\wxheading{Derived from}
@@ -54,7 +53,7 @@ wxHelpControllerBase\\
<wx/helpwin.h> (Windows Help controller)\\
<wx/generic/helpext.h> (external HTML browser controller)
<wx/generic/helpwxht.h> (wxHTML based help controller)
<wx/generic/helpxlp.h> (wxHelp controller)
<wx/html/helpctrl.h> (Advanced wxHTML based help controller: wxHtmlHelpController)
\wxheading{See also}
@@ -85,7 +84,11 @@ number if using wxHelp. Does not invoke the help viewer.
This must be called directly after the help instance object is created and before
any attempts to communicate with the viewer.
You may omit the file extension and a suitable one will be chosen.
You may omit the file extension and a suitable one will be chosen. For
wxHtmlHelpController, the extensions zip, htb and hhp will be appended while searching for
a suitable file. For WinHelp, the hlp extension is appended. For wxHelpControllerHtml (the
standard HTML help controller), the filename is assumed to be a directory containing
the HTML files.
\membersection{wxHelpController::DisplayBlock}\label{wxhelpcontrollerdisplayblock}
@@ -93,12 +96,12 @@ You may omit the file extension and a suitable one will be chosen.
If the help viewer is not running, runs it and displays the file at the given block number.
{\it wxHelp:} this is the wxHelp block number.
{\it WinHelp:} Refers to the context number.
{\it External HTML help:} the same as for \helpref{wxHelpController::DisplaySection}{wxhelpcontrollerdisplaysection}.
{\it wxHtmlHelpController:} {\it sectionNo} is an identifier as specified in the {\tt .hhc} file. See \helpref{Help files format}{helpformat}.
\membersection{wxHelpController::DisplayContents}\label{wxhelpcontrollerdisplaycontents}
\func{virtual bool}{DisplayContents}{\void}
@@ -112,8 +115,6 @@ contents.
If the help viewer is not running, runs it and displays the given section.
{\it wxHelp:} Sections are numbered starting from 1. Section numbers may be viewed by running wxHelp in edit mode.
{\it WinHelp:} {\it sectionNo} is a context id.
{\it External HTML help/wxHTML based help:} wxExtHelpController and wxHelpControllerHtml implement {\it sectionNo} as an id in a map file, which is of the form:
@@ -124,62 +125,24 @@ If the help viewer is not running, runs it and displays the given section.
2 wx204.html ; Function reference
\end{verbatim}
\membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch}
\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}}
If the help viewer is not running, runs it, and searches for sections matching the given keyword. If one
match is found, the file is displayed at this section.
{\it wxHelp:} If more than one
match is found, the Search dialog is displayed with the matches.
{\it WinHelp:} If more than one match is found,
the first topic is displayed.
{\it External HTML help:} If more than one match is found,
a choice of topics is displayed.
\membersection{wxHelpController::LoadFile}\label{wxhelpcontrollerloadfile}
\func{virtual bool}{LoadFile}{\param{const wxString\& }{file = ""}}
If the help viewer is not running, runs it and loads the given file.
If the filename is not supplied or is
NULL, the file specified in {\bf Initialize} is used. If the viewer is
already displaying the specified file, it will not be reloaded. This
member function may be used before each display call in case the user
has opened another file.
\membersection{wxHelpController::SetViewer}\label{wxhelpcontrollersetviewer}
\func{virtual void}{SetViewer}{\param{const wxString\& }{viewer}, \param{long}{ flags}}
Sets detailed viewer information. So far this is only relevant to wxExtHelpController.
\membersection{wxHelpController::SetFrameParameters}\label{wxhelpcontrollersetframeparameters}
\func{virtual void}{SetFrameParameters}
{\param{const wxString \& }{title},
\param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
\param{bool }{newFrameEachTime = FALSE}}
For the wxHelpControllerHtml, this allows the application to set the
default frame title, size and position for the frame. If the title
contains \%s, this will be replaced with the page title. If the
parammeter newFrameEachTime is set, the controller will open a new
help frame each time it is called. For all other help controllers this
function has no effect.
{\it wxHtmlHelpController:} {\it sectionNo} is an identifier as specified in the {\tt .hhc} file. See \helpref{Help files format}{helpformat}.
\membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters}
\func{virtual wxFrame *}{GetFrameParameters}
{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
\func{virtual wxFrame *}{GetFrameParameters}{\param{const wxSize * }{size = NULL}, \param{const wxPoint * }{pos = NULL},
\param{bool *}{newFrameEachTime = NULL}}
This reads the current settings for the help frame in the case of the
wxHelpControllerHtml, setting the frame size, position and
the newFrameEachTime parameters to the last values used. It also
returns the pointer to the last opened help frame. This can be used
for example, to automatically close the help frame on program
shutdown. For all other help controllers, this function does nothing
shutdown.
wxHtmlHelpController returns the frame,
size and position.
For all other help controllers, this function does nothing
and just returns NULL.
\wxheading{Parameters}
@@ -189,6 +152,34 @@ and just returns NULL.
\docparam{flags}{This defaults to wxHELP\_NETSCAPE for wxExtHelpController, indicating
that the viewer is a variant of Netscape Navigator.}
\membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch}
\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}}
If the help viewer is not running, runs it, and searches for sections matching the given keyword. If one
match is found, the file is displayed at this section.
{\it WinHelp:} If more than one match is found,
the first topic is displayed.
{\it External HTML help:} If more than one match is found,
a choice of topics is displayed.
{\it wxHtmlHelpController:} see \helpref{wxHtmlHelpController::KeywordSearch}{wxhtmlhelpcontrollerkeywordsearch}.
\membersection{wxHelpController::LoadFile}\label{wxhelpcontrollerloadfile}
\func{virtual bool}{LoadFile}{\param{const wxString\& }{file = ""}}
If the help viewer is not running, runs it and loads the given file.
If the filename is not supplied or is
empty, the file specified in {\bf Initialize} is used. If the viewer is
already displaying the specified file, it will not be reloaded. This
member function may be used before each display call in case the user
has opened another file.
wxHtmlHelpController ignores this call.
\membersection{wxHelpController::OnQuit}\label{wxhelpcontrolleronquit}
\func{virtual bool}{OnQuit}{\void}
@@ -197,6 +188,38 @@ Overridable member called when this application's viewer is quit by the user.
This does not work for all help controllers.
\membersection{wxHelpController::SetFrameParameters}\label{wxhelpcontrollersetframeparameters}
\func{virtual void}{SetFrameParameters}{\param{const wxString \& }{title},
\param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition},
\param{bool }{newFrameEachTime = FALSE}}
For wxHelpControllerHtml, this allows the application to set the
default frame title, size and position for the frame. If the title
contains \%s, this will be replaced with the page title. If the
parameter newFrameEachTime is set, the controller will open a new
help frame each time it is called.
For wxHtmlHelpController, the title is set (again with \%s indicating the
page title) and also the size and position of the frame if the frame is already
open. {\it newFrameEachTime} is ignored.
For all other help controllers this function has no effect.
\membersection{wxHelpController::SetViewer}\label{wxhelpcontrollersetviewer}
\func{virtual void}{SetViewer}{\param{const wxString\& }{viewer}, \param{long}{ flags}}
Sets detailed viewer information. So far this is only relevant to wxExtHelpController.
Some examples of usage:
\begin{verbatim}
m_help.SetViewer("kdehelp");
m_help.SetViewer("gnome-help-browser");
m_help.SetViewer("netscape", wxHELP_NETSCAPE);
\end{verbatim}
\membersection{wxHelpController::Quit}\label{wxhelpcontrollerquit}
\func{virtual bool}{Quit}{\void}

26
docs/latex/wx/hthelpct.tex
View File

@@ -9,7 +9,7 @@
wxHelpController!}
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}
application (see {\it test} sample). The help system is based on {\bf books}
(see \helpref{AddBook}{wxhtmlhelpcontrolleraddbook}). A book is a logical
section of documentation (for example "User's Guide" or "Programmer's Guide" or
"C++ Reference" or "wxWindows Reference"). The help controller can handle as
@@ -33,9 +33,9 @@ have the following line in your .rc file:
It is strongly recommended to use preprocessed {\bf .hhp.cached} version of
projects. It can be either created on-the-fly (see
\helpref{SetTempDir}{wxhtmlhelpcontrollersettempdir}) or you can use
\helpref{SetTempDir}{wxhtmlhelpcontrollersettempdir}) or you can use
{\bf hhp2cached} utility from {\it utils/hhp2cached} to create it and
distribute the cached version together with helpfiles. See {\it samples/html/help}
distribute the cached version together with helpfiles. See {\it samples/html/help}
sample for demonstration of its use.
\wxheading{Derived from}
@@ -46,7 +46,6 @@ sample for demonstration of its use.
<wx/html/helpctrl.h>
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
@@ -59,7 +58,7 @@ Constructor.
{\it style} is combination of these flags:
\begin{twocollist}
\begin{twocollist}\itemsep=0pt
\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.}
@@ -85,6 +84,13 @@ recommended way.
If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed.
\membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}
\func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}}
This protected virtual method may be overriden so that the controller
uses slightly different frame. See {\it samples/html/helpview} sample for
an example.
\membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
\func{void}{Display}{\param{const wxString\& }{x}}
@@ -152,7 +158,7 @@ Reads the controller's setting (position of window, etc.)
Sets the path for storing temporary files - cached binary versions of index and contents files. These binary
forms are much faster to read. Default value is empty string (empty string means
that no cached data are stored). Note that these files are {\it not}
that no cached data are stored). Note that these files are {\it not}
deleted when program exits.
Once created these cached files will be used in all subsequent executions
@@ -188,12 +194,4 @@ default wxConfig object if available (for details see
Stores controllers setting (position of window etc.)
\membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}
\func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}}
This protected virtual method may be overriden so that the controller
uses slightly different frame. See {\it samples/html/helpview} sample for
an example.

8
docs/latex/wx/hthlpdat.tex
View File

@@ -5,12 +5,11 @@
\section{\class{wxHtmlHelpData}}\label{wxhtmlhelpdata}
This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
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}
@@ -21,14 +20,12 @@ you're writing your own HTML help controller.
\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}}
@@ -38,21 +35,18 @@ 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}

9
docs/latex/wx/hthlpfrm.tex
View File

@@ -5,7 +5,7 @@
\section{\class{wxHtmlHelpFrame}}\label{wxhtmlhelpframe}
This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
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.
@@ -18,7 +18,6 @@ when you're writing your own HTML help controller.
<wx/html/helpfrm.h>
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxHtmlHelpFrame::wxHtmlHelpFrame}\label{wxhtmlhelpframewxhtmlhelpframe}
@@ -131,14 +130,14 @@ Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCus
\func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}}
Refresh all panels. This is necessary if new book was added.
Refresh all panels. This is necessary if a 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).
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}