Unit HtmlHelp

***************************************************************************** * HtmlHelp * * HtmlHelp constants, translated from htmlhelp.h * * Translated by: Ron Loewy, HyperAct, Inc. * * Last Update: Oct. 21, 1997 *

Classes

Functions

HH - ***************************************************************************** * HtmlHelp *
HtmlHelpInstalled - HtmlHelp } (****************************************************************************** * boolean *

Types

HHACTTYpes
HHNNAVCOMPLETE
HHNTRACK
HHN_Notify
HHWin_NavTabs
HHWin_NavTypes
HH_AKLINK
HH_FTS_Query
HH_InfoType
HH_Popup
HH_Tabs
HH_WinType
PHHNNAVCOMPLETE
PHHNTRACK
PHH_InfoType
PHH_WinType
THtmlHelpA
THtmlHelpW

Constants

HHN_First
HHN_Last
HHN_NavComplete
HHN_Track
HHWIN_BUTTON_BACK
HHWIN_BUTTON_BROWSE_BCK
HHWIN_BUTTON_BROWSE_FWD
HHWIN_BUTTON_CONTENTS
HHWIN_BUTTON_EXPAND
HHWIN_BUTTON_FAVORITES
HHWIN_BUTTON_FORWARD
HHWIN_BUTTON_HISTORY
HHWIN_BUTTON_HOME
HHWIN_BUTTON_INDEX
HHWIN_BUTTON_JUMP1
HHWIN_BUTTON_JUMP2
HHWIN_BUTTON_NOTES
HHWIN_BUTTON_OPTIONS
HHWIN_BUTTON_PRINT
HHWIN_BUTTON_REFRESH
HHWIN_BUTTON_SEARCH
HHWIN_BUTTON_STOP
HHWIN_BUTTON_SYNC
HHWIN_BUTTON_TOC_NEXT
HHWIN_BUTTON_TOC_PREV
HHWIN_BUTTON_ZOOM
HHWIN_DEF_Buttons
HHWIN_PARAM_CUR_TAB
HHWIN_PARAM_EXPANSION
HHWIN_PARAM_EXSTYLES
HHWIN_PARAM_HISTORY_COUNT
HHWIN_PARAM_INFOTYPES
HHWIN_PARAM_NAV_WIDTH
HHWIN_PARAM_PROPERTIES
HHWIN_PARAM_RECT
HHWIN_PARAM_SHOWSTATE
HHWIN_PARAM_STYLES
HHWIN_PARAM_TABORDER
HHWIN_PARAM_TABPOS
HHWIN_PARAM_TB_FLAGS
HHWIN_PROP_AUTO_SYNC
HHWIN_PROP_CHANGE_TITLE
HHWIN_PROP_NAV_ONLY_WIN
HHWIN_PROP_NODEF_EXSTYLES
HHWIN_PROP_NODEF_STYLES
HHWIN_PROP_NOTB_TEXT
HHWIN_PROP_NOTITLEBAR
HHWIN_PROP_NO_TOOLBAR
HHWIN_PROP_ONTOP
HHWIN_PROP_POST_QUIT
HHWIN_PROP_TAB_FAVORITES
HHWIN_PROP_TAB_HISTORY
HHWIN_PROP_TAB_SEARCH
HHWIN_PROP_TRACKING
HHWIN_PROP_TRI_PANE
HH_ADD_BUTTON
HH_ADD_NAV_UI
HH_DISPLAY_INDEX
HH_DISPLAY_SEARCH
HH_DISPLAY_TEXT_POPUP
HH_DISPLAY_TOC
HH_DISPLAY_TOPIC
HH_FTS_DEFAULT_PROXIMITY
HH_GETBROWSER_APP
HH_GET_INFO_TYPES
HH_GET_WIN_HANDLE
HH_GET_WIN_TYPE
HH_HELP_CONTEXT
HH_KEYWORD_LOOKUP
HH_Max_Tabs
HH_SET_INFO_TYPES
HH_SET_WIN_TYPE
HH_SYNC
IDTB_BACK
IDTB_BROWSE_BACK
IDTB_BROWSE_FWD
IDTB_CONTENTS
IDTB_CONTRACT
IDTB_CUSTOMIZE
IDTB_EXPAND
IDTB_FAVORITES
IDTB_FORWARD
IDTB_HISTORY
IDTB_HOME
IDTB_INDEX
IDTB_JUMP1
IDTB_JUMP2
IDTB_NOTES
IDTB_OPTIONS
IDTB_PRINT
IDTB_REFRESH
IDTB_SEARCH
IDTB_STOP
IDTB_SYNC
IDTB_TOC_NEXT
IDTB_TOC_PREV
IDTB_ZOOM

Variables


Functions


function HH(hwndCaller : THandle; pszFile : PChar; uCommand : cardinal; dwData : longint) : THandle;

***************************************************************************** * HtmlHelp *

function HtmlHelpInstalled : boolean;

HtmlHelp } (****************************************************************************** * boolean *

Types


HHACTTYpes = (
	HHACT_TAB_CONTENTS,
	HHACT_TAB_INDEX,
	HHACT_TAB_SEARCH,
	HHACT_TAB_HISTORY,
	HHACT_TAB_FAVORITES,

	HHACT_EXPAND,
	HHACT_CONTRACT,
	HHACT_BACK,
	HHACT_FORWARD,
	HHACT_STOP,
	HHACT_REFRESH,
	HHACT_HOME,
	HHACT_SYNC,
	HHACT_OPTIONS,
	HHACT_PRINT,
	HHACT_HIGHLIGHT,
	HHACT_CUSTOMIZE,
	HHACT_JUMP1,
	HHACT_JUMP2,
	HHACT_ZOOM,
	HHACT_TOC_NEXT,
	HHACT_TOC_PREV,
	HHACT_NOTES,

	HHACT_LAST_ENUM
   );

HHNNAVCOMPLETE = record
hdr : TNMHDR;
pszUrl : PChar;
end;

HHNTRACK = record
hdr : TNMHDR;
pszCurUrl : PWideChar;
idAction : integer;
phhWinType : ^ HH_WinType;
end;

HHN_Notify = record
hdr : pointer;
pszUrl : PWideChar;
end;

HHWin_NavTabs = (HHWIN_NavTab_Top,
                    HHWIN_NavTab_Left,
                    HHWIN_NavTab_Bottom);

HHWin_NavTypes = (HHWIN_NAVTYPE_TOC,
                     HHWIN_NAVTYPE_INDEX,
                     HHWIN_NAVTYPE_SEARCH,
                     HHWIN_NAVTYPE_HISTORY,
                     HHWIN_NAVTYPE_FAVOURITES);
HH_AKLINK
HH_AKLINK = record
cbStruct : integer;
fReserved : bool;
pszKeywords : PChar;
pszUrl : PChar;
pszMsgText : PChar;
pszMsgTitle : PChar;
pszWindow : PChar;
fIndexOnFail : bool;
end;
HH_Popup
HH_FTS_Query = record
cbStruct : integer;
fUniCodeStrings : bool;
pszSearchQuery : PChar;
iProximity : longint;
fStemmedSearch : bool;
fTitleOnly : bool;
fExecute : bool;
pszWindow : PChar;
end;

HH_InfoType = longint

HH_Popup = record
cbStruct : integer;
hinst : THandle;
idString : cardinal;
pszText : PChar;
pt : TPoint;
clrForeground : TColor;
clrBackground : TColor;
rcMargins : TRect;
pszFont : PChar;
end;
PWideChar
HH_Tabs = (
	HH_TAB_CONTENTS,
	HH_TAB_INDEX,
	HH_TAB_SEARCH,
	HH_TAB_HISTORY,
	HH_TAB_FAVORITES
   );
max # of tabs
HH_WinType = record
cbStruct : integer;
fUniCodeStrings : bool;
pszType : PChar;
fsValidMembers : longint;
fsWinProperties : longint;
pszCaption : PChar;
dwStyles : longint;
dwExStyles : longint;
rcWindowPos : TRect;
nShowState : integer;
hwndHelp : THandle;
hwndCaller : THandle;
paInfoTypes : ^ HH_InfoType;
hwndToolbar : THandle;
hwndNavigation : THandle;
hwndHTML : THandle;
iNavWidth : integer;
rcHTML : TRect;
pszToc : PChar;
pszIndex : PChar;
pszFile : PChar;
pszHome : PChar;
fsToolbarFlags : longint;
fNotExpanded : bool;
curNavType : integer;
tabPos : integer;
idNotify : integer;
TabOrder : array[0 .. HH_Max_Tabs + 1] of byte;
cHistory : integer;
pszJump1 : PChar;
pszJump2 : PChar;
pszUrlJump1 : PChar;
pszUrlJump2 : PChar;
rcMinSize : TRect;
end;
HH_FTS_Query
PHHNNAVCOMPLETE = ^ HHNNAVCOMPLETE

PHHNTRACK = ^ HHNTRACK
HHNTRACK
PHH_InfoType = ^ HH_InfoType

PHH_WinType = ^ HH_WinType
HH_WinType
THtmlHelpA = function(hwndCaller : THandle; pszFile : PChar; uCommand : cardinal; dwData : longint) : THandle

THtmlHelpW = function(hwndCaller : THandle; pszFile : PChar; uCommand : cardinal; dwData : longint) : THandle

Constants

HHN_First = cardinal(-860)

Notification Codes

HHN_Last = cardinal(-879)

HHN_NavComplete = HHN_First - 0

HHN_Track = HHN_First - 1

HHWIN_BUTTON_BACK = 4

Expand/contract button

HHWIN_BUTTON_BROWSE_BCK = 256

not implemented

HHWIN_BUTTON_BROWSE_FWD = 128

Home button

HHWIN_BUTTON_CONTENTS = 1024

not implemented

HHWIN_BUTTON_EXPAND = 2

valid curNavType (* button constants

HHWIN_BUTTON_FAVORITES = 131072

not implemented

HHWIN_BUTTON_FORWARD = 8

Back button

HHWIN_BUTTON_HISTORY = 65536

not implemented

HHWIN_BUTTON_HOME = 64

Refresh button

HHWIN_BUTTON_INDEX = 16384

Print button

HHWIN_BUTTON_JUMP1 = 262144

not implemented

HHWIN_BUTTON_JUMP2 = 524288

Jump 1 button

HHWIN_BUTTON_NOTES = 512

not implemented

HHWIN_BUTTON_OPTIONS = 4096

Sync button

HHWIN_BUTTON_PRINT = 8192

Options button

HHWIN_BUTTON_REFRESH = 32

Stop button

HHWIN_BUTTON_SEARCH = 32768

not implemented

HHWIN_BUTTON_STOP = 16

Forward button

HHWIN_BUTTON_SYNC = 2048

not implemented

HHWIN_BUTTON_TOC_NEXT = HHWIN_Button_Zoom * 2

HHWIN_BUTTON_TOC_PREV = HHWIN_Button_Toc_Next * 2

HHWIN_BUTTON_ZOOM = HHWIN_Button_Jump2 * 2

Jump 2 button

HHWIN_DEF_Buttons = HHWIN_Button_Expand or HHWIN_Button_Back or HHWIN_Button_Options or HHWIN_Button_Print

HHWIN_PARAM_CUR_TAB = 8192

valid cHistory

HHWIN_PARAM_EXPANSION = 512

valid fsToolBarFlags

HHWIN_PARAM_EXSTYLES = 8

valid dwStyles

HHWIN_PARAM_HISTORY_COUNT = 4096

valid taborder

HHWIN_PARAM_INFOTYPES = 128

valid nShowState

HHWIN_PARAM_NAV_WIDTH = 32

valid rcWindowPos

HHWIN_PARAM_PROPERTIES = 2

Don't display a toolbar (* window parameters

HHWIN_PARAM_RECT = 16

valid dwExStyles

HHWIN_PARAM_SHOWSTATE = 64

valid iNavWidth

HHWIN_PARAM_STYLES = 4

valid fsWinProperties

HHWIN_PARAM_TABORDER = 2048

valid tabpos

HHWIN_PARAM_TABPOS = 1024

valid fNotExpanded

HHWIN_PARAM_TB_FLAGS = 256

valid ainfoTypes

HHWIN_PROP_AUTO_SYNC = 256

post WM_QUIT message when window closes

HHWIN_PROP_CHANGE_TITLE = 8192

include favorites tab in navigation pane

HHWIN_PROP_NAV_ONLY_WIN = 16384

Put current HTML title in title bar

HHWIN_PROP_NODEF_EXSTYLES = 16

no default window styles (only HH_WINTYPE.dwStyles

HHWIN_PROP_NODEF_STYLES = 8

no title bar

HHWIN_PROP_NOTB_TEXT = 64

use a tri-pane window

HHWIN_PROP_NOTITLEBAR = 4

Top-most window (not currently implemented

HHWIN_PROP_NO_TOOLBAR = 32768

Only display the navigation window

HHWIN_PROP_ONTOP = 2

display mapped numeric value in dwData (* window properties

HHWIN_PROP_POST_QUIT = 128

no text on toolbar buttons

HHWIN_PROP_TAB_FAVORITES = 4096

include history tab in navigation pane

HHWIN_PROP_TAB_HISTORY = 2048

include search tab in navigation pane

HHWIN_PROP_TAB_SEARCH = 1024

send tracking notification messages

HHWIN_PROP_TRACKING = 512

automatically ssync contents and index

HHWIN_PROP_TRI_PANE = 32

no default extended window styles (only HH_WINTYPE.dwExStyles

HH_ADD_BUTTON = $000B

not currently implemented

HH_ADD_NAV_UI = $000A

HH_DISPLAY_INDEX = $0002

not currently implemented

HH_DISPLAY_SEARCH = $0003

not currently implemented

HH_DISPLAY_TEXT_POPUP = $000E

HH_DISPLAY_TOC = $0001

HH_DISPLAY_TOPIC = $0000

Commands to pass to HtmlHelp

HH_FTS_DEFAULT_PROXIMITY = (-1)

HH_DISPLAY_SEARCH Command Related Structures and Constants

HH_GETBROWSER_APP = $000C

not currently implemented

HH_GET_INFO_TYPES = $0007

HH_GET_WIN_HANDLE = $0006

HH_GET_WIN_TYPE = $0005

HH_HELP_CONTEXT = $000F

display string resource id or text in a popup window

HH_KEYWORD_LOOKUP = $000D

not currently implemented

HH_Max_Tabs = 19

HH_SET_INFO_TYPES = $0008

not currently implemented

HH_SET_WIN_TYPE = $0004

not currently implemented

HH_SYNC = $0009

not currently implemented

IDTB_BACK = 204

IDTB_BROWSE_BACK = 212

IDTB_BROWSE_FWD = 211

not implemented;

IDTB_CONTENTS = 213

IDTB_CONTRACT = 201

IDTB_CUSTOMIZE = 221

IDTB_EXPAND = 200

Button ID's

IDTB_FAVORITES = 217

not implemented;

IDTB_FORWARD = 209

IDTB_HISTORY = 216

not implemented;

IDTB_HOME = 205

IDTB_INDEX = 214

not implemented;

IDTB_JUMP1 = 218

not implemented;

IDTB_JUMP2 = 219

IDTB_NOTES = 210

IDTB_OPTIONS = 208

IDTB_PRINT = 207

IDTB_REFRESH = 203

IDTB_SEARCH = 215

not implemented;

IDTB_STOP = 202

IDTB_SYNC = 206

IDTB_TOC_NEXT = 223

IDTB_TOC_PREV = 224

IDTB_ZOOM = 222


Variables