CHelpBookImpl (PTP API Specification)

```
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?

Fields
Modifier and Type	Field and Description
`protected Map<String,IFunctionSummary>`	`funcName2FuncInfo`

Constructors
Constructor and Description
`CHelpBookImpl(String pluginId)` Constructor

Methods
Modifier and Type	Method and Description
`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)`

protected Map<String,IFunctionSummary> funcName2FuncInfo

protected void setTitle(String title)

public IFunctionSummary getFunctionInfo(ICHelpInvocationContext context,
                               String name)

Get available info on the give function by name

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

Return a list of functions that begin with the given prefix

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

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

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

Convenience function for filling in table info

Class CHelpBookImpl