wxWidgets/interface/html/helpdlg.h

82 lines
2.7 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: html/helpdlg.h
// Purpose: documentation for wxHtmlHelpDialog class
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@class wxHtmlHelpDialog
@headerfile helpdlg.h wx/html/helpdlg.h
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}
*/
class wxHtmlHelpDialog : public wxFrame
{
public:
//@{
/**
Constructor. For the values of @e style, please see the documentation for
wxHtmlHelpController.
*/
wxHtmlHelpDialog(wxHtmlHelpData* data = NULL);
wxHtmlHelpDialog(wxWindow* parent, int wxWindowID,
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.
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"
for a description of the parameters.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxString& title = wxEmptyString,
int style = wxHF_DEFAULT_STYLE);
/**
Returns the help controller associated with the dialog.
*/
wxHtmlHelpController* GetController();
/**
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);
/**
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);
/**
Saves the user's settings for this dialog (see
wxHtmlHelpController::WriteCustomization).
*/
void WriteCustomization(wxConfigBase* cfg,
const wxString& path = wxEmptyString);
};