// Purpose: interface of wxHtmlHelpDialog
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxHtmlHelpDialog
- This class is used by wxHtmlHelpController
- to display help.
+ This class is used by 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.
@library{wxhtml}
- @category{FIXME}
+ @category{help,html}
*/
-class wxHtmlHelpDialog : public wxFrame
+class wxHtmlHelpDialog : public wxDialog
{
public:
- //@{
+ wxHtmlHelpDialog(wxHtmlHelpData* data = NULL);
+
/**
- Constructor. For the values of @e style, please see the documentation for
- wxHtmlHelpController.
+ Constructor.
+
+ For the possible values of @a style, please see wxHtmlHelpController.
*/
- wxHtmlHelpDialog(wxHtmlHelpData* data = NULL);
- wxHtmlHelpDialog(wxWindow* parent, int wxWindowID,
+ wxHtmlHelpDialog(wxWindow* parent, wxWindowID id,
const wxString& title = wxEmptyString,
int style = wxHF_DEFAULT_STYLE,
wxHtmlHelpData* data = NULL);
- //@}
/**
You may override this virtual method to add more buttons to the help window's
toolbar. @a toolBar is a pointer to the toolbar and @a style is the style
- flag as passed to the Create method.
+ flag as passed to the Create() method.
+
wxToolBar::Realize is called immediately after returning from this function.
*/
virtual void AddToolbarButtons(wxToolBar* toolBar, int style);
/**
- Creates the dialog. See @ref wxhtmlhelpdialog() "the constructor"
+ Creates the dialog. See @ref wxHtmlHelpDialog() "the constructor"
for a description of the parameters.
*/
bool Create(wxWindow* parent, wxWindowID id,
*/
wxHtmlHelpController* GetController() const;
- /**
- Reads the user's settings for this dialog see
- wxHtmlHelpController::ReadCustomization)
- */
- void ReadCustomization(wxConfigBase* cfg,
- const wxString& path = wxEmptyString);
-
/**
Sets the help controller associated with the dialog.
*/
- void SetController(wxHtmlHelpController* contoller);
+ void SetController(wxHtmlHelpController* controller);
/**
- Sets the dialog's title format. @a format must contain exactly one "%s"
- (it will be replaced by the page title).
- */
- void SetTitleFormat(const wxString& format);
+ Sets the dialog's title format.
- /**
- Saves the user's settings for this dialog (see
- wxHtmlHelpController::WriteCustomization).
+ @a format must contain exactly one "%s" (it will be replaced by the page title).
*/
- void WriteCustomization(wxConfigBase* cfg,
- const wxString& path = wxEmptyString);
+ void SetTitleFormat(const wxString& format);
};