Partager via


HH_WINTYPE structure (htmlhelp.h)

Utilisez cette structure pour spécifier ou modifier les attributs d’un type de fenêtre.

Syntaxe

typedef struct tagHH_WINTYPE {
  int         cbStruct;
  BOOL        fUniCodeStrings;
  LPCTSTR     pszType;
  DWORD       fsValidMembers;
  DWORD       fsWinProperties;
  LPCTSTR     pszCaption;
  DWORD       dwStyles;
  DWORD       dwExStyles;
  RECT        rcWindowPos;
  int         nShowState;
  HWND        hwndHelp;
  HWND        hwndCaller;
  HH_INFOTYPE *paInfoTypes;
  HWND        hwndToolBar;
  HWND        hwndNavigation;
  HWND        hwndHTML;
  int         iNavWidth;
  RECT        rcHTML;
  LPCTSTR     pszToc;
  LPCTSTR     pszIndex;
  LPCTSTR     pszFile;
  LPCTSTR     pszHome;
  DWORD       fsToolBarFlags;
  BOOL        fNotExpanded;
  int         curNavType;
  int         tabpos;
  int         idNotify;
  BYTE        tabOrder[HH_MAX_TABS + 1];
  int         cHistory;
  LPCTSTR     pszJump1;
  LPCTSTR     pszJump2;
  LPCTSTR     pszUrlJump1;
  LPCTSTR     pszUrlJump2;
  RECT        rcMinSize;
  int         cbInfoTypes;
  LPCTSTR     pszCustomTabs;
} HH_WINTYPE, *PHH_WINTYPE;

Membres

cbStruct

Spécifie la taille de la structure. Cette valeur doit toujours être renseignée avant de passer la structure à HtmlHelp().

fUniCodeStrings

Spécifie si les chaînes utilisées dans cette structure sont UNICODE.

pszType

Chaîne terminée par null qui spécifie le nom du type de fenêtre.

fsValidMembers

Spécifie les membres de la structure qui sont valides.

fsWinProperties

Spécifie les propriétés de la fenêtre, par exemple s’il s’agit de la visionneuse d’aide HTML standard ou si elle inclut un onglet Recherche.

pszCaption

Chaîne terminée par un caractère Null qui spécifie le légende à afficher dans la barre de titre de la fenêtre.

dwStyles

Spécifie les styles utilisés pour créer la fenêtre. Ces styles peuvent être ignorés, combinés avec des styles étendus ou utilisés exclusivement en fonction de la valeur des paramètres fsValidMembers et fsWinProperties .

dwExStyles

Spécifie les styles étendus utilisés pour créer la fenêtre. Ces styles peuvent être ignorés, combinés avec les styles par défaut ou utilisés exclusivement en fonction de la valeur des paramètres fsValidMembers et fsWinProperties .

rcWindowPos

Spécifie les coordonnées de la fenêtre en pixels. Les valeurs sont lues dans l’ordre suivant :

rcWindowPos = {left, top, right, bottom} ;

nShowState

Spécifie l’état d’affichage initial de la fenêtre. Les valeurs valides sont les mêmes que celles de la fonction ShowWindow de l’API Win32.

hwndHelp

Spécifie le handle de la fenêtre si la fenêtre a été créée.

hwndCaller

Spécifie la fenêtre qui recevra les messages de notification d’aide HTML. Les messages de notification sont envoyés via des messages Windows WM_NOTIFY .

paInfoTypes

Pointeur vers un tableau de types d’informations.

hwndToolBar

Spécifie le handle de la barre d’outils.

hwndNavigation

Spécifie le handle du volet de navigation.

hwndHTML

Spécifie le handle du volet Rubrique, qui héberge Shdocvw.dll.

iNavWidth

Spécifie la largeur du volet de navigation lorsque la visionneuse d’aide est développée.

rcHTML

Spécifie les coordonnées du volet Rubrique.

pszToc

Spécifie le fichier de contenu (.hhc) à afficher dans le volet de navigation.

pszIndex

Spécifie le fichier d’index (.hhk) à afficher dans le volet de navigation.

pszFile

Spécifie le fichier HTML par défaut à afficher dans le volet Rubrique.

pszHome

Spécifie le fichier ou l’URL à afficher dans le volet Rubrique lorsque l’utilisateur clique sur le bouton Accueil.

Spécifie les boutons à inclure dans la barre d’outils.

fsToolBarFlags

Spécifie les boutons à inclure dans le volet Barre d’outils d’une visionneuse d’aide à trois volets.

fNotExpanded

Spécifie que la visionneuse d’aide s’ouvre avec le volet de navigation fermé.

curNavType

Spécifie l’onglet par défaut à afficher dans le volet de navigation.

tabpos

Spécifie où placer les onglets dans le volet de navigation de la visionneuse d’aide HTML.

idNotify

Spécifie un ID différent de zéro pour activer les messages de notification d’aide HTML. Cet ID est passé en tant que valeur wParam des messages windows WM_NOTIFY .

tabOrder[HH_MAX_TABS + 1]

Ordre de tabulation : Contenu, Index, Recherche, Historique, Favoris, Reserved 1-5, Onglets personnalisés

cHistory

Nombre d’éléments d’historique à conserver. (Par défaut : 30)

pszJump1

Spécifie le texte à afficher sous le bouton Jump1.

pszJump2

Spécifie le texte à afficher sous le bouton Jump2.

pszUrlJump1

Spécifie l’URL à laquelle accéder lorsque l’utilisateur clique sur le bouton Jump1.

pszUrlJump2

Spécifie l’URL à laquelle accéder lorsque l’utilisateur clique sur le bouton Jump2.

rcMinSize

Taille minimale pour la fenêtre (ignorée dans la version 1).

cbInfoTypes

Taille de paInfoTypes

pszCustomTabs

Série de chaînes terminées à zéro à utiliser comme étiquettes d’onglets.

Remarques

Les types de fenêtres peuvent être définis par un auteur dans un fichier de projet (.hhp), ou ils peuvent être définis par programmation à l’aide de l’API d’aide HTML.

Lorsqu’une structure HH_WINTYPE est passée à HtmlHelp() à l’aide de la commande HH_SET_WIN_TYPE, l’API d’aide HTML effectue une copie privée du contenu de la structure. Le développeur d’aide est donc chargé de libérer la mémoire utilisée par la structure HH_WINTYPE ou les tableaux de caractères qu’elle contient. Le développeur d’aide peut libérer de la mémoire après avoir appelé HH_SET_WIN_TYPE.

Utilisé par

Configuration requise

Condition requise Valeur
En-tête htmlhelp.h

Voir aussi

À propos des structures