Win32 API 日本語リファレンス
ホームUI.Controls › TVITEMA

TVITEMA

構造体
サイズx64: 56 バイト / x86: 40 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
maskTVITEM_MASK4+0+0

他のどのメンバーが有効なデータを保持しているかを示すフラグの集合です。この構造体を TVM_GETITEM メッセージで使用する場合、mask メンバーは取得する項目属性を示します。TVM_SETITEM メッセージで使用する場合は、mask は設定する属性を示します。このメンバーには次の値の 1 つ以上を指定できます。

意味
TVIF_CHILDREN
                    <b>cChildren</b> メンバーが有効です。
TVIF_DI_SETITEM
ツリービューコントロールは提供された情報を保持し、再度要求しません。このフラグは TVN_GETDISPINFO 通知の処理中にのみ有効です。
TVIF_HANDLE
                    <b>hItem</b> メンバーが有効です。
TVIF_IMAGE
                    <b>iImage</b> メンバーが有効です。
TVIF_PARAM
                    <b>lParam</b> メンバーが有効です。
TVIF_SELECTEDIMAGE
                    <b>iSelectedImage</b> メンバーが有効です。
TVIF_STATE
                    <b>state</b> メンバーと 
                    <b>stateMask</b> メンバーが有効です。
TVIF_TEXT
                    <b>pszText</b> メンバーと 
                    <b>cchTextMax</b> メンバーが有効です。
hItemHTREEITEM8/4+8+4項目のハンドルです。
stateTREE_VIEW_ITEM_STATE_FLAGS4+16+8

項目の状態を示すビットフラグとイメージリストのインデックスの集合です。項目の状態を設定する場合、 stateMask メンバーがこのメンバーの有効なビットを示します。項目の状態を取得する場合、このメンバーは stateMask メンバーで示されたビットの現在の状態を返します。

このメンバーのビット 0 から 7 には項目の状態フラグが格納されます。指定可能な項目の状態フラグの一覧については、Tree-View Control Item States を参照してください。

オーバーレイイメージは項目のアイコンイメージに重ねて表示されます。このメンバーのビット 8 から 11 は、1 から始まるオーバーレイイメージのインデックスを指定します。これらのビットが 0 の場合、その項目にオーバーレイイメージはありません。これらのビットを取り出すには TVIS_OVERLAYMASK マスクを使用します。このメンバーにオーバーレイイメージのインデックスを設定するには、INDEXTOOVERLAYMASK マクロを使用します。イメージリストのオーバーレイイメージは ImageList_SetOverlayImage 関数で設定します。

状態イメージは、アプリケーション定義の状態を示すために項目のアイコンの隣に表示されます。状態イメージリストを指定するには、TVM_SETIMAGELIST メッセージを送信します。項目の状態イメージを設定するには、TVITEM 構造体の stateMask メンバーに TVIS_STATEIMAGEMASK の値を含めます。構造体の state メンバーのビット 12 から 15 は、描画するイメージの状態イメージリスト内でのインデックスを指定します。

状態イメージのインデックスを設定するには、INDEXTOSTATEIMAGEMASK を使用します。このマクロはインデックスを受け取り、ビット 12 から 15 を適切に設定します。項目に状態イメージがないことを示すには、インデックスを 0 に設定します。この規約により、状態イメージリストのインデックス 0 のイメージは状態イメージとして使用できません。 state メンバーのビット 12 から 15 を取り出すには、TVIS_STATEIMAGEMASK マスクを使用します。

stateMaskTREE_VIEW_ITEM_STATE_FLAGS4+20+12
                <b>state</b> メンバーのうち有効なビットです。項目の状態を取得する場合は、
                <b>state</b> メンバーで返してほしいビットを示すように 
                <b>stateMask</b> メンバーのビットを設定します。項目の状態を設定する場合は、設定したい 
                <b>state</b> メンバーのビットを示すように 
                <b>stateMask</b> メンバーのビットを設定します。項目のオーバーレイイメージのインデックスを設定または取得するには、<a href="/windows/desktop/Controls/tree-view-control-item-states">TVIS_OVERLAYMASK</a> のビットを設定します。項目の状態イメージのインデックスを設定または取得するには、<a href="/windows/desktop/Controls/tree-view-control-item-states">TVIS_STATEIMAGEMASK</a> のビットを設定します。
pszTextLPSTR8/4+24+16この構造体で項目属性を指定する場合は、項目のテキストを含む NULL 終端文字列へのポインターです。このメンバーが LPSTR_TEXTCALLBACK の値である場合、名前の保持は親ウィンドウの責任となります。この場合、ツリービューコントロールは、表示・並べ替え・編集のために項目のテキストが必要になったときに親ウィンドウへ TVN_GETDISPINFO 通知コードを送信し、項目のテキストが変更されたときに TVN_SETDISPINFO 通知コードを送信します。この構造体で項目属性を受け取る場合、このメンバーは項目のテキストを受け取るバッファーのアドレスです。なお、ツリービューコントロールは任意の長さの文字列を項目のテキストとして格納できますが、表示されるのは先頭の 260 文字だけです。
cchTextMaxINT4+32+20
                <b>pszText</b> メンバーが指すバッファーのサイズ (文字単位) です。この構造体を項目属性の設定に使用する場合、このメンバーは無視されます。
iImageINT4+36+24項目が非選択状態のときに使用するアイコンイメージの、ツリービューコントロールのイメージリスト内でのインデックスです。このメンバーが I_IMAGECALLBACK の値である場合、インデックスの保持は親ウィンドウの責任となります。この場合、ツリービューコントロールはイメージを表示する必要が生じたときに、インデックスを取得するために親へ TVN_GETDISPINFO 通知コードを送信します。
iSelectedImageINT4+40+28項目が選択状態のときに使用するアイコンイメージの、ツリービューコントロールのイメージリスト内でのインデックスです。このメンバーが I_IMAGECALLBACK の値である場合、インデックスの保持は親ウィンドウの責任となります。この場合、ツリービューコントロールはイメージを表示する必要が生じたときに、インデックスを取得するために親へ TVN_GETDISPINFO 通知コードを送信します。
cChildrenTVITEMEXW_CHILDREN4+44+32

項目に関連付けられた子項目があるかどうかを示すフラグです。このメンバーには次のいずれかの値を指定できます。

意味
zero
項目に子項目はありません。
one
項目に 1 つ以上の子項目があります。
I_CHILDRENCALLBACK
項目に子項目があるかどうかは親ウィンドウが管理します。この場合、ツリービューコントロールは項目を表示する必要が生じたときに、項目に子項目があるかどうかを判断するために親へ TVN_GETDISPINFO 通知コードを送信します。

ツリービューコントロールに TVS_HASBUTTONS スタイルが設定されている場合、コントロールはこのメンバーを使用して、子項目の存在を示すボタンを表示するかどうかを判断します。このメンバーを使用すると、実際には子項目が挿入されていなくてもボタンを強制的に表示させることができます。これにより、項目が表示されたとき、または展開されたときにのみ子項目を挿入することで、コントロールのメモリ使用量を最小限に抑えつつボタンを表示できます。

I_CHILDRENAUTO

バージョン 6.0 内部使用を目的としています。アプリケーションでの使用は推奨されません。 ツリービューコントロールが、項目に子項目があるかどうかを自動的に判断します。

注意 このフラグは将来のバージョンの Comctl32.dll ではサポートされない可能性があります。また、このフラグは commctrl.h では定義されていません。このフラグを使用するには、アプリケーションのソースファイルに次の定義を追加してください。
#define I_CHILDRENAUTO (-2)
lParamLPARAM8/4+48+36項目に関連付ける値です。

公式ドキュメント

ツリービュー項目の属性を指定または受け取ります。この構造体は TV_ITEM 構造体と同一ですが、現在の命名規則に従うように名前が変更されました。新しいアプリケーションではこの構造体を使用してください。

解説(Remarks)

メモ

commctrl.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて ANSI 版と Unicode 版のどちらかを自動的に選択するエイリアスとして TVITEM を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// TVITEMA  (x64 56 / x86 40 バイト)
typedef struct TVITEMA {
    TVITEM_MASK mask;
    HTREEITEM hItem;
    TREE_VIEW_ITEM_STATE_FLAGS state;
    TREE_VIEW_ITEM_STATE_FLAGS stateMask;
    LPSTR pszText;
    INT cchTextMax;
    INT iImage;
    INT iSelectedImage;
    TVITEMEXW_CHILDREN cChildren;
    LPARAM lParam;
} TVITEMA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct TVITEMA
{
    public uint mask;
    public IntPtr hItem;
    public uint state;
    public uint stateMask;
    public IntPtr pszText;
    public int cchTextMax;
    public int iImage;
    public int iSelectedImage;
    public int cChildren;
    public IntPtr lParam;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure TVITEMA
    Public mask As UInteger
    Public hItem As IntPtr
    Public state As UInteger
    Public stateMask As UInteger
    Public pszText As IntPtr
    Public cchTextMax As Integer
    Public iImage As Integer
    Public iSelectedImage As Integer
    Public cChildren As Integer
    Public lParam As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class TVITEMA(ctypes.Structure):
    _fields_ = [
        ("mask", wintypes.DWORD),
        ("hItem", ctypes.c_ssize_t),
        ("state", wintypes.DWORD),
        ("stateMask", wintypes.DWORD),
        ("pszText", ctypes.c_void_p),
        ("cchTextMax", ctypes.c_int),
        ("iImage", ctypes.c_int),
        ("iSelectedImage", ctypes.c_int),
        ("cChildren", ctypes.c_int),
        ("lParam", ctypes.c_ssize_t),
    ]
#[repr(C)]
pub struct TVITEMA {
    pub mask: u32,
    pub hItem: isize,
    pub state: u32,
    pub stateMask: u32,
    pub pszText: *mut core::ffi::c_void,
    pub cchTextMax: i32,
    pub iImage: i32,
    pub iSelectedImage: i32,
    pub cChildren: i32,
    pub lParam: isize,
}
import "golang.org/x/sys/windows"

type TVITEMA struct {
	mask uint32
	hItem uintptr
	state uint32
	stateMask uint32
	pszText uintptr
	cchTextMax int32
	iImage int32
	iSelectedImage int32
	cChildren int32
	lParam uintptr
}
type
  TVITEMA = record
    mask: DWORD;
    hItem: NativeInt;
    state: DWORD;
    stateMask: DWORD;
    pszText: Pointer;
    cchTextMax: Integer;
    iImage: Integer;
    iSelectedImage: Integer;
    cChildren: Integer;
    lParam: NativeInt;
  end;
const TVITEMA = extern struct {
    mask: u32,
    hItem: isize,
    state: u32,
    stateMask: u32,
    pszText: ?*anyopaque,
    cchTextMax: i32,
    iImage: i32,
    iSelectedImage: i32,
    cChildren: i32,
    lParam: isize,
};
type
  TVITEMA {.bycopy.} = object
    mask: uint32
    hItem: int
    state: uint32
    stateMask: uint32
    pszText: pointer
    cchTextMax: int32
    iImage: int32
    iSelectedImage: int32
    cChildren: int32
    lParam: int
struct TVITEMA
{
    uint mask;
    ptrdiff_t hItem;
    uint state;
    uint stateMask;
    void* pszText;
    int cchTextMax;
    int iImage;
    int iSelectedImage;
    int cChildren;
    ptrdiff_t lParam;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; TVITEMA サイズ: 40 バイト(x86)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; mask : TVITEM_MASK (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; hItem : HTREEITEM (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; state : TREE_VIEW_ITEM_STATE_FLAGS (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; stateMask : TREE_VIEW_ITEM_STATE_FLAGS (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; pszText : LPSTR (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; cchTextMax : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; iImage : INT (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; iSelectedImage : INT (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; cChildren : TVITEMEXW_CHILDREN (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; lParam : LPARAM (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; TVITEMA サイズ: 56 バイト(x64)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; mask : TVITEM_MASK (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; hItem : HTREEITEM (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; state : TREE_VIEW_ITEM_STATE_FLAGS (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; stateMask : TREE_VIEW_ITEM_STATE_FLAGS (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; pszText : LPSTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; cchTextMax : INT (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; iImage : INT (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; iSelectedImage : INT (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; cChildren : TVITEMEXW_CHILDREN (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; lParam : LPARAM (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global TVITEMA
    #field int mask
    #field intptr hItem
    #field int state
    #field int stateMask
    #field intptr pszText
    #field int cchTextMax
    #field int iImage
    #field int iSelectedImage
    #field int cChildren
    #field intptr lParam
#endstruct

stdim st, TVITEMA        ; NSTRUCT 変数を確保
st->mask = 100
mes "mask=" + st->mask