THelpDatabases class

In unit LazHelpIntf

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

Declaration

pascal

THelpDatabases = class(THelpManager)

Inheritance

THelpDatabases
THelpManager
TObject

Description

Nothing more than the line above yet.

Properties

Items public Provides indexed access to registered help database instances.

Methods

`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`Count`	public	Gets the number of registered help database instances in the Items property.
`FindDatabase`	public	Gets the help database with the specified unique identifier.
`GetDatabase`	public	Gets the help database instance with the specified ID.
`IndexOf`	public	Gets the ordinal position in Items for the help database with the specified ID.
`CreateUniqueDatabaseID`	public	Creates a unique identifier for a help database using a suggested identifier prefix.
`CreateHelpDatabase`	public	Creates and optionally registers a unique help database instance using the specified class reference.
`ShowTableOfContents`	public	Displays the Table of Contents.
`ShowError`	public	Displays an error dialog for status result codes other than shrSuccess and shrCancel.
`GetBaseURLForBasePathObject`	public	Gets a URL representing the base path object for the help databases.
`GetBaseDirectoryForBasePathObject`	public	Gets the directory for the base path object in the help databases.
`FindViewer`	public	Finds the registered help viewer for the specified MIME type.
`SubstituteMacros`	public	Used to substitute macros.
`ShowHelpForNodes`	public	Displays help for nodes matching the specified query list.
`ShowHelpForQuery`	public	Displays help for the specified THelpQuery.
`ShowHelpForContext`	public	Displays help nodes matching the specified help query context.
`ShowHelpForKeyword`	public	Displays help nodes matching the specified keyword help query.
`ShowHelpForDirective`	public
`ShowHelpForPascalContexts`	public	Displays help nodes matching the specified Pascal help query.
`ShowHelpForSourcePosition`	public	Displays help for the Pascal source contexts in the help query.
`ShowHelpForMessageLine`	public
`ShowHelpForClass`	public
`ShowHelpFile`	public	Displays the requested help file in the help viewer.
`ShowHelp`	public	Displays the help topic for the requested URL in the help viewer.
`GetNodesForKeyword`	public	Populates a list with help nodes using the specified help keyword.
`GetNodesForDirective`	public
`GetNodesForContext`	public	Populates a list with help node for the specified help context.
`GetNodesForPascalContexts`	public
`GetNodesForClass`	public
`GetNodesForMessage`	public
`ShowHelpSelector`	public
`RegisterHelpDatabaseClass`	public
`UnregisterHelpDatabaseClass`	public
`HelpDatabaseClassCount`	public
`GetHelpDatabaseClass`	public
`Load`	public	Loads configuration settings for each registered help database in the container.
`Save`	public	Saves configuration settings for each register help database in the container.

Inherited

From THelpManager (1)

DoHelpNotFound

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

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