org.eclipse.ptp.pldt.common.editorHelp
Class CHelpBookImpl

java.lang.Object
  org.eclipse.ptp.pldt.common.editorHelp.CHelpBookImpl

public class CHelpBookImpl
extends Object

C Help Book implementation for hover help, etc. etc. Note: this is (one of?) only package that is fully exported. For PTP 6.0, consider package re-arrangement such that only the parts that need to be accessible to downstream plug-ins (esp. outside of PTP proper and thus x-friend-able) are in the exported package. perhaps a pldt.common.internal.editorHelp package?

Field Summary

protected Map<String,IFunctionSummary>

funcName2FuncInfo

Constructor Summary

CHelpBookImpl(String pluginId)
Constructor

Method Summary

void	func(String fname, String desc, String retType, String args) Convenience function for filling in table info
int	getCHelpType()
IFunctionSummary	getFunctionInfo(ICHelpInvocationContext context, String name) Get available info on the give function by name
ICHelpResourceDescriptor[]	getHelpResources(ICHelpInvocationContext context, String name) Get the HelpBook information for the given name (e.g. a function/API)
IFunctionSummary[]	getMatchingFunctions(ICHelpInvocationContext context, String prefix) Return a list of functions that begin with the given prefix
String	getTitle()
protected void	setTitle(String title)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

funcName2FuncInfo

protected Map<String,IFunctionSummary> funcName2FuncInfo

Constructor Detail

CHelpBookImpl

public CHelpBookImpl(String pluginId)

Constructor

Parameters:

pluginId -

Method Detail

getTitle

public String getTitle()

setTitle

protected void setTitle(String title)

Parameters:

title -

getCHelpType

public int getCHelpType()

getFunctionInfo

public IFunctionSummary getFunctionInfo(ICHelpInvocationContext context,
                                        String name)

Get available info on the give function by name

Parameters:

context -

name -

Returns:

getMatchingFunctions

public IFunctionSummary[] getMatchingFunctions(ICHelpInvocationContext context,
                                               String prefix)

Return a list of functions that begin with the given prefix

Parameters:

context -

prefix -

Returns:

getHelpResources

public ICHelpResourceDescriptor[] getHelpResources(ICHelpInvocationContext context,
                                                   String name)

Get the HelpBook information for the given name (e.g. a function/API)

Parameters:

context -

name -

Returns:

func

public void func(String fname,
                 String desc,
                 String retType,
                 String args)

Convenience function for filling in table info

Since:

5.0