Share via

Структура LVGROUP (commctrl.h)

  • Статья

Используется для задания и извлечения групп.

Синтаксис

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;

Члены

cbSize

Тип: UINT

Размер этой структуры в байтах.

mask

Тип: UINT

Маска, указывающая, какие элементы структуры являются допустимыми входными данными. Одно или несколько из следующих значений:

Значение Значение
LVGF_NONE
 Никакие другие элементы не являются допустимыми.
LVGF_HEADER
 Члены pszHeader и cchHeader являются допустимыми.
LVGF_FOOTER
 Допустимы члены pszFooter и cchFooter.
LVGF_STATE
 элементы state и stateMask являются допустимыми.
LVGF_ALIGN
 Элемент uAlign является допустимым.
LVGF_GROUPID
 Элемент iGroupId является допустимым.
LVGF_SUBTITLE

Версия 6.00 и более поздняя. Член pszSubtitle является допустимым.
LVGF_TASK

Версия 6.00 и более поздняя. Член pszTask является допустимым .
LVGF_DESCRIPTIONTOP

Версия 6.00 и более поздняя. Допустимый член pszDescriptionTop .
LVGF_DESCRIPTIONBOTTOM

Версия 6.00 и более поздняя. Допустимый член pszDescriptionBottom .
LVGF_TITLEIMAGE

Версия 6.00 и более поздняя. Допустимый элемент iTitleImage .
LVGF_EXTENDEDIMAGE

Версия 6.00 и более поздняя. Допустимый элемент iExtendedImage .
LVGF_ITEMS

Версия 6.00 и более поздняя. Допустимый элемент cItems .
LVGF_SUBSET

Версия 6.00 и более поздняя. Член pszSubsetTitle является допустимым .
LVGF_SUBSETITEMS

Версия 6.00 и более поздняя. Допустимый член cchSubsetTitle .

pszHeader

Тип: LPWSTR

Указатель на строку, завершающуюся значением NULL, которая содержит текст заголовка при установке сведений об элементе. При извлечении сведений о группе этот член указывает адрес буфера, получающего текст заголовка.

cchHeader

Тип: int

Размер буфера в TCHAR, на который указывает элемент pszHeader . Если структура не получает сведения о группе, этот член игнорируется.

pszFooter

Тип: LPWSTR

Указатель на строку, завершающуюся нулевым значением, которая содержит текст нижнего колонтитула при установке сведений об элементе. Если извлекаются сведения о группе, этот член указывает адрес буфера, который получает текст нижнего колонтитула.

cchFooter

Тип: int

Размер буфера в TCHAR, на который указывает элемент pszFooter . Если структура не получает сведения о группе, этот член игнорируется.

iGroupId

Тип: int

Идентификатор группы.

stateMask

Тип: UINT

Маска, используемая с LVM_GETGROUPINFO и LVM_SETGROUPINFO , чтобы указать, какие флаги в значении состояния извлекаются или задаются.

state

Тип: UINT

Флаг, который может иметь одно из следующих значений:

Значение Значение
LVGS_NORMAL
 Группы разворачиваются, отображается имя группы и отображаются все элементы группы.
LVGS_COLLAPSED
 Группа свернута.
LVGS_HIDDEN
 Группа скрыта.
LVGS_NOHEADER

Версия 6.00 и более поздняя. Группа не отображает заголовок.
LVGS_COLLAPSIBLE

Версия 6.00 и более поздняя. Группу можно свернуть.
LVGS_FOCUSED

Версия 6.00 и более поздняя. Группа имеет фокус клавиатуры.
LVGS_SELECTED

Версия 6.00 и более поздняя. Выбранная группа.
LVGS_SUBSETED

Версия 6.00 и более поздняя. Группа отображает только часть своих элементов.
LVGS_SUBSETLINKFOCUSED

Версия 6.00 и более поздняя. Ссылка на подмножество группы имеет фокус клавиатуры.

uAlign

Тип: UINT

Указывает выравнивание текста верхнего или нижнего колонтитула для группы. Он может иметь одно или несколько из следующих значений. Используйте один из флагов заголовка. Флаги нижнего колонтитула являются необязательными.

Значение Значение
LVGA_FOOTER_CENTER
 Текст нижнего колонтитула выцентрирован по горизонтали в окне.
LVGA_FOOTER_LEFT
 Текст нижнего колонтитула выравнивается по левой части окна.
LVGA_FOOTER_RIGHT
 Текст нижнего колонтитула выравнивается справа от окна.
LVGA_HEADER_CENTER
 Текст заголовка находится по центру по горизонтали в окне.
LVGA_HEADER_LEFT
 Текст заголовка выравнивается слева от окна.
LVGA_HEADER_RIGHT
 Текст заголовка выравнивается по правой части окна.

pszSubtitle

Тип: LPWSTR

Указатель на строку, завершающуюся нулевым значением, которая содержит текст подзаголовка при установке сведений об элементе. При извлечении сведений о группе этот член указывает адрес буфера, который получает текст субтитра. Этот элемент рисуется под текстом заголовка.

cchSubtitle

Тип: UINT

Размер буфера, на который указывает элемент pszSubtitle в TCHAR. Если структура не получает сведения о группе, этот член игнорируется.

pszTask

Тип: LPWSTR

Указатель на строку, завершающуюся нулевым значением, которая содержит текст для ссылки на задачу при установке сведений об элементе. Если извлекаются сведения о группе, этот член указывает адрес буфера, получающего текст задачи. Этот элемент выравнивается по правому краю напротив текста заголовка. При щелчке пользователем ссылка задачи создает уведомление LVN_LINKCLICK .

cchTask

Тип: UINT

Размер буфера в TCHAR, на который указывает элемент pszTask . Если структура не получает сведения о группе, этот член игнорируется.

pszDescriptionTop

Тип: LPWSTR

Указатель на строку, завершающуюся значением NULL, которая содержит верхний текст описания при установке сведений об элементе. Если извлекаются сведения о группе, этот член указывает адрес буфера, получающего текст верхнего описания. Этот элемент рисуется напротив изображения заголовка, если есть изображение заголовка, без расширенного изображения и uAlign==LVGA_HEADER_CENTER.

cchDescriptionTop

Тип: UINT

Размер буфера в TCHAR, на который указывает элемент pszDescriptionTop . Если структура не получает сведения о группе, этот член игнорируется.

pszDescriptionBottom

Тип: LPWSTR

Указатель на строку, завершающуюся нулевым значением, которая содержит нижний текст описания при установке сведений об элементе. Если извлекаются сведения о группе, этот член указывает адрес буфера, который получает текст нижнего описания. Этот элемент рисуется под текстом верхнего описания, если есть изображение заголовка, без расширенного изображения и uAlign==LVGA_HEADER_CENTER.

cchDescriptionBottom

Тип: UINT

Размер буфера в TCHAR, на который указывает член pszDescriptionBottom . Если структура не получает сведения о группе, этот член игнорируется.

iTitleImage

Тип: int

Индекс изображения заголовка в списке изображений элементов управления.

iExtendedImage

Тип: int

Индекс расширенного образа в списке изображений элементов управления.

iFirstItem

Тип: int

Только для чтения.

cItems

Тип: UINT

Только для чтения в режиме данных, не являющемся владельцем.

pszSubsetTitle

Тип: LPWSTR

Значение NULL , если group не является подмножеством. Указатель на строку, завершающуюся значением NULL, которая содержит текст заголовка подмножества при установке сведений об элементе. При извлечении сведений о группе этот член указывает адрес буфера, который получает текст заголовка подмножества.

cchSubsetTitle

Тип: UINT

Размер буфера, на который указывает элемент pszSubsetTitle, в TCHAR. Если структура не получает сведения о группе, этот член игнорируется.

Комментарии

Все строки, возвращаемые в этой структуре, должны рассматриваться как доступные только для чтения.

Создание подмножеств в настоящее время не поддерживается, и приложения не могут задать pszSubsetTitle .

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Верхняя часть commctrl.h