wxhelpcontrollerhelpprovider

wxhelpcontrollerhelpprovider is an implementation of wxhelpprovider which supports both context identifiers and plain text help strings. if the help text is an integer, it is passed to wxhelpcontroller::displaycontextpopup. otherwise, it shows the string in a tooltip as per wxsimplehelpprovider. if you use this with a wxchmhelpcontroller instance on windows, it will use the native style of tip window instead of wxtipwindow.

you can use the convenience function wxcontextid to convert an integer context id to a string for passing to wxwindow::sethelptext.

derived from

wxsimplehelpprovider
wxhelpprovider

include files

<wx/cshelp.h>

see also

wxhelpprovider, wxsimplehelpprovider, wxcontexthelp, wxwindow::sethelptext, wxwindow::gethelptextatpoint

members

wxhelpcontrollerhelpprovider::wxhelpcontrollerhelpprovider
wxhelpcontrollerhelpprovider::sethelpcontroller
wxhelpcontrollerhelpprovider::gethelpcontroller

wxhelpcontrollerhelpprovider::wxhelpcontrollerhelpprovider

wxhelpcontrollerhelpprovider(wxhelpcontrollerbase* hc = null)

note that the instance doesn't own the help controller. the help controller should be deleted separately.

wxhelpcontrollerhelpprovider::sethelpcontroller

void sethelpcontroller(wxhelpcontrollerbase* hc)

sets the help controller associated with this help provider.

wxhelpcontrollerhelpprovider::gethelpcontroller

wxhelpcontrollerbase* gethelpcontroller() const

returns the help controller associated with this help provider.