org.eclipse.cdt.internal.ui.text
Class CHelpSettings

java.lang.Object
  extended by org.eclipse.cdt.internal.ui.text.CHelpSettings

public class CHelpSettings
extends java.lang.Object

This class represents the Help settings for the current project

Since:
2.1

Field Summary
static java.lang.String CONTRIBUTION_EXTENSION
           
 
Constructor Summary
CHelpSettings(org.eclipse.core.resources.IProject project)
           
CHelpSettings(org.eclipse.core.resources.IProject project, org.w3c.dom.Element parentElement)
           
 
Method Summary
 CHelpBookDescriptor[] getCHelpBookDescriptors()
           
 CHelpProviderDescriptor[] getCHelpProviderDescriptors()
           
 CHelpProviderDescriptor[] getCHelpProviderDescriptors(org.w3c.dom.Element projectElement)
           
 IFunctionSummary getFunctionInfo(ICHelpInvocationContext context, java.lang.String name)
           
 ICHelpResourceDescriptor[] getHelpResources(ICHelpInvocationContext context, java.lang.String name)
           
 IFunctionSummary[] getMatchingFunctions(ICHelpInvocationContext context, java.lang.String frag)
           
 org.eclipse.core.resources.IProject getProject()
           
 void serialize(org.w3c.dom.Document doc, org.w3c.dom.Element parentElement)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTRIBUTION_EXTENSION

public static final java.lang.String CONTRIBUTION_EXTENSION
See Also:
Constant Field Values
Constructor Detail

CHelpSettings

public CHelpSettings(org.eclipse.core.resources.IProject project)

CHelpSettings

public CHelpSettings(org.eclipse.core.resources.IProject project,
                     org.w3c.dom.Element parentElement)
Method Detail

getProject

public org.eclipse.core.resources.IProject getProject()

getCHelpProviderDescriptors

public CHelpProviderDescriptor[] getCHelpProviderDescriptors(org.w3c.dom.Element projectElement)

getCHelpProviderDescriptors

public CHelpProviderDescriptor[] getCHelpProviderDescriptors()

getCHelpBookDescriptors

public CHelpBookDescriptor[] getCHelpBookDescriptors()

getFunctionInfo

public IFunctionSummary getFunctionInfo(ICHelpInvocationContext context,
                                        java.lang.String name)

getMatchingFunctions

public IFunctionSummary[] getMatchingFunctions(ICHelpInvocationContext context,
                                               java.lang.String frag)

getHelpResources

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

serialize

public void serialize(org.w3c.dom.Document doc,
                      org.w3c.dom.Element parentElement)