HelpIntfs unit

Interfaces to define the abstract HelpSystem.

helpintfs.pas contains interfaces to define the abstract HelpSystem.

You can create your own HelpSystem based on these interfaces, or use the LCL help system in lazhelpintf.pas. THTMLHelpDatabase and THTMLBrowserHelpViewer in lazhelphtml.pas use the LCL help system. To create your own help system, implement a descendant of THelpManager.

helpintfs.pas is part of the Lazarus Component Library ( LCL).

Author: Mattias Gaertner

Classes and records

`EHelpSystemException`	class	Exception raised for Help system errors.
`THelpManager`	class	Defines a help manager used to display a help query or a table of contents.
`THelpQuery`	class
`THelpQueryClass`	class
`THelpQueryContext`	class
`THelpQueryDirective`	class
`THelpQueryKeyword`	class
`THelpQueryMessage`	class
`THelpQueryPascalContexts`	class
`THelpQuerySourcePosition`	class
`THelpQueryTOC`	class

Procedures and functions

`dbgs`	function
`ShowHelp`	function	Display a Help file with the give URL and MIME type.
`ShowHelpFile`	function	Displays a Help file with the given file name and MIME type.
`ShowHelpFileOrError`	function
`ShowHelpForContext`	function
`ShowHelpForDirective`	function
`ShowHelpForKeyword`	function
`ShowHelpForMessageLine`	function
`ShowHelpForPascalContexts`	function
`ShowHelpOrError`	function
`ShowHelpOrErrorForContext`	function
`ShowHelpOrErrorForKeyword`	function
`ShowHelpOrErrorForMessageLine`	function
`ShowHelpOrErrorForSourcePosition`	function
`ShowTableOfContents`	function	Display the Help table of contents.

Types

`THelpDatabaseID`	type	Identifier used to represent a Help database.
`TShowHelpResult`	enumeration	Represents result codes returned by THelpManager.
`TShowHelpResults`	set	Set type used to store values from the TShowHelpResult enumeration.

Variables

HelpManager variable

Topics

HelpDisplay-HowItWorks topic Displaying Help (How It Works).

Uses

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.