Structure LVGROUP (commctrl.h)

  • Article

Utilisé pour définir et récupérer des groupes.

Syntaxe

typedef struct tagLVGROUP {
  UINT   cbSize;
  UINT   mask;
  LPWSTR pszHeader;
  int    cchHeader;
  LPWSTR pszFooter;
  int    cchFooter;
  int    iGroupId;
  UINT   stateMask;
  UINT   state;
  UINT   uAlign;
  LPWSTR pszSubtitle;
  UINT   cchSubtitle;
  LPWSTR pszTask;
  UINT   cchTask;
  LPWSTR pszDescriptionTop;
  UINT   cchDescriptionTop;
  LPWSTR pszDescriptionBottom;
  UINT   cchDescriptionBottom;
  int    iTitleImage;
  int    iExtendedImage;
  int    iFirstItem;
  UINT   cItems;
  LPWSTR pszSubsetTitle;
  UINT   cchSubsetTitle;
} LVGROUP, *PLVGROUP;

Membres

cbSize

Type : UINT

Taille de cette structure, en octets.

mask

Type : UINT

Masque qui spécifie les membres de la structure qui sont une entrée valide. Une ou plusieurs des valeurs suivantes :

Valeur Signification
LVGF_NONE
 Aucun autre élément n’est valide.
LVGF_HEADER
 Les membres pszHeader et cchHeader sont valides.
LVGF_FOOTER
 Les membres pszFooter et cchFooter sont valides.
LVGF_STATE
 les membres state et stateMask sont valides.
LVGF_ALIGN
 Le membre uAlign est valide.
LVGF_GROUPID
 Le membre iGroupId est valide.
LVGF_SUBTITLE

Version 6.00 et ultérieures. Le membre pszSubtitle est valide.
LVGF_TASK

Version 6.00 et ultérieures. Le membre pszTask est valide.
LVGF_DESCRIPTIONTOP

Version 6.00 et ultérieures. Le membre pszDescriptionTop est valide.
LVGF_DESCRIPTIONBOTTOM

Version 6.00 et ultérieures. Le membre pszDescriptionBottom est valide.
LVGF_TITLEIMAGE

Version 6.00 et ultérieures. Le membre iTitleImage est valide.
LVGF_EXTENDEDIMAGE

Version 6.00 et ultérieures. Le membre iExtendedImage est valide.
LVGF_ITEMS

Version 6.00 et ultérieures. Le membre cItems est valide.
LVGF_SUBSET

Version 6.00 et ultérieures. Le membre pszSubsetTitle est valide.
LVGF_SUBSETITEMS

Version 6.00 et ultérieures. Le membre cchSubsetTitle est valide.

pszHeader

Type : LPWSTR

Pointeur vers une chaîne terminée par null qui contient le texte d’en-tête lorsque les informations d’élément sont définies. Si les informations de groupe sont récupérées, ce membre spécifie l’adresse de la mémoire tampon qui reçoit le texte d’en-tête.

cchHeader

Type : int

Taille en TCHARs de la mémoire tampon pointée par le membre pszHeader . Si la structure ne reçoit pas d’informations sur un groupe, ce membre est ignoré.

pszFooter

Type : LPWSTR

Pointeur vers une chaîne terminée par null qui contient le texte du pied de page lorsque les informations d’élément sont définies. Si les informations de groupe sont récupérées, ce membre spécifie l’adresse de la mémoire tampon qui reçoit le texte du pied de page.

cchFooter

Type : int

Taille dans TCHARs de la mémoire tampon pointée par le membre pszFooter . Si la structure ne reçoit pas d’informations sur un groupe, ce membre est ignoré.

iGroupId

Type : int

ID du groupe.

stateMask

Type : UINT

Masque utilisé avec LVM_GETGROUPINFO et LVM_SETGROUPINFO pour spécifier les indicateurs de la valeur d’état qui sont récupérés ou définis.

state

Type : UINT

Indicateur qui peut avoir l’une des valeurs suivantes :

Valeur Signification
LVGS_NORMAL
 Les groupes sont développés, le nom du groupe s’affiche et tous les éléments du groupe sont affichés.
LVGS_COLLAPSED
 Le groupe est réduit.
LVGS_HIDDEN
 Le groupe est masqué.
LVGS_NOHEADER

Version 6.00 et ultérieures. Le groupe n’affiche pas d’en-tête.
LVGS_COLLAPSIBLE

Version 6.00 et ultérieures. Le groupe peut être réduit.
LVGS_FOCUSED

Version 6.00 et ultérieures. Le groupe a le focus clavier.
LVGS_SELECTED

Version 6.00 et ultérieures. Le groupe est sélectionné.
LVGS_SUBSETED

Version 6.00 et ultérieures. Le groupe n’affiche qu’une partie de ses éléments.
LVGS_SUBSETLINKFOCUSED

Version 6.00 et ultérieures. Le lien de sous-ensemble du groupe a le focus clavier.

uAlign

Type : UINT

Indique l’alignement du texte d’en-tête ou de pied de page du groupe. Il peut avoir une ou plusieurs des valeurs suivantes. Utilisez l’un des indicateurs d’en-tête. Les indicateurs de pied de page sont facultatifs.

Valeur Signification
LVGA_FOOTER_CENTER
 Le texte du pied de page est centré horizontalement dans la fenêtre.
LVGA_FOOTER_LEFT
 Le texte du pied de page est aligné à gauche de la fenêtre.
LVGA_FOOTER_RIGHT
 Le texte du pied de page est aligné à droite de la fenêtre.
LVGA_HEADER_CENTER
 Le texte d’en-tête est centré horizontalement dans la fenêtre.
LVGA_HEADER_LEFT
 Le texte d’en-tête est aligné à gauche de la fenêtre.
LVGA_HEADER_RIGHT
 Le texte d’en-tête est aligné à droite de la fenêtre.

pszSubtitle

Type : LPWSTR

Pointeur vers une chaîne terminée par null qui contient le texte du sous-titre lorsque les informations d’élément sont définies. Si les informations de groupe sont récupérées, ce membre spécifie l’adresse de la mémoire tampon qui reçoit le texte du sous-titre. Cet élément est dessiné sous le texte d’en-tête.

cchSubtitle

Type : UINT

Taille, en TCHARs, de la mémoire tampon pointée vers le membre pszSubtitle . Si la structure ne reçoit pas d’informations sur un groupe, ce membre est ignoré.

pszTask

Type : LPWSTR

Pointeur vers une chaîne terminée par null qui contient le texte d’un lien de tâche lorsque les informations d’élément sont définies. Si les informations de groupe sont récupérées, ce membre spécifie l’adresse de la mémoire tampon qui reçoit le texte de la tâche. Cet élément est dessiné à droite, en face du texte d’en-tête. Lorsque l’utilisateur clique dessus, le lien de tâche génère une notification LVN_LINKCLICK .

cchTask

Type : UINT

Taille dans TCHARs de la mémoire tampon pointée par le membre pszTask . Si la structure ne reçoit pas d’informations sur un groupe, ce membre est ignoré.

pszDescriptionTop

Type : LPWSTR

Pointeur vers une chaîne terminée par null qui contient le texte de description supérieur lorsque les informations d’élément sont définies. Si les informations de groupe sont récupérées, ce membre spécifie l’adresse de la mémoire tampon qui reçoit le texte de description supérieur. Cet élément est dessiné en face de l’image de titre lorsqu’il existe une image de titre, aucune image étendue et uAlign==LVGA_HEADER_CENTER.

cchDescriptionTop

Type : UINT

Taille dans TCHARs de la mémoire tampon pointée par le membre pszDescriptionTop . Si la structure ne reçoit pas d’informations sur un groupe, ce membre est ignoré.

pszDescriptionBottom

Type : LPWSTR

Pointeur vers une chaîne terminée par null qui contient le texte de description inférieur lorsque des informations d’élément sont définies. Si les informations de groupe sont récupérées, ce membre spécifie l’adresse de la mémoire tampon qui reçoit le texte de description inférieur. Cet élément est dessiné sous le texte de description supérieur lorsqu’il existe une image de titre, aucune image étendue et uAlign==LVGA_HEADER_CENTER.

cchDescriptionBottom

Type : UINT

Taille dans TCHARs de la mémoire tampon pointée par le membre pszDescriptionBottom . Si la structure ne reçoit pas d’informations sur un groupe, ce membre est ignoré.

iTitleImage

Type : int

Index de l’image de titre dans la liste d’images de contrôle.

iExtendedImage

Type : int

Index de l’image étendue dans la liste d’images de contrôle.

iFirstItem

Type : int

Lecture seule.

cItems

Type : UINT

En lecture seule en mode de données non propriétaire.

pszSubsetTitle

Type : LPWSTR

NULL si le groupe n’est pas un sous-ensemble. Pointeur vers une chaîne terminée par null qui contient le texte de titre du sous-ensemble lorsque les informations d’élément sont définies. Si les informations de groupe sont récupérées, ce membre spécifie l’adresse de la mémoire tampon qui reçoit le texte du titre du sous-ensemble.

cchSubsetTitle

Type : UINT

Taille dans TCHARs de la mémoire tampon pointée par le membre pszSubsetTitle . Si la structure ne reçoit pas d’informations sur un groupe, ce membre est ignoré.

Remarques

Toutes les chaînes retournées dans cette structure doivent être traitées en lecture seule.

La création de sous-ensembles n’est actuellement pas prise en charge et pszSubsetTitle ne peut pas être défini par les applications.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
En-tête commctrl.h