org.eclipse.cdt.ui
Interface ICHelpBook


public interface ICHelpBook

Represents the help book, that is a set of articles on some topic. Such as "C functions", "Qt library", etc., provided by help provider.

Since:
2.1
See Also:
ICHelpProvider

Field Summary
static int HELP_TYPE_ASM
           
static int HELP_TYPE_C
           
static int HELP_TYPE_CPP
           
 
Method Summary
 int getCHelpType()
          gets the type of Help provided with this book that might be ine of ICHelpBook.HELP_TYPE_XXX
 java.lang.String getTitle()
          returns the tytle of the Help Book
 

Field Detail

HELP_TYPE_C

static final int HELP_TYPE_C
See Also:
Constant Field Values

HELP_TYPE_CPP

static final int HELP_TYPE_CPP
See Also:
Constant Field Values

HELP_TYPE_ASM

static final int HELP_TYPE_ASM
See Also:
Constant Field Values
Method Detail

getTitle

java.lang.String getTitle()
returns the tytle of the Help Book

Returns:
String representing the HelpBook tytle

getCHelpType

int getCHelpType()
gets the type of Help provided with this book that might be ine of ICHelpBook.HELP_TYPE_XXX

Returns:
one of ICHelpBook.HELP_TYPE_XXX representing the type of Provided help