tbx  0.7.6
Public Member Functions | List of all members
tbx::ext::StrongHelpNotFoundHandler Class Reference

interface to customise handling of StrongHelp or lookup not found message. More...

#include <stronghelp.h>

Public Member Functions

virtual bool stronghelp_not_found (StrongHelp &help, const std::string &page_or_text)
 Handler for if the page or text could not be found by StrongHelp. More...
 
virtual void stronghelp_not_running (StrongHelp &help, const std::string &page_or_text)
 Handler for if the StrongHelp program could not be run. More...
 

Detailed Description

interface to customise handling of StrongHelp or lookup not found message.

Member Function Documentation

◆ stronghelp_not_found()

bool tbx::ext::StrongHelpNotFoundHandler::stronghelp_not_found ( StrongHelp help,
const std::string &  page_or_text 
)
virtual

Handler for if the page or text could not be found by StrongHelp.

The default handler just returns false so strong help shows a message

Parameters
helpStrongHelp class with details of path used.
page_or_textpage or text that was searched for
Returns
return true if you have informed the user of the error or false to use the default StrongHelp not found message.

◆ stronghelp_not_running()

void tbx::ext::StrongHelpNotFoundHandler::stronghelp_not_running ( StrongHelp help,
const std::string &  page_or_text 
)
virtual

Handler for if the StrongHelp program could not be run.

Default show a simple error box

Parameters
helpStrongHelp class with details of path used
page_or_textpage or text that was searched for

The documentation for this class was generated from the following files: