#include <MOT_HelpManager.h>

Inheritance diagram for MOT_HelpManager:

Public Member Functions
	MOT_HelpManager ()

	~MOT_HelpManager () override

virtual void	openContents () override
	Opens the table of contenst help page. More...

virtual void	openStartup () override
	Opens the special essential-skills page on startup. More...

virtual void	openFile (const char *path) override
	Opens a help page defined by the file. More...

virtual void	openURL (const char *url) override

virtual void	openHelpPath (const char *help_path) override

virtual void	displayData (const char *data, bool is_html) override
	Displays the buffer data in help browser. More...

void	openTooltipWindow (const char *text, int x, int y, int w, int h) const override

void	openTooltipURLWindow (const char *url, int x, int y, int w, int h) const override

virtual void	closeAllTooltipWindows () const override
	} More...

bool	getTooltip (const char *url, UT_String &tooltip) override
	Obtains a tool tip from the help page pointed to by the URL. More...

bool	getTooltip (const PRM_Parm *parm, UT_String &tooltip) override
	Obtains a tool tip for the specified parameter. More...

bool	getParsedTooltip (const char url_key, const char full_help, UT_String &tooltip) override

bool	getTextHelp (const char *url, UT_String &text_help) override

UT_StringHolder	getCommandHelp (const char *command) override
	Return the text help for the given hscript command. More...

UT_StringHolder	getExprCommandHelp (const char *command) override
	Return the text help for the given hscript expression command. More...

UT_StringArray	getCommandsForHelpKeyword (const char *keyword) override

UT_StringArray	getExprCommandsForHelpKeyword (const char *keyword) override

virtual void	openHelpCard (OP_Node *node) override

virtual void	openHelpCard (OP_Operator op, const char node_path=nullptr) override

virtual void	openHelpCard (BM_State *state) override

virtual void	openHelpCard (SHLF_Tool *tool) override

virtual void	openHelpCard (const PYP_Interface *interface) override

virtual void	openHelpCard (OP_GalleryEntry *entry) override

virtual void	openHelpCard (const PRM_ScriptParm *prop) override

void	getHelpCardURL (OP_Operator *op, UT_String &str) override

void	getHelpCardURL (BM_State *state, UT_String &url) override

void	getHelpCardURL (SHLF_Tool *tool, UT_String &url) override

void	getHelpCardURL (const PYP_Interface *interface, UT_String &url) override

void	getHelpCardURL (OP_GalleryEntry *entry, UT_String &url) override

void	getHelpCardURL (const PRM_ScriptParm *prop, UT_String &url) override

void	getHelpCardURL (const char *helpTopicId, UT_String &url) override

void	getHelpCardURL (const PRM_Parm *parm, UT_String &help_path) override

void	setBaseURI (const char *base_uri) override
	Sets the base URI that is used to disambiguate the relative URLs. More...

const UT_String &	getBaseURI () const override
	Returns the baseURI. More...

bool	getUseExternalHelp () const override

void	setUseExternalHelp (bool use_external) override
	Sets whether the help manager should use an external help server or not. More...

void	setHelpAddress (const char *help_address) override
	Sets the address the help server should bind to. More...

const UT_StringHolder &	getHelpAddress () const override

void	setUseIPv6 (bool use_ipv6) override
	Sets if the help server can use ipv6. More...

bool	getUseIPv6 () const override

const UT_String &	getExternalHelpURL () const override

void	setExternalHelpURL (const char *ext_help_url) override
	Sets the url to the external help server. More...

const UT_String &	getHelpBaseURL () override
	Returns the base URL for all of Houdini's help. More...

const UT_String &	getStartupURL () override
	Returns the url for the help startup page. More...

virtual void	closeFloatingPane () override
	Closes the help pane. More...

Public Member Functions inherited from UT_HelpManager
	UT_HelpManager ()

virtual	~UT_HelpManager ()

void	setDesiredHelpLocation (fpreal x, fpreal y)

void	clearDesiredHelpLocation ()

void	setFloatingHelpPaneId (int pane_id)

int	getFloatingHelpPaneId () const

Protected Member Functions
virtual bool	extractTooltip (const char *url, UT_String &tooltip)

virtual void	updateBaseURLInHelpBrowsersSubclass ()

void	countHelpCardPress (const char *message)
	Count help cards opening times for FS_datalogger. More...

bool	getServerHasHelp (const char *url)
	Checks whether the help server has the help page under the given URL. More...

UT_StringArray &	getURLStack ()

void	prefixWithHelpBaseURL (const char *help_path, UT_String &url)

OP_Operator *	getOpFromURL (const char *url)
	Parses URL and tries to obtain the entity. More...

OP_GalleryEntry *	getGalleryEntryFromURL (const char *url)

const PRM_ScriptParm *	getPropFromURL (const char *url)

void	resolveHelpPath (const char *help_path, UT_String &resolved_path)

Protected Member Functions inherited from UT_HelpManager
bool	getDesiredHelpLocation (float &x, float &y)

Additional Inherited Members
Static Public Member Functions inherited from UT_HelpManager
static bool	platformSupportsHtmlHelp ()

static void	constructOpBasedURL (const char protocol, const char optable, const char optype, const char extra, UT_String &url)

static bool	parseOpBasedURL (const char url, const char protocol, UT_String &optable, UT_String &optype, UT_String &extra)

static UT_HelpManager *	getHelpManager ()

static void	setHelpManager (UT_HelpManager *help_manager)

Detailed Description

Definition at line 24 of file MOT_HelpManager.h.

Constructor & Destructor Documentation

MOT_HelpManager::MOT_HelpManager ( )

MOT_HelpManager::~MOT_HelpManager ( )

override

Member Function Documentation

virtual void MOT_HelpManager::closeAllTooltipWindows ( ) const

overridevirtual

}

Close all tooltip popup windows. Do nothing if there are no open tooltip popup windows.

Implements UT_HelpManager.

virtual void MOT_HelpManager::closeFloatingPane ( )

overridevirtual

Closes the help pane.

Implements UT_HelpManager.

void MOT_HelpManager::countHelpCardPress ( const char * message )

protected

Count help cards opening times for FS_datalogger.

virtual void MOT_HelpManager::displayData	(	const char *	data,
		bool	is_html
	)

overridevirtual

Displays the buffer data in help browser.

Implements UT_HelpManager.

virtual bool MOT_HelpManager::extractTooltip	(	const char *	url,
		UT_String &	tooltip
	)

protectedvirtual

Helper function for getTooltip(const char *, UT_String&). Attempts to extract an operator, gallery entry or parameter tooltip from the given url.

const UT_String& MOT_HelpManager::getBaseURI ( ) const

inlineoverridevirtual

Returns the baseURI.

Implements UT_HelpManager.

Definition at line 137 of file MOT_HelpManager.h.

UT_StringHolder MOT_HelpManager::getCommandHelp ( const char * command )

overridevirtual

Return the text help for the given hscript command.

Implements UT_HelpManager.

UT_StringArray MOT_HelpManager::getCommandsForHelpKeyword ( const char * keyword )

overridevirtual

Return an array of hscript commands whose text help contain a match for the given keyword.

Implements UT_HelpManager.

UT_StringHolder MOT_HelpManager::getExprCommandHelp ( const char * command )

overridevirtual

Return the text help for the given hscript expression command.

Implements UT_HelpManager.

UT_StringArray MOT_HelpManager::getExprCommandsForHelpKeyword ( const char * keyword )

overridevirtual

Return an array of hscript expression commands whose text help conotain a match for the given keyword.

Implements UT_HelpManager.

const UT_String& MOT_HelpManager::getExternalHelpURL ( ) const

inlineoverridevirtual

Returns the base url for the external help server. Returns "" if no external help server is used.

Implements UT_HelpManager.

Definition at line 160 of file MOT_HelpManager.h.

OP_GalleryEntry* MOT_HelpManager::getGalleryEntryFromURL ( const char * url )

protected

const UT_StringHolder& MOT_HelpManager::getHelpAddress ( ) const

inlineoverridevirtual

Implements UT_HelpManager.

Definition at line 150 of file MOT_HelpManager.h.

const UT_String& MOT_HelpManager::getHelpBaseURL ( )

overridevirtual

Returns the base URL for all of Houdini's help.

Implements UT_HelpManager.

void MOT_HelpManager::getHelpCardURL	(	OP_Operator *	op,
		UT_String &	str
	)

overridevirtual

Implements UT_HelpManager.

void MOT_HelpManager::getHelpCardURL	(	BM_State *	state,
		UT_String &	url
	)

overridevirtual

Implements UT_HelpManager.

void MOT_HelpManager::getHelpCardURL	(	SHLF_Tool *	tool,
		UT_String &	url
	)

overridevirtual

Implements UT_HelpManager.

void MOT_HelpManager::getHelpCardURL	(	const PYP_Interface *	interface,
		UT_String &	url
	)

overridevirtual

Implements UT_HelpManager.

void MOT_HelpManager::getHelpCardURL	(	OP_GalleryEntry *	entry,
		UT_String &	url
	)

overridevirtual

Implements UT_HelpManager.

void MOT_HelpManager::getHelpCardURL	(	const PRM_ScriptParm *	prop,
		UT_String &	url
	)

overridevirtual

Implements UT_HelpManager.

void MOT_HelpManager::getHelpCardURL	(	const char *	helpTopicId,
		UT_String &	url
	)

overridevirtual

Implements UT_HelpManager.

void MOT_HelpManager::getHelpCardURL	(	const PRM_Parm *	parm,
		UT_String &	help_path
	)

overridevirtual

Implements UT_HelpManager.

OP_Operator* MOT_HelpManager::getOpFromURL ( const char * url )

protected

Parses URL and tries to obtain the entity.

bool MOT_HelpManager::getParsedTooltip	(	const char *	url_key,
		const char *	full_help,
		UT_String &	tooltip
	)

overridevirtual

Obtains a tool tip conained by the full help text. The url serves as a caching key.

Implements UT_HelpManager.

const PRM_ScriptParm* MOT_HelpManager::getPropFromURL ( const char * url )

protected

bool MOT_HelpManager::getServerHasHelp ( const char * url )

protected

Checks whether the help server has the help page under the given URL.

const UT_String& MOT_HelpManager::getStartupURL ( )

overridevirtual

Returns the url for the help startup page.

Implements UT_HelpManager.

bool MOT_HelpManager::getTextHelp	(	const char *	url,
		UT_String &	text_help
	)

overridevirtual

Obtains a plain text version of the help page pointed to by the URL (e.g. 'vex:attrib').

Implements UT_HelpManager.

bool MOT_HelpManager::getTooltip	(	const char *	url,
		UT_String &	tooltip
	)

overridevirtual

Obtains a tool tip from the help page pointed to by the URL.

Implements UT_HelpManager.

bool MOT_HelpManager::getTooltip	(	const PRM_Parm *	parm,
		UT_String &	tooltip
	)

overridevirtual

Obtains a tool tip for the specified parameter.

Implements UT_HelpManager.

UT_StringArray& MOT_HelpManager::getURLStack ( )

inlineprotected

Definition at line 193 of file MOT_HelpManager.h.

bool MOT_HelpManager::getUseExternalHelp ( ) const

inlineoverridevirtual

Returns true if the help manager is using an external help server. Returns false otherwise.

Implements UT_HelpManager.

Definition at line 142 of file MOT_HelpManager.h.

bool MOT_HelpManager::getUseIPv6 ( ) const

inlineoverridevirtual

Implements UT_HelpManager.

Definition at line 155 of file MOT_HelpManager.h.

virtual void MOT_HelpManager::openContents ( )

overridevirtual

Opens the table of contenst help page.

Implements UT_HelpManager.

virtual void MOT_HelpManager::openFile ( const char * path )

overridevirtual

Opens a help page defined by the file.

Implements UT_HelpManager.

virtual void MOT_HelpManager::openHelpCard ( OP_Node * node )

overridevirtual

Implements UT_HelpManager.

virtual void MOT_HelpManager::openHelpCard	(	OP_Operator *	op,
		const char *	node_path = `nullptr`
	)

overridevirtual

Implements UT_HelpManager.

virtual void MOT_HelpManager::openHelpCard ( BM_State * state )

overridevirtual

Implements UT_HelpManager.

virtual void MOT_HelpManager::openHelpCard ( SHLF_Tool * tool )

overridevirtual

Implements UT_HelpManager.

virtual void MOT_HelpManager::openHelpCard ( const PYP_Interface * interface )

overridevirtual

Implements UT_HelpManager.

virtual void MOT_HelpManager::openHelpCard ( OP_GalleryEntry * entry )

overridevirtual

Implements UT_HelpManager.

virtual void MOT_HelpManager::openHelpCard ( const PRM_ScriptParm * prop )

overridevirtual

Implements UT_HelpManager.

virtual void MOT_HelpManager::openHelpPath ( const char * help_path )

overridevirtual

Implements UT_HelpManager.

virtual void MOT_HelpManager::openStartup ( )

overridevirtual

Opens the special essential-skills page on startup.

Implements UT_HelpManager.

void MOT_HelpManager::openTooltipURLWindow	(	const char *	url,
		int	x,
		int	y,
		int	w,
		int	h
	)		const

overridevirtual

Implements UT_HelpManager.

void MOT_HelpManager::openTooltipWindow	(	const char *	text,
		int	x,
		int	y,
		int	w,
		int	h
	)		const

overridevirtual

Open the requested tooltip in a popup window. x,y,w,h represents the native screen position and size of the source feel that the tooltip is for. If there is no source feel, then pass in (0,0,0,0) for x,y,w,h. {

Implements UT_HelpManager.

virtual void MOT_HelpManager::openURL ( const char * url )

overridevirtual

Opens a URL in the help browser (url can be of forms "http://u.r.l", "hdox://u.r.l", "operator:table/name", "tool:name" etc)

Implements UT_HelpManager.