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
構造体のどのメンバーが有効な入力であるかを指定するマスク。 次の値のうち 1 つ以上。
値 | 意味 |
---|---|
|
その他の項目は有効ではありません。 |
|
pszHeader メンバーと cchHeader メンバーは有効です。 |
|
pszFooter メンバーと cchFooter メンバーは有効です。 |
|
state メンバーと stateMask メンバーは有効です。 |
|
uAlign メンバーは有効です。 |
|
iGroupId メンバーは有効です。 |
|
バージョン 6.00 以降。 pszSubtitle メンバーは有効です。 |
|
バージョン 6.00 以降。 pszTask メンバーは有効です。 |
|
バージョン 6.00 以降。 pszDescriptionTop メンバーは有効です。 |
|
バージョン 6.00 以降。 pszDescriptionBottom メンバーは有効です。 |
|
バージョン 6.00 以降。 iTitleImage メンバーは有効です。 |
|
バージョン 6.00 以降。 iExtendedImage メンバーは有効です。 |
|
バージョン 6.00 以降。 cItems メンバーは有効です。 |
|
バージョン 6.00 以降。 pszSubsetTitle メンバーは有効です。 |
|
バージョン 6.00 以降。 cchSubsetTitle メンバーは有効です。 |
pszHeader
種類: LPWSTR
項目情報が設定されているときにヘッダー テキストを含む null で終わる文字列へのポインター。 グループ情報を取得する場合、このメンバーはヘッダー テキストを受け取るバッファーのアドレスを指定します。
cchHeader
型: int
pszHeader メンバーが指すバッファーの TCHAR単位のサイズ。 構造体がグループに関する情報を受信していない場合、このメンバーは無視されます。
pszFooter
種類: LPWSTR
アイテム情報が設定されている場合にフッター テキストを含む null で終わる文字列へのポインター。 グループ情報を取得する場合、このメンバーはフッター テキストを受け取るバッファーのアドレスを指定します。
cchFooter
型: int
pszFooter メンバーが指すバッファーの TCHAR単位のサイズ。 構造体がグループに関する情報を受信していない場合、このメンバーは無視されます。
iGroupId
型: int
グループの ID。
stateMask
型: UINT
LVM_GETGROUPINFOとLVM_SETGROUPINFOで使用されるマスクを使用して、取得または設定する状態値のフラグを指定します。
state
型: UINT
次のいずれかの値を持つフラグ。
値 | 意味 |
---|---|
|
グループが展開され、グループ名が表示され、グループ内のすべての項目が表示されます。 |
|
グループは折りたたまれています。 |
|
グループは非表示になっています。 |
|
バージョン 6.00 以降。 グループにヘッダーは表示されません。 |
|
バージョン 6.00 以降。 グループは折りたたむことができます。 |
|
バージョン 6.00 以降。 グループにはキーボード フォーカスがあります。 |
|
バージョン 6.00 以降。 グループが選択されています。 |
|
バージョン 6.00 以降。 グループには、項目の一部のみが表示されます。 |
|
バージョン 6.00 以降。 グループのサブセット リンクにはキーボード フォーカスがあります。 |
uAlign
型: UINT
グループのヘッダーテキストまたはフッターテキストの配置を示します。 次の値の 1 つ以上を含めることができます。 ヘッダー フラグのいずれかを使用します。 フッター フラグは省略可能です。
pszSubtitle
種類: LPWSTR
アイテム情報が設定されているときにサブタイトル テキストを含む null で終わる文字列へのポインター。 グループ情報を取得する場合、このメンバーはサブタイトル テキストを受け取るバッファーのアドレスを指定します。 この要素は、ヘッダー テキストの下に描画されます。
cchSubtitle
型: UINT
pszSubtitle メンバーが指すバッファーのサイズ (TCHARs)。 構造体がグループに関する情報を受信していない場合、このメンバーは無視されます。
pszTask
種類: LPWSTR
アイテム情報が設定されているときにタスク リンクのテキストを含む null で終わる文字列へのポインター。 グループ情報を取得する場合、このメンバーはタスク テキストを受け取るバッファーのアドレスを指定します。 この項目は、ヘッダー テキストの反対側に右揃えで描画されます。 ユーザーがクリックすると、タスク リンクによって LVN_LINKCLICK 通知が生成されます。
cchTask
型: UINT
pszTask メンバーが指すバッファーの TCHAR単位のサイズ。 構造体がグループに関する情報を受信していない場合、このメンバーは無視されます。
pszDescriptionTop
種類: LPWSTR
項目情報が設定されている場合に、上位の説明テキストを含む null で終わる文字列へのポインター。 グループ情報を取得する場合、このメンバーは、上位の説明テキストを受け取るバッファーのアドレスを指定します。 このアイテムは、タイトル イメージ、拡張イメージ、 および uAlign==LVGA_HEADER_CENTERがある場合に、タイトル イメージの反対側に描画されます。
cchDescriptionTop
型: UINT
pszDescriptionTop メンバーが指すバッファーの TCHAR単位のサイズ。 構造体がグループに関する情報を受信していない場合、このメンバーは無視されます。
pszDescriptionBottom
種類: LPWSTR
項目情報が設定されている場合に、下の説明テキストを含む null で終わる文字列へのポインター。 グループ情報を取得する場合、このメンバーは、下の説明テキストを受け取るバッファーのアドレスを指定します。 このアイテムは、タイトル イメージ、拡張イメージなし、 uAlign==LVGA_HEADER_CENTERがある場合に、上部の説明テキストの下に描画されます。
cchDescriptionBottom
型: UINT
pszDescriptionBottom メンバーが指すバッファーの TCHAR単位のサイズ。 構造体がグループに関する情報を受信していない場合、このメンバーは無視されます。
iTitleImage
型: int
コントロールイメージリスト内のタイトルイメージのインデックス。
iExtendedImage
型: int
コントロール イメージリスト内の拡張イメージのインデックス。
iFirstItem
型: int
読み取り専用です。
cItems
型: UINT
所有者以外のデータ モードでの読み取り専用。
pszSubsetTitle
種類: LPWSTR
group がサブセットでない場合は NULL。 アイテム情報の設定時にサブセット タイトル テキストを含む null で終わる文字列へのポインター。 グループ情報を取得する場合、このメンバーはサブセット タイトル テキストを受け取るバッファーのアドレスを指定します。
cchSubsetTitle
型: UINT
pszSubsetTitle メンバーが指すバッファーの TCHAR単位のサイズ。 構造体がグループに関する情報を受信していない場合、このメンバーは無視されます。
注釈
この構造体で返されるすべての文字列は、読み取り専用として扱う必要があります。
サブセットの作成は現在サポートされていないため、 pszSubsetTitle をアプリケーションで設定することはできません。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
Header | commctrl.h |