adjusted indentation with astyle; added Id keyword

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions

View File

@@ -9,37 +9,37 @@
/**
@class wxHtmlHelpController
@headerfile helpctrl.h wx/html/helpctrl.h
This help controller provides an easy way of displaying HTML help in your
application (see @e test sample). The help system is based on @b books
application (see @e test sample). The help system is based on @b books
(see wxHtmlHelpController::AddBook). A book is a logical
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 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 here.
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 @b
htmlWorkshopFiles to @b @true in
your tex2rtf.ini file. The commercial tool HelpBlocks (www.helpblocks.com) can
also create these files.
@library{wxhtml}
@category{help}
@seealso
@ref overview_wxhelpcontroller "Information about wxBestHelpController",
wxHtmlHelpFrame, wxHtmlHelpDialog, wxHtmlHelpWindow, wxHtmlModalHelp
*/
class wxHtmlHelpController
class wxHtmlHelpController
{
public:
/**
@@ -55,25 +55,25 @@ public:
This must be called at least once before displaying any help.
@e bookFile or @e bookUrl may be either .hhp file or ZIP archive
that contains arbitrary number of .hhp files in
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, @c
AddBook(wxFileName("help.zip"))
AddBook(wxFileName("help.zip"))
is possible and is the recommended way.
@param showWaitMsg
@param showWaitMsg
If @true then a decoration-less window with progress message is displayed.
@param bookFile
@param bookFile
Help book filename. It is recommended to use this prototype
instead of the one taking URL, because it is less error-prone.
@param bookUrl
Help book URL (note that syntax of filename and URL is
@param bookUrl
Help book URL (note that syntax of filename and URL is
different on most platforms)
*/
bool AddBook(const wxFileName& bookFile, bool showWaitMsg);
bool AddBook(const wxString& bookUrl, bool showWaitMsg);
bool AddBook(const wxString& bookUrl, bool showWaitMsg);
//@}
/**
@@ -94,7 +94,7 @@ public:
This alternative form is used to search help contents by numeric IDs.
*/
void Display(const wxString& x);
void Display(const int id);
void Display(const int id);
//@}
/**
@@ -128,10 +128,10 @@ public:
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 @e not
that no cached data are stored). Note that these files are @e not
deleted when program exits.
Once created these cached files will be used in all subsequent executions
Once created these cached files will be used in all subsequent executions
of your application. If cached files become older than corresponding .hhp
file (e.g. if you regenerate documentation) it will be refreshed.
*/
@@ -151,9 +151,9 @@ public:
The only thing you must do is create wxConfig object and call UseConfig.
If you do not use @e UseConfig, wxHtmlHelpController will use
default wxConfig object if available (for details see
wxConfigBase::Get and
If you do not use @e UseConfig, wxHtmlHelpController will use
default wxConfig object if available (for details see
wxConfigBase::Get and
wxConfigBase::Set).
*/
void UseConfig(wxConfigBase* config,
@@ -170,39 +170,39 @@ public:
/**
@class wxHtmlModalHelp
@headerfile helpctrl.h wx/html/helpctrl.h
This class uses wxHtmlHelpController
This class uses 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:
@code
// 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"));
@endcode
@library{wxhtml}
@category{FIXME}
*/
class wxHtmlModalHelp
class wxHtmlModalHelp
{
public:
/**
@param parent
@param parent
is the parent of the dialog.
@param helpFile
@param helpFile
is the HTML help file to show.
@param topic
@param topic
is an optional topic. If this is empty, the help contents will be shown.
@param style
@param style
is a combination of the flags described in the wxHtmlHelpController
documentation.
*/