Version: 3.0.4
wxHtmlHelpData Class Reference

#include <wx/html/helpdata.h>

+ Inheritance diagram for wxHtmlHelpData:

Detailed Description

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:  Help, HTML

Public Member Functions

 wxHtmlHelpData ()
 Constructor. More...
 
bool AddBook (const wxString &book_url)
 Adds new book. More...
 
wxString FindPageById (int id)
 Returns page's URL based on integer ID stored in project. More...
 
wxString FindPageByName (const wxString &page)
 Returns page's URL based on its (file)name. More...
 
const wxHtmlBookRecArray & GetBookRecArray () const
 Returns array with help books info. More...
 
const wxHtmlHelpDataItems & GetContentsArray () const
 Returns reference to array with contents entries. More...
 
const wxHtmlHelpDataItems & GetIndexArray () const
 Returns reference to array with index entries. More...
 
void SetTempDir (const wxString &path)
 Sets the temporary directory where binary cached versions of MS HTML Workshop files will be stored. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxHtmlHelpData::wxHtmlHelpData ( )

Constructor.

Member Function Documentation

bool wxHtmlHelpData::AddBook ( const wxString book_url)

Adds new book.

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.

wxString wxHtmlHelpData::FindPageById ( int  id)

Returns page's URL based on integer ID stored in project.

wxString wxHtmlHelpData::FindPageByName ( const wxString page)

Returns page's URL based on its (file)name.

const wxHtmlBookRecArray& wxHtmlHelpData::GetBookRecArray ( ) const

Returns array with help books info.

const wxHtmlHelpDataItems& wxHtmlHelpData::GetContentsArray ( ) const

Returns reference to array with contents entries.

const wxHtmlHelpDataItems& wxHtmlHelpData::GetIndexArray ( ) const

Returns reference to array with index entries.

void wxHtmlHelpData::SetTempDir ( const wxString path)

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.)