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

37
interface/wx/html/helpfrm.h
View File

@@ -9,39 +9,39 @@
/**
@class wxHtmlHelpFrame
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 wxHtmlHelpFrame : public wxFrame
{
public:
//@{
/**
Constructor. For the values of @e style, please see the documentation for
wxHtmlHelpController.
*/
wxHtmlHelpFrame(wxHtmlHelpData* data = NULL);
/**
Constructor.
For the possible values of @a style, please see wxHtmlHelpController.
*/
wxHtmlHelpFrame(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.
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 frame. See @ref wxhtmlhelpframe() "the constructor"
Creates the frame. See @ref wxHtmlHelpFrame() "the constructor"
for a description of the parameters.
*/
bool Create(wxWindow* parent, wxWindowID id,
@@ -54,8 +54,9 @@ public:
wxHtmlHelpController* GetController() const;
/**
Reads the user's settings for this frame see
wxHtmlHelpController::ReadCustomization)
Reads the user's settings for this frame.
@see wxHtmlHelpController::ReadCustomization
*/
void ReadCustomization(wxConfigBase* cfg,
const wxString& path = wxEmptyString);
@@ -66,14 +67,16 @@ public:
void SetController(wxHtmlHelpController* contoller);
/**
Sets the frame's title format. @a format must contain exactly one "%s"
(it will be replaced by the page title).
Sets the frame'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 frame (see
wxHtmlHelpController::WriteCustomization).
Saves the user's settings for this frame.
@see wxHtmlHelpController::WriteCustomization
*/
void WriteCustomization(wxConfigBase* cfg,
const wxString& path = wxEmptyString);