org.eclipse.cdt.ui
Interface ICHelpProvider


public interface ICHelpProvider

Represents the C/C++ help provider

Since:
2.1

Method Summary
 ICHelpBook[] getCHelpBooks()
          Get available help books
 IFunctionSummary getFunctionInfo(ICHelpInvocationContext context, ICHelpBook[] helpBooks, java.lang.String name)
          get the matching function of a given name
 ICHelpResourceDescriptor[] getHelpResources(ICHelpInvocationContext context, ICHelpBook[] helpBooks, java.lang.String name)
           
 IFunctionSummary[] getMatchingFunctions(ICHelpInvocationContext context, ICHelpBook[] helpBooks, java.lang.String prefix)
          Get array of matching functions starting with this prefix
 void initialize()
          Initialize the completion contributor class
 

Method Detail

initialize

void initialize()
Initialize the completion contributor class


getCHelpBooks

ICHelpBook[] getCHelpBooks()
Get available help books

Returns:
The ICHelpBook[] array of available help books

getFunctionInfo

IFunctionSummary getFunctionInfo(ICHelpInvocationContext context,
                                 ICHelpBook[] helpBooks,
                                 java.lang.String name)
get the matching function of a given name

Parameters:
helpBooks - the array of help books to be searched for help
name - the function name for which help is needed
Returns:
the IFunctionSummary interface

getMatchingFunctions

IFunctionSummary[] getMatchingFunctions(ICHelpInvocationContext context,
                                        ICHelpBook[] helpBooks,
                                        java.lang.String prefix)
Get array of matching functions starting with this prefix

Parameters:
helpBooks - the array of help books to be searched for help
prefix - the function name prefix
Returns:
the IFunctionSummary[] array

getHelpResources

ICHelpResourceDescriptor[] getHelpResources(ICHelpInvocationContext context,
                                            ICHelpBook[] helpBooks,
                                            java.lang.String name)
Parameters:
helpBooks - the array of help books to be searched for help
name - the C/C++ element name for which help is needed
Returns:
the ICHelpResourceDescriptor[] array representing found help resources