Klasse THelpDatabase

BeschreibungHierarchieFelderMethodenEigenschaften

Unit

Deklaration

type THelpDatabase = class(TComponent)

Beschreibung

Hierarchie

Übersicht

Methoden

Public constructor Create(TheOwner: TComponent); override;
Public destructor Destroy; override;
Public procedure Reference;
Public procedure RegisterSelf;
Public procedure Release;
Public procedure UnregisterSelf;
Public function Registered: boolean;
Public function CanShowTableOfContents: boolean; virtual;
Public procedure ShowTableOfContents; virtual;
Public procedure ShowError(ShowResult: TShowHelpResult; const ErrMsg: string); virtual;
Public function ShowHelp(Query: THelpQuery; BaseNode, NewNode: THelpNode; QueryItem: THelpQueryItem; var ErrMsg: string): TShowHelpResult; virtual;
Public function ShowHelpFile(Query: THelpQuery; BaseNode: THelpNode; const Title, Filename: string; var ErrMsg: string): TShowHelpResult; virtual;
Public function SupportsMimeType(const AMimeType: string): boolean; virtual;
Public function GetNodesForKeyword(const HelpKeyword: string; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
Public function GetNodesForContext(HelpContext: THelpContext; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
Public function GetNodesForPascalContexts(ListOfPascalHelpContextList: TList; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
Public function GetNodesForClass(AClass: TClass; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
Public function GetNodesForMessage(const AMessage: string; MessageParts: TStrings; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
Public function FindViewer(const MimeType: string; var ErrMsg: string; out Viewer: THelpViewer): TShowHelpResult; virtual;
Public procedure RegisterItem(NewItem: THelpDBItem);
Public procedure RegisterItemWithNode(Node: THelpNode);
Public procedure RegisterFileItemWithNode(const Filename: string; Node: THelpNode);
Public procedure UnregisterItem(AnItem: THelpDBItem);
Public function RegisteredItemCount: integer;
Public function GetRegisteredItem(Index: integer): THelpDBItem;
Public procedure Load(Storage: TConfigStorage); virtual;
Public procedure Save(Storage: TConfigStorage); virtual;
Public function GetLocalizedName: string; virtual;

Eigenschaften

Public property Databases: THelpDatabases read FDatabases write SetDatabases;
Public property ID: THelpDatabaseID read FID write SetID;
Public property SupportedMimeTypes: TStrings read FSupportedMimeTypes;
Public property BasePathObject: TObject read FBasePathObject write FBasePathObject;
Public property TOCNode: THelpNode read FTOCNode write FTOCNode;
Public property AutoRegister: boolean read FAutoRegister write SetAutoRegister;

Beschreibung

Methoden

Public constructor Create(TheOwner: TComponent); override;
 
Public destructor Destroy; override;
 
Public procedure Reference;
 
Public procedure RegisterSelf;
 
Public procedure Release;
 
Public procedure UnregisterSelf;
 
Public function Registered: boolean;
 
Public function CanShowTableOfContents: boolean; virtual;
 
Public procedure ShowTableOfContents; virtual;
 
Public procedure ShowError(ShowResult: TShowHelpResult; const ErrMsg: string); virtual;
 
Public function ShowHelp(Query: THelpQuery; BaseNode, NewNode: THelpNode; QueryItem: THelpQueryItem; var ErrMsg: string): TShowHelpResult; virtual;
 
Public function ShowHelpFile(Query: THelpQuery; BaseNode: THelpNode; const Title, Filename: string; var ErrMsg: string): TShowHelpResult; virtual;
 
Public function SupportsMimeType(const AMimeType: string): boolean; virtual;
 
Public function GetNodesForKeyword(const HelpKeyword: string; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
 
Public function GetNodesForContext(HelpContext: THelpContext; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
 
Public function GetNodesForPascalContexts(ListOfPascalHelpContextList: TList; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
 
Public function GetNodesForClass(AClass: TClass; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
 
Public function GetNodesForMessage(const AMessage: string; MessageParts: TStrings; var ListOfNodes: THelpNodeQueryList; var ErrMsg: string): TShowHelpResult; virtual;
 
Public function FindViewer(const MimeType: string; var ErrMsg: string; out Viewer: THelpViewer): TShowHelpResult; virtual;
 
Public procedure RegisterItem(NewItem: THelpDBItem);
 
Public procedure RegisterItemWithNode(Node: THelpNode);
 
Public procedure RegisterFileItemWithNode(const Filename: string; Node: THelpNode);
 
Public procedure UnregisterItem(AnItem: THelpDBItem);
 
Public function RegisteredItemCount: integer;
 
Public function GetRegisteredItem(Index: integer): THelpDBItem;
 
Public procedure Load(Storage: TConfigStorage); virtual;
 
Public procedure Save(Storage: TConfigStorage); virtual;
 
Public function GetLocalizedName: string; virtual;
 

Eigenschaften

Public property Databases: THelpDatabases read FDatabases write SetDatabases;
 
Public property ID: THelpDatabaseID read FID write SetID;
 
Public property SupportedMimeTypes: TStrings read FSupportedMimeTypes;
 
Public property BasePathObject: TObject read FBasePathObject write FBasePathObject;
 
Public property TOCNode: THelpNode read FTOCNode write FTOCNode;
 
Public property AutoRegister: boolean read FAutoRegister write SetAutoRegister;
 

Erstellt mit PasDoc 0.10.0 am 2007-03-27 23:03:00