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

first part of revisions of html/h* interface headers

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56497 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-23 13:55:07 +00:00
parent 4726bcc51b
commit c87f263ea5
5 changed files with 241 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
interface/wx/html/helpdata.h
View File

@@ -9,13 +9,14 @@
/**
@class wxHtmlHelpData
This class is used by wxHtmlHelpController
and wxHtmlHelpFrame to access HTML help items.
This class is used by wxHtmlHelpController and 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.
@library{wxhtml}
@category{FIXME}
@category{help,html}
*/
class wxHtmlHelpData : public wxObject
{
@@ -26,9 +27,12 @@ public:
wxHtmlHelpData();
/**
Adds new book. @e book is URL (not filename!) 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").
Adds new book.
@a book_url is URL (not filename!) 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.
*/
bool AddBook(const wxString& book_url);
@@ -59,7 +63,7 @@ public:
const wxHtmlHelpDataItems GetIndexArray();
/**
Sets temporary directory where binary cached versions of MS HTML Workshop
Sets the 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.)
*/