paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-11-13 17:49:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

chmhelp: docs

Browse Source 
git-svn-id: trunk@37971 -
This commit is contained in:
mattias 2012-07-19 08:14:41 +00:00
parent 4d58e355b5
commit 7058153b7c
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
components/chmhelp/packages/help/lhelpcontrol.pas
View File

@ -1,5 +1,14 @@
unit LHelpControl; unit LHelpControl;
{
Starts, stops and controls external help viewer via IPC.
This is used to display context-sensitive help in Lazarus, and could be used in applications to do the same.
This unit serves as reference implementation and documentation of the protocol used to communicate with help viewers.
Currently, the only help viewer that supports this protocol is the lhelp CHM help viewer.
}
{$mode objfpc}{$H+} {$mode objfpc}{$H+}
{$IFDEF UNIX} {$IFDEF UNIX}
@ -48,13 +57,17 @@ type
public public
constructor Create; constructor Create;
destructor Destroy; override; destructor Destroy; override;
// Checks whether the server is running using SimpleIPC
function ServerRunning: Boolean; function ServerRunning: Boolean;
// Starts server
// Server must support a switch --ipcname that accepts the NameForServer argument to identify it for SimpleIPC
function StartHelpServer(NameForServer: String; ServerEXE: String = ''): Boolean; function StartHelpServer(NameForServer: String; ServerEXE: String = ''): Boolean;
// Shows URL in the HelpFileName file by sending a TUrlRequest
function OpenURL(HelpFileName: String; Url: String): TLHelpResponse; function OpenURL(HelpFileName: String; Url: String): TLHelpResponse;
// Shows help for Context in the HelpFileName file by sending a TContextRequest request
function OpenContext(HelpFileName: String; Context: THelpContext): TLHelpResponse; function OpenContext(HelpFileName: String; Context: THelpContext): TLHelpResponse;
// Opens HelpFileName by sending a TContextRequest
function OpenFile(HelpFileName: String): TLHelpResponse; function OpenFile(HelpFileName: String): TLHelpResponse;
property ProcessWhileWaiting: TProcedureOfObject read FProcessWhileWaiting write FProcessWhileWaiting; property ProcessWhileWaiting: TProcedureOfObject read FProcessWhileWaiting write FProcessWhileWaiting;
end; end;