]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/hthlpfrm.tex
Added wxWrapSizer (modified patch: [1826950] Wrapping Sizer) from Arne Steinarson
[wxWidgets.git] / docs / latex / wx / hthlpfrm.tex
index 49ca992bcc4f4f73710bee23c757f597745ff399..92dc708ce4b922f99a1f0117dd8fee678027723c 100644 (file)
@@ -12,12 +12,20 @@ when you're writing your own HTML help controller.
 
 \wxheading{Derived from}
 
-\helpref{wxFrame}{wxframe}
+\helpref{wxFrame}{wxframe}\\
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/html/helpdlg.h>
 
+\wxheading{Library}
+
+\helpref{wxHtml}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlHelpDialog::wxHtmlHelpDialog}\label{wxhtmlhelpdialogwxhtmlhelpdialog}
@@ -85,12 +93,20 @@ when you're writing your own HTML help controller.
 
 \wxheading{Derived from}
 
-\helpref{wxFrame}{wxframe}
+\helpref{wxFrame}{wxframe}\\
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/html/helpfrm.h>
 
+\wxheading{Library}
+
+\helpref{wxHtml}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlHelpFrame::wxHtmlHelpFrame}\label{wxhtmlhelpframewxhtmlhelpframe}
@@ -165,7 +181,7 @@ For example:
     m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config object here
     m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);    
     m_embeddedHelpWindow->Create(this,
-        wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE);        
+        wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);        
     m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
 \end{verbatim}
 
@@ -174,29 +190,35 @@ the embedded window to be destroyed independently of the help controller.
 
 \wxheading{Derived from}
 
-\helpref{wxWindow}{wxwindow}
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/html/helpwnd.h>
 
+\wxheading{Library}
+
+\helpref{wxHtml}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlHelpWindow::wxHtmlHelpWindow}\label{wxhtmlhelpwindowwxhtmlhelpwindow}
 
 \func{}{wxHtmlHelpWindow}{\param{wxHtmlHelpData* }{data = NULL}}
 
-\func{}{wxHtmlHelpWindow}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
+\func{}{wxHtmlHelpWindow}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ pos = wxDefaultSize}, \param{int }{style = wxTAB\_TRAVERSAL|wxBORDER\_NONE}, \param{int }{helpStyle = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
 
 Constructor.
 
-Constructor. For the values of {\it style}, please see the documentation for \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}.
+Constructor. For the values of {\it helpStyle}, please see the documentation for \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}.
 
 \membersection{wxHtmlHelpWindow::Create}\label{wxhtmlhelpwindowcreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}}
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ pos = wxDefaultSize}, \param{int }{style = wxTAB\_TRAVERSAL|wxBORDER\_NONE}, \param{int }{helpStyle = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
 
-Creates the frame. See \helpref{the constructor}{wxhtmlhelpwindowwxhtmlhelpwindow}
+Creates the help window. See \helpref{the constructor}{wxhtmlhelpwindowwxhtmlhelpwindow}
 for a description of the parameters.
 
 \membersection{wxHtmlHelpWindow::CreateContents}\label{wxhtmlhelpwindowcreatecontents}
@@ -337,6 +359,10 @@ None
 
 <wx/html/helpctrl.h>
 
+\wxheading{Library}
+
+\helpref{wxHtml}{librarieslist}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxHtmlModalHelp::wxHtmlModalHelp}\label{wxhtmlmodalhelpctor}
@@ -346,12 +372,11 @@ None
 
 \wxheading{Parameters}
 
-{\it parent} is the parent of the dialog.
-
-{\it helpFile} is the HTML help file to show.
+\docparam{parent}{is the parent of the dialog.}
 
-{\it topic} is an optional topic. If this is empty, the help contents will be shown.
+\docparam{helpFile}{is the HTML help file to show.}
 
-{\it style} is a combination of the flags described in the \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} documentation.
+\docparam{topic}{is an optional topic. If this is empty, the help contents will be shown.}
 
+\docparam{style}{is a combination of the flags described in the \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} documentation.}