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

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

public abstract class CHelpProviderImpl
extends Object

This class implements ICHelpProvider and provides help information

Field Summary

protected CHelpBookImpl

helpBook

Constructor Summary

CHelpProviderImpl()

Method Summary

ICHelpBook[]	getCHelpBooks()
IFunctionSummary	getFunctionInfo(ICHelpInvocationContext context, ICHelpBook[] helpBooks, String name) Called on hover
ICHelpResourceDescriptor[]	getHelpResources(ICHelpInvocationContext context, ICHelpBook[] helpBooks, String name) Called on F1
IFunctionSummary[]	getMatchingFunctions(ICHelpInvocationContext context, ICHelpBook[] helpBooks, String prefix)

Methods inherited from class java.lang.Object

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

Field Detail

helpBook

protected CHelpBookImpl helpBook

Constructor Detail

CHelpProviderImpl

public CHelpProviderImpl()

Method Detail

getCHelpBooks

public ICHelpBook[] getCHelpBooks()

getFunctionInfo

public IFunctionSummary getFunctionInfo(ICHelpInvocationContext context,
                                        ICHelpBook[] helpBooks,
                                        String name)

Called on hover

See Also:

org.eclipse.cdt.ui.ICHelpProvider#getFunctionInfo(org.eclipse.cdt.ui.text.ICHelpInvocationContext, org.eclipse.cdt.ui.ICHelpBook[], java.lang.String)

getMatchingFunctions

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

getHelpResources

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

Called on F1

See Also:

org.eclipse.cdt.ui.ICHelpProvider#getHelpResources(org.eclipse.cdt.ui.text.ICHelpInvocationContext, org.eclipse.cdt.ui.ICHelpBook[], java.lang.String)