Eclipse Plug-in Developer Guide (Galileo) - Uses of Interface org.eclipse.help.IHelpResource (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV NEXT

NO FRAMES

Uses of Interface
org.eclipse.help.IHelpResource

Packages that use IHelpResource
org.eclipse.help	Provides core help system for the platform.
org.eclipse.help.search	Provides the ability to add participants to help search and is responsible for creating search indices.

Uses of IHelpResource in org.eclipse.help

Subinterfaces of IHelpResource in org.eclipse.help

interface IToc
An IToc represents the root node of a toc, for either a complete toc (book) or a part of one to be assembled into a larger one.

interface ITopic
An ITopic is one topic in the table of contents, which may contain subtopics.

Methods in org.eclipse.help that return IHelpResource

IHelpResource[] IContext. getRelatedTopics ()
Returns a list of related topics for this help context.

Methods in org.eclipse.help with parameters of type IHelpResource

void IHelp. displayHelpResource ( IHelpResource helpResource)
Deprecated. Use WorkbenchHelp.displayHelpResource(helpResource.getHref()) instead.

String IContext2. getCategory ( IHelpResource topic)
Returns the category of the provided topic.

Uses of IHelpResource in org.eclipse.help.search

Methods in org.eclipse.help.search that return IHelpResource

IHelpResource ISearchEngineResult. getCategory ()
Returns a category this search result belongs to.