org.eclipse.ptp.pldt.common.editorHelp

Class CHelpProviderImpl

java.lang.Object

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

All Implemented Interfaces:

org.eclipse.cdt.ui.ICHelpProvider

public abstract class CHelpProviderImpl
extends java.lang.Object
implements org.eclipse.cdt.ui.ICHelpProvider

This class implements ICHelpProvider and provides help information

Field Summary

Fields

Modifier and Type	Field and Description
protected CHelpBookImpl	helpBook

Constructor Summary

Constructors

Constructor and Description
CHelpProviderImpl()

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.cdt.ui.ICHelpBook[]	getCHelpBooks()
org.eclipse.cdt.ui.IFunctionSummary	getFunctionInfo(org.eclipse.cdt.ui.text.ICHelpInvocationContext context, org.eclipse.cdt.ui.ICHelpBook[] helpBooks, java.lang.String name) Called on hover
org.eclipse.cdt.ui.ICHelpResourceDescriptor[]	getHelpResources(org.eclipse.cdt.ui.text.ICHelpInvocationContext context, org.eclipse.cdt.ui.ICHelpBook[] helpBooks, java.lang.String name) Called on F1
org.eclipse.cdt.ui.IFunctionSummary[]	getMatchingFunctions(org.eclipse.cdt.ui.text.ICHelpInvocationContext context, org.eclipse.cdt.ui.ICHelpBook[] helpBooks, java.lang.String prefix)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.cdt.ui.ICHelpProvider

initialize

Field Detail

helpBook

protected CHelpBookImpl helpBook

Constructor Detail

CHelpProviderImpl

public CHelpProviderImpl()

Method Detail

getCHelpBooks

public org.eclipse.cdt.ui.ICHelpBook[] getCHelpBooks()

Specified by:

getCHelpBooks in interface org.eclipse.cdt.ui.ICHelpProvider

getFunctionInfo

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

Called on hover

Specified by:

getFunctionInfo in interface org.eclipse.cdt.ui.ICHelpProvider

See Also:

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

getMatchingFunctions

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

Specified by:

getMatchingFunctions in interface org.eclipse.cdt.ui.ICHelpProvider

getHelpResources

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

Called on F1

Specified by:

getHelpResources in interface org.eclipse.cdt.ui.ICHelpProvider

See Also:

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