org.eclipse.ptp.pldt.common.editorHelp

Class CHelpBookImpl

java.lang.Object

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

All Implemented Interfaces:

org.eclipse.cdt.ui.ICHelpBook

public class CHelpBookImpl
extends java.lang.Object
implements org.eclipse.cdt.ui.ICHelpBook

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

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,org.eclipse.cdt.ui.IFunctionSummary>	funcName2FuncInfo

Fields inherited from interface org.eclipse.cdt.ui.ICHelpBook

HELP_TYPE_ASM, HELP_TYPE_C, HELP_TYPE_CPP

Constructor Summary

Constructors

Constructor and Description
CHelpBookImpl(java.lang.String pluginId) Constructor

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

funcName2FuncInfo

protected java.util.Map<java.lang.String,org.eclipse.cdt.ui.IFunctionSummary> funcName2FuncInfo

Constructor Detail

CHelpBookImpl

public CHelpBookImpl(java.lang.String pluginId)

Constructor

Parameters:

pluginId -

Method Detail

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface org.eclipse.cdt.ui.ICHelpBook

setTitle

protected void setTitle(java.lang.String title)

Parameters:

title -

getCHelpType

public int getCHelpType()

Specified by:

getCHelpType in interface org.eclipse.cdt.ui.ICHelpBook

getFunctionInfo

public org.eclipse.cdt.ui.IFunctionSummary getFunctionInfo(org.eclipse.cdt.ui.text.ICHelpInvocationContext context,
                                                  java.lang.String name)

Get available info on the give function by name

Parameters:

context -

name -

Returns:

getMatchingFunctions

public org.eclipse.cdt.ui.IFunctionSummary[] getMatchingFunctions(org.eclipse.cdt.ui.text.ICHelpInvocationContext context,
                                                         java.lang.String prefix)

Return a list of functions that begin with the given prefix

Parameters:

context -

prefix -

Returns:

getHelpResources

public org.eclipse.cdt.ui.ICHelpResourceDescriptor[] getHelpResources(org.eclipse.cdt.ui.text.ICHelpInvocationContext context,
                                                             java.lang.String name)

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

Parameters:

context -

name -

Returns:

func

public void func(java.lang.String fname,
        java.lang.String desc,
        java.lang.String retType,
        java.lang.String args)

Convenience function for filling in table info

Since:

5.0