git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxHelpControllerHelpProvider}}\label{wxhelpcontrollerhelpprovider}
	2
	3	wxHelpControllerHelpProvider is an implementation of wxHelpProvider which supports
	4	both context identifiers and plain text help strings. If the help text is an integer,
	5	it is passed to wxHelpController::DisplayContextPopup. Otherwise, it shows the string
	6	in a tooltip as per wxSimpleHelpProvider. If you use this with a wxCHMHelpController instance
	7	on windows, it will use the native style of tip window instead of \helpref{wxTipWindow}{wxtipwindow}.
	8
	9	You can use the convenience function {\bf wxContextId} to convert an integer context
	10	id to a string for passing to \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}.
	11
	12	\wxheading{Derived from}
	13
	14	\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}\\
	15	\helpref{wxHelpProvider}{wxhelpprovider}
	16
	17	\wxheading{Include files}
	18
	19	<wx/cshelp.h>
	20
	21	\wxheading{Library}
	22
	23	\helpref{wxCore}{librarieslist}
	24
	25	\wxheading{See also}
	26
	27	\helpref{wxHelpProvider}{wxhelpprovider}, \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider},
	28	\helpref{wxContextHelp}{wxcontexthelp}, \helpref{wxWindow::SetHelpText}{wxwindowsethelptext},
	29	\helpref{wxWindow::GetHelpTextAtPoint}{wxwindowgethelptextatpoint}
	30
	31	\latexignore{\rtfignore{\wxheading{Members}}}
	32
	33	\membersection{wxHelpControllerHelpProvider::wxHelpControllerHelpProvider}\label{wxhelpcontrollerhelpproviderwxhelpcontrollerhelpprovider}
	34
	35	\func{}{wxHelpControllerHelpProvider}{\param{wxHelpControllerBase* }{hc = NULL}}
	36
	37	Note that the instance doesn't own the help controller. The help controller
	38	should be deleted separately.
	39
	40	\membersection{wxHelpControllerHelpProvider::SetHelpController}\label{wxhelpcontrollerhelpprovidersethelpcontroller}
	41
	42	\func{void}{SetHelpController}{\param{wxHelpControllerBase* }{hc}}
	43
	44	Sets the help controller associated with this help provider.
	45
	46	\membersection{wxHelpControllerHelpProvider::GetHelpController}\label{wxhelpcontrollerhelpprovidergethelpcontroller}
	47
	48	\constfunc{wxHelpControllerBase*}{GetHelpController}{\void}
	49
	50	Returns the help controller associated with this help provider.
	51