THHWinType
Used to retrieve information about, create or modify a window type.
Used by:
HH_GET_WIN_TYPE
HH_SET_WIN_TYPE
Declaration:
PHHWinType = ^THHWinType;
tagHH_WINTYPE = packed record
cbStruct: Integer;
fUniCodeStrings: BOOL;
pszType: LPCTSTR;
fsValidMembers: DWORD;
fsWinProperties: DWORD;
pszCaption: LPCTSTR;
dwStyles: DWORD;
dwExStyles: DWORD;
rcWindowPos: TRect;
nShowState: Integer;
hwndHelp: HWND;
hwndCaller: HWND;
paInfoTypes: PHHInfoType;
{ The following members are only valid if HHWIN_PROP_TRI_PANE is set }
hwndToolBar: HWND;
hwndNavigation: HWND;
hwndHTML: HWND;
iNavWidth: Integer;
rcHTML: TRect;
pszToc: LPCTSTR;
pszIndex: LPCTSTR;
pszFile: LPCTSTR;
pszHome: LPCTSTR;
fsToolBarFlags: DWORD;
fNotExpanded: BOOL;
curNavType: Integer;
tabpos: Integer;
idNotify: Integer;
tabOrder: array[0..HH_MAX_TABS] of Byte;
cHistory: Integer;
pszJump1: LPCTSTR;
pszJump2: LPCTSTR;
pszUrlJump1: LPCTSTR;
pszUrlJump2: LPCTSTR;
rcMinSize: TRect;
cbInfoTypes: Integer;
{$IFDEF HTMLHELP12}
pszCustomTabs: LPCTSTR;
{$ENDIF}
end;
HH_WINTYPE = tagHH_WINTYPE;
PHH_WINTYPE = ^tagHH_WINTYPE;
THHWinType = tagHH_WINTYPE;
Description:
The THHWinType record is used to specify a window type or to retrieve information
about a window type. You use it in combination with the HH_SET_WIN_TYPE and
HH_GET_WIN_TYPE commands to set or retrieve every little detail about a window type. Most
of what you can do with this record the HTML Help author can also do from within HTML Help
Workshop which is a lot easier. However, HTML Help Workshop does not provide all
capabilities, for instance to create a window to be used for embedded HTML Help you have
no choice but to create a window programmatically.
Member | Dir | Description |
---|---|---|
cbStruct | IN | Specifies the size of this record and must be filled in before passing the record to the HtmlHelp function using the SizeOf function |
fUniCodeStrings | IN | Specifies whether the string members in this record are unicode (True) or ansi (False. Note that this is independent of whether you call HtmlHelpA or HtmlHelpW. Also the strings returned in this record are always ansi. |
pszType | IN/OUT | Null-terminated string that specifies the name for the window type. |
fsValidMembers | IN | Bit-flags which specifies which other members of this record contain valid values. See fsValidMembers flags for the possible values. |
fsWinProperties | IN/OUT | Bit-flags which specifies some properties of the window type such as whether it has a toolbar or a search tab. See fsWinProperties flags. |
pszCaption | IN/OUT | Specifies the caption that is displayed in the title bar of the window (ignored if HHWIN_PROP_CHANGE_TITLE is set). |
dwStyles | IN/OUT | Set of bit-flags specifying the style of the window. These are the WS_XXX flags as documented in the Platform SDK. Depending on the fsValidMembers and fsWinProperties these flags are either ignored, used exclusively or combined with the flags in dwExStyles. |
dwExStyles | IN/OUT | Set of bit-flags specifying the extended style of the window. These are the WS_EZ_XXX flags as documented in the Platform SDK. Depending on the fsValidMembers and fsWinProperties these flags are either ignored, used exclusively or combined with the flags in dwStyles. |
rcWindowPos | IN/OUT | Specifies the size and position of the window. Set individual members to -1 to retain default values. |
nShowState | IN | Specifies the initial display state of the window. Possible values are the same as those used with the ShowWindow API function, the SW_XXX ones. They are documented in the Platform SDK. |
hwndHelp | OUT | The handle of the window after it has been created. This is the same value as returned from the HtmlHelp function for those commands that display a topic. |
hwndCaller | OUT | Handle of the caller/owner. This is the handle of a window that will receive notification messsages, if they are enabled, and is also the same value as the hwndCaller parameter passed to HtmlHelp(). |
paInfoTypes | IN | Pointer to an array of Information Types. |
The following members are only valid if the HHWIN_PROP_TRI_PANE flag is set in thefwWinProperties member.
Member | Dir | Description |
---|---|---|
hnwdToolbar | OUT | Specifies the handle of the toolbar |
hwndNavigation | OUT | Specifies the handle of the navigation pane (which contains the TOC, Index etc) |
hwndHTML | 1OUT | Specifies the handle of the topic pane (which contains the window that displays the topics by hosting shdocvw.dll) |
iNavWidth | IN/OUT | Specifies the width of the navigation pane when the tri-pane window is in expanded state (the navigation pane is showing) |
rcHTML | OUT | Specifies the coordinates (size and position) of the topic pane referenced by hwndHTML |
pszToc | IN | Specifies the contents file (.hhc) to display in the Navigation pane. |
pszIndex | IN | Specifies the index file (.hhk) to display in the navigation pane. |
pszFile | IN | Specifies the default HTML file or URL to display in the topic pane. |
pszHome | IN/OUT | Specifies the HTML file or URL to display in the topic pane when the user presses the Home button |
fsToolbarFlags | IN | Bit-flags specifying which buttons to show in the toolbar. See fsToolbarFlags for the possible values. |
fNotExpanded | IN/OUT | Specifies whether the navigation pane is displayed (True is expanded, False is not) |
curNavType | IN/OUT | Specifies the default tab to display in the Navigation pane. |
tabpos | IN/OUT | Specifies where the tabs in the Navigation pane should be displayed. See TabPos for the possible values. |
idNotify | IN | Specifies the numeric identifier for use with notification messages. This value is passed as the wParam parameter for the WM_NOTIFY message. See Notification Messages for more info. Note that HHWIN_PARAM_PROPERTIES must be specified in the fsValidMembers field and that HHWIN_PROP_TRACKING must be included in the fsWinProperties field. |
tabOrder | IN/OUT | Specifies the taborder of the tabs in the navigation pane. |
cHistory | IN/OUT | Number of history items to remember. The default is 30. |
pszJump1 | IN | Specifies the text to display in the Jump1 button. To enable this button you mist include HHWIN_PARAM_TB_FLAGS in the fsValidMembers field and include the HHWIN_BUTTON_JUMP1 flag in fsToolbarFlags field. |
pszJump2 | IN | Specifies the text to display in the Jump2 button. To enable this button you mist include HHWIN_PARAM_TB_FLAGS in the fsValidMembers field and include the HHWIN_BUTTON_JUMP2 flag in fsToolbarFlags field |
pszUrlJump1 | IN | Specifies the URL to jump to when the Jump1 button is clicked. |
pszUrlJump2 | IN | Specifies the URL to jump to when the Jump2 button is clicked. |
rcMinSize | IN | Minimum size for window - Ignored in version 1 |
cbInfoTypes | IN | Size of paInfoTypes |
pszCustomTabs | IN | Multiple zero-terminated strings |