Estrutura LVGROUP (commctrl.h)

  • Artigo

Usado para definir e recuperar grupos.

Sintaxe

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;

Membros

cbSize

Tipo: UINT

Tamanho dessa estrutura, em bytes.

mask

Tipo: UINT

Máscara que especifica quais membros da estrutura são entradas válidas. Um ou mais dos seguintes valores:

Valor Significado
LVGF_NONE
 Nenhum outro item é válido.
LVGF_HEADER
 Os membros pszHeader e cchHeader são válidos.
LVGF_FOOTER
 Os membros pszFooter e cchFooter são válidos.
LVGF_STATE
 state e stateMask members are valid.
LVGF_ALIGN
 O membro uAlign é válido.
LVGF_GROUPID
 O membro iGroupId é válido.
LVGF_SUBTITLE

Versão 6.00 e posterior. O membro pszSubtitle é válido.
LVGF_TASK

Versão 6.00 e posterior. O membro pszTask é válido.
LVGF_DESCRIPTIONTOP

Versão 6.00 e posterior. O membro pszDescriptionTop é válido.
LVGF_DESCRIPTIONBOTTOM

Versão 6.00 e posterior. O membro pszDescriptionBottom é válido.
LVGF_TITLEIMAGE

Versão 6.00 e posterior. O membro iTitleImage é válido.
LVGF_EXTENDEDIMAGE

Versão 6.00 e posterior. O membro iExtendedImage é válido.
LVGF_ITEMS

Versão 6.00 e posterior. O membro cItems é válido.
LVGF_SUBSET

Versão 6.00 e posterior. O membro pszSubsetTitle é válido.
LVGF_SUBSETITEMS

Versão 6.00 e posterior. O membro cchSubsetTitle é válido.

pszHeader

Tipo: LPWSTR

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o texto do cabeçalho quando as informações do item estão sendo definidas. Se as informações do grupo estiverem sendo recuperadas, esse membro especificará o endereço do buffer que recebe o texto do cabeçalho.

cchHeader

Tipo: int

Tamanho em TCHARs do buffer apontado pelo membro pszHeader . Se a estrutura não estiver recebendo informações sobre um grupo, esse membro será ignorado.

pszFooter

Tipo: LPWSTR

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o texto do rodapé quando as informações do item estão sendo definidas. Se as informações do grupo estiverem sendo recuperadas, esse membro especificará o endereço do buffer que recebe o texto do rodapé.

cchFooter

Tipo: int

Tamanho em TCHARs do buffer apontado pelo membro pszFooter . Se a estrutura não estiver recebendo informações sobre um grupo, esse membro será ignorado.

iGroupId

Tipo: int

ID do grupo.

stateMask

Tipo: UINT

Máscara usada com LVM_GETGROUPINFO e LVM_SETGROUPINFO para especificar quais sinalizadores no valor de estado estão sendo recuperados ou definidos.

state

Tipo: UINT

Sinalizador que pode ter um dos seguintes valores:

Valor Significado
LVGS_NORMAL
 Os grupos são expandidos, o nome do grupo é exibido e todos os itens no grupo são exibidos.
LVGS_COLLAPSED
 O grupo está recolhido.
LVGS_HIDDEN
 O grupo está oculto.
LVGS_NOHEADER

Versão 6.00 e posterior. O grupo não exibe um cabeçalho.
LVGS_COLLAPSIBLE

Versão 6.00 e posterior. O grupo pode ser recolhido.
LVGS_FOCUSED

Versão 6.00 e posterior. O grupo tem o foco do teclado.
LVGS_SELECTED

Versão 6.00 e posterior. O grupo está selecionado.
LVGS_SUBSETED

Versão 6.00 e posterior. O grupo exibe apenas uma parte de seus itens.
LVGS_SUBSETLINKFOCUSED

Versão 6.00 e posterior. O link do subconjunto do grupo tem o foco do teclado.

uAlign

Tipo: UINT

Indica o alinhamento do texto do cabeçalho ou rodapé para o grupo. Ele pode ter um ou mais dos valores a seguir. Use um dos sinalizadores de cabeçalho. Sinalizadores de rodapé são opcionais.

Valor Significado
LVGA_FOOTER_CENTER
 O texto do rodapé é centralizado horizontalmente na janela.
LVGA_FOOTER_LEFT
 O texto do rodapé é alinhado à esquerda da janela.
LVGA_FOOTER_RIGHT
 O texto do rodapé está alinhado à direita da janela.
LVGA_HEADER_CENTER
 O texto do cabeçalho é centralizado horizontalmente na janela.
LVGA_HEADER_LEFT
 O texto do cabeçalho é alinhado à esquerda da janela.
LVGA_HEADER_RIGHT
 O texto do cabeçalho é alinhado à direita da janela.

pszSubtitle

Tipo: LPWSTR

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o texto do subtítulo quando as informações do item estão sendo definidas. Se as informações do grupo estiverem sendo recuperadas, esse membro especificará o endereço do buffer que recebe o texto do subtítulo. Esse elemento é desenhado sob o texto do cabeçalho.

cchSubtitle

Tipo: UINT

Tamanho, em TCHARs, do buffer apontado pelo membro pszSubtitle . Se a estrutura não estiver recebendo informações sobre um grupo, esse membro será ignorado.

pszTask

Tipo: LPWSTR

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o texto de um link de tarefa quando as informações do item estão sendo definidas. Se as informações do grupo estiverem sendo recuperadas, esse membro especificará o endereço do buffer que recebe o texto da tarefa. Este item é desenhado alinhado à direita em frente ao texto do cabeçalho. Quando clicado pelo usuário, o link da tarefa gera uma notificação LVN_LINKCLICK .

cchTask

Tipo: UINT

Tamanho em TCHARs do buffer apontado pelo membro pszTask . Se a estrutura não estiver recebendo informações sobre um grupo, esse membro será ignorado.

pszDescriptionTop

Tipo: LPWSTR

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o texto de descrição superior quando as informações do item estão sendo definidas. Se as informações do grupo estiverem sendo recuperadas, esse membro especificará o endereço do buffer que recebe o texto de descrição superior. Esse item é desenhado em frente à imagem de título quando há uma imagem de título, nenhuma imagem estendida e LVGA_HEADER_CENTER uAlign==.

cchDescriptionTop

Tipo: UINT

Tamanho em TCHARs do buffer apontado pelo membro pszDescriptionTop . Se a estrutura não estiver recebendo informações sobre um grupo, esse membro será ignorado.

pszDescriptionBottom

Tipo: LPWSTR

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o texto de descrição inferior quando as informações do item estão sendo definidas. Se as informações do grupo estiverem sendo recuperadas, esse membro especificará o endereço do buffer que recebe o texto de descrição inferior. Esse item é desenhado sob o texto de descrição superior quando há uma imagem de título, nenhuma imagem estendida e LVGA_HEADER_CENTER uAlign==.

cchDescriptionBottom

Tipo: UINT

Tamanho em TCHARs do buffer apontado pelo membro pszDescriptionBottom . Se a estrutura não estiver recebendo informações sobre um grupo, esse membro será ignorado.

iTitleImage

Tipo: int

Índice da imagem de título na lista de imagens de controle.

iExtendedImage

Tipo: int

Índice da imagem estendida na lista de imagens de controle.

iFirstItem

Tipo: int

Somente leitura.

cItems

Tipo: UINT

Somente leitura no modo de dados não proprietário.

pszSubsetTitle

Tipo: LPWSTR

NULL se o grupo não for um subconjunto. Ponteiro para uma cadeia de caracteres terminada em nulo que contém o texto do título do subconjunto quando as informações do item estão sendo definidas. Se as informações do grupo estiverem sendo recuperadas, esse membro especificará o endereço do buffer que recebe o texto do título do subconjunto.

cchSubsetTitle

Tipo: UINT

Tamanho em TCHARs do buffer apontado pelo membro pszSubsetTitle . Se a estrutura não estiver recebendo informações sobre um grupo, esse membro será ignorado.

Comentários

Todas as cadeias de caracteres retornadas nessa estrutura devem ser tratadas como somente leitura.

Atualmente, não há suporte para a criação de subconjuntos e pszSubsetTitle não pode ser definido por aplicativos.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003 [somente aplicativos da área de trabalho]
Cabeçalho commctrl.h