/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help;
/**
* A context registered for context-sensitive help.
* <p>
* This interface models the context-sensitive help that can be associated with
* SWT menus, menu items, and controls, and with JFace actions. A help context
* provides the text description of the object with which it is associated with,
* as well as topic links that contain more related information. This
* information would be displayed to the user when context sensitive help (F1)
* is requested.
* </p>
* <p>
* In the current implementation of the Help system, valid contexts can be
* contributed through the <code>contexts</code> element of the
* <code>"org.eclipse.help.contexts"</code> extension point. The
* <code>IHelp.findContext(String)</code> method is used at runtime to create
* or fetch IContext objects using there fully qualified contextIds. If there is
* a need to override this behavior, then this IContext interface could be
* implemented by a client and registered with the SWT control or JFace action.
* </p>
*/
public interface IContext {
/**
* Returns a list of related topics for this help context.
*
* @return a list of related help topics or <code>null</code>
* if no related topics have been defined for this context.
* @since 2.0
*/
public IHelpResource[] getRelatedTopics();
/**
* Returns the text description for this context.
*
* @return the text description
*/
public String getText();
}
|