THelpDatabases

type THelpDatabases = class(THelpManager)

public

  constructor Create;

Constructor for the class instance.

  destructor Destroy; override;

Destructor for the class instance.

  function Count;

Gets the number of registered help database instances in the Items property.

  property Items []: THelpDatabase; default; [r]

Provides indexed access to registered help database instances.

  function FindDatabase();

Gets the help database with the specified unique identifier.

  function GetDatabase();

Gets the help database instance with the specified ID.

  function IndexOf();

Gets the ordinal position in Items for the help database with the specified ID.

  function CreateUniqueDatabaseID();

Creates a unique identifier for a help database using a suggested identifier prefix.

  function CreateHelpDatabase();

Creates and optionally registers a unique help database instance using the specified class reference.

  function ShowTableOfContents(); override;

Displays the Table of Contents.

  procedure ShowError(); override;

Displays an error dialog for status result codes other than shrSuccess and shrCancel.

  function GetBaseURLForBasePathObject(); virtual;

Gets a URL representing the base path object for the help databases.

  function GetBaseDirectoryForBasePathObject(); virtual;

Gets the directory for the base path object in the help databases.

  function FindViewer(); virtual;

Finds the registered help viewer for the specified MIME type.

  function SubstituteMacros(); virtual;

Used to substitute macros.

  function ShowHelpForNodes(); virtual;

Displays help for nodes matching the specified query list.

  function ShowHelpForQuery(); override;

Displays help for the specified THelpQuery.

  function ShowHelpForContext(); override;

Displays help nodes matching the specified help query context.

  function ShowHelpForKeyword(); override;

Displays help nodes matching the specified keyword help query.

  function ShowHelpForDirective(); override;

  function ShowHelpForPascalContexts(); override;

Displays help nodes matching the specified Pascal help query.

  function ShowHelpForSourcePosition(); override;

Displays help for the Pascal source contexts in the help query.

  function ShowHelpForMessageLine(); override;

  function ShowHelpForClass(); override;

  function ShowHelpFile(); override;

Displays the requested help file in the help viewer.

  function ShowHelp(); override;

Displays the help topic for the requested URL in the help viewer.

  function GetNodesForKeyword(); virtual;

Populates a list with help nodes using the specified help keyword.

  function GetNodesForDirective(); virtual;

  function GetNodesForContext(); virtual;

Populates a list with help node for the specified help context.

  function GetNodesForPascalContexts(); virtual;

  function GetNodesForClass(); virtual;

  function GetNodesForMessage(); virtual;

  function ShowHelpSelector(); virtual;

  procedure RegisterHelpDatabaseClass();

  procedure UnregisterHelpDatabaseClass();

  function HelpDatabaseClassCount;

  function GetHelpDatabaseClass();

  procedure Load(); virtual;

Loads configuration settings for each registered help database in the container.

  procedure Save(); virtual;

Saves configuration settings for each register help database in the container.

end;

THelpDatabases

Implements support for accessing and maintaining registered help database classes in the help system.

THelpManager

Defines a help manager used to display a help query or a table of contents.

TObject