Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
82
interface/wx/html/helpfrm.h
Normal file
82
interface/wx/html/helpfrm.h
Normal file
@@ -0,0 +1,82 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: html/helpfrm.h
|
||||
// Purpose: interface of wxHtmlHelpFrame
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
@class wxHtmlHelpFrame
|
||||
@headerfile helpfrm.h wx/html/helpfrm.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 wxHtmlHelpFrame : public wxFrame
|
||||
{
|
||||
public:
|
||||
//@{
|
||||
/**
|
||||
Constructor. For the values of @e style, please see the documentation for
|
||||
wxHtmlHelpController.
|
||||
*/
|
||||
wxHtmlHelpFrame(wxHtmlHelpData* data = NULL);
|
||||
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.
|
||||
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"
|
||||
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 frame.
|
||||
*/
|
||||
wxHtmlHelpController* GetController() const;
|
||||
|
||||
/**
|
||||
Reads the user's settings for this frame see
|
||||
wxHtmlHelpController::ReadCustomization)
|
||||
*/
|
||||
void ReadCustomization(wxConfigBase* cfg,
|
||||
const wxString& path = wxEmptyString);
|
||||
|
||||
/**
|
||||
Sets the help controller associated with the frame.
|
||||
*/
|
||||
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).
|
||||
*/
|
||||
void SetTitleFormat(const wxString& format);
|
||||
|
||||
/**
|
||||
Saves the user's settings for this frame (see
|
||||
wxHtmlHelpController::WriteCustomization).
|
||||
*/
|
||||
void WriteCustomization(wxConfigBase* cfg,
|
||||
const wxString& path = wxEmptyString);
|
||||
};
|
||||
|
Reference in New Issue
Block a user