Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add description for GetFrameParameters() function; some other minor fixes (closes ticket #10146)

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56888 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-11-22 10:32:14 +00:00
parent c9f9deab81
commit 704171f290
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
interface/wx/help.h
View File

@@ -35,7 +35,7 @@
The remaining help controller classes need to be named explicitly by an The remaining help controller classes need to be named explicitly by an
application that wishes to make use of them. application that wishes to make use of them.
There are currently the following help controller classes defined: The following help controller classes are defined:
- wxWinHelpController, for controlling Windows Help. - wxWinHelpController, for controlling Windows Help.
- wxCHMHelpController, for controlling MS HTML Help. To use this, you need to - wxCHMHelpController, for controlling MS HTML Help. To use this, you need to
set wxUSE_MS_HTML_HELP to 1 in setup.h and have htmlhelp.h header from set wxUSE_MS_HTML_HELP to 1 in setup.h and have htmlhelp.h header from
@@ -44,12 +44,12 @@
compilers). compilers).
- wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime - wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime
is not available, wxHtmlHelpController. You need to provide @b both CHM and is not available, wxHtmlHelpController. You need to provide @b both CHM and
HTB versions of the help file. For 32bit Windows only. HTB versions of the help file. For wxMSW only.
- wxExtHelpController, for controlling external browsers under Unix. - wxExtHelpController, for controlling external browsers under Unix.
The default browser is Netscape Navigator. The 'help' sample shows its use. The default browser is Netscape Navigator. The 'help' sample shows its use.
- wxWinceHelpController, for controlling a simple @c .htm help controller for - wxWinceHelpController, for controlling a simple @c .htm help controller for
Windows CE applications. Windows CE applications.
- wxHtmlHelpController, a sophisticated help controller using wxHTML(), in a - wxHtmlHelpController, a sophisticated help controller using wxHTML, in a
similar style to the Microsoft HTML Help viewer and using some of the same similar style to the Microsoft HTML Help viewer and using some of the same
files. Although it has an API compatible with other help controllers, it has files. Although it has an API compatible with other help controllers, it has
more advanced features, so it is recommended that you use the specific API more advanced features, so it is recommended that you use the specific API
@@ -142,9 +142,16 @@ public:
const wxPoint& pos); const wxPoint& pos);
/** /**
wxHtmlHelpController returns the frame, size and position. For wxHtmlHelpController, returns the latest frame size and position
For all other help controllers, this function does nothing and just settings and whether a new frame is drawn with each invocation.
returns @NULL. For all other help controllers, this function does nothing and just returns @NULL.
@param size
The most recent frame size.
@param pos
The most recent frame position.
@param newFrameEachTime
@true if a new frame is drawn with each invocation.
*/ */
virtual wxFrame* GetFrameParameters(const wxSize* size = NULL, virtual wxFrame* GetFrameParameters(const wxSize* size = NULL,
const wxPoint* pos = NULL, const wxPoint* pos = NULL,