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

NMCUSTOMDRAW

構造体
サイズx64: 80 バイト / x86: 48 バイト

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

フィールド

フィールドサイズx64x86説明
hdrNMHDR24/12+0+0この通知コードに関する情報を格納する NMHDR 構造体です。
dwDrawStageNMCUSTOMDRAW_DRAW_STAGE4+24+12

現在の描画ステージです。次のいずれかの値になります。

意味
グローバルな値:
CDDS_POSTERASE
消去サイクルの完了後です。
CDDS_POSTPAINT
描画サイクルの完了後です。
CDDS_PREERASE
消去サイクルの開始前です。
CDDS_PREPAINT
描画サイクルの開始前です。
項目固有の値:
CDDS_ITEM
dwItemSpecuItemStatelItemlParam の各メンバーが有効であることを示します。
CDDS_ITEMPOSTERASE
項目が消去された後です。
CDDS_ITEMPOSTPAINT
項目が描画された後です。
CDDS_ITEMPREERASE
項目が消去される前です。
CDDS_ITEMPREPAINT
項目が描画される前です。
CDDS_SUBITEM
サブ項目が描画される場合に CDDS_ITEMPREPAINT または CDDS_ITEMPOSTPAINT と組み合わせて指定されるフラグです。これは、CDDS_PREPAINT から CDRF_NOTIFYITEMDRAW が返された場合にのみ設定されます。
hdcHDC8/4+32+16コントロールのデバイスコンテキストへのハンドルです。GDI 関数を実行するには、この HDC を使用します。
rcRECT16+40+20描画対象の領域の外接矩形を表す RECT 構造体です。このメンバーは CDDS_ITEMPREPAINT 通知でのみ初期化されます。バージョン 5.80。 このメンバーは CDDS_PREPAINT 通知でも初期化されます。
dwItemSpecUINT_PTR8/4+56+36項目番号です。このメンバーに格納される内容は、通知を送信するコントロールの種類によって異なります。このメンバーに何が格納されるか (格納される場合) を判断するには、該当するコントロールの NM_CUSTOMDRAW 通知のリファレンスを参照してください。
uItemStateNMCUSTOMDRAW_DRAW_STATE_FLAGS4+64+40

現在の項目の状態です。この値は次のフラグの組み合わせです。

意味
CDIS_CHECKED
項目はチェックされています。
CDIS_DEFAULT
項目は既定の状態です。
CDIS_DISABLED
項目は無効になっています。
CDIS_FOCUS
項目はフォーカスを持っています。
CDIS_GRAYED
項目はグレー表示されています。
CDIS_HOT
項目は現在ポインターの下にあります (「ホット」)。
CDIS_INDETERMINATE
項目は不確定な状態です。
CDIS_MARKED
項目はマークされています。この意味は実装によって決まります。
CDIS_SELECTED
項目は選択されています。
注意 このフラグは、LVS_SHOWSELALWAYS スタイルを持つオーナー描画のリストビューコントロールでは正しく機能しません。これらのコントロールでは、LVM_GETITEMSTATE (または ListView_GetItemState) を使用して LVIS_SELECTED フラグを調べることで、項目が選択されているかどうかを判断できます。
CDIS_SHOWKEYBOARDCUES

バージョン 6.0。項目はキーボードキューを表示しています。

Comctl32 バージョン 6 は再頒布可能ではない点に注意してください。Comctl32.dll バージョン 6 を使用するには、マニフェストで指定します。マニフェストの詳細については、ビジュアルスタイルの有効化 を参照してください。

CDIS_NEARHOT
項目は、現在マウスポインターの下にある (「ホット」) コントロールの一部ですが、項目自体は「ホット」ではありません。この意味は実装によって決まります。
CDIS_OTHERSIDEHOT
項目は、現在マウスポインターの下にある (「ホット」) 分割ボタンの一部ですが、項目自体は「ホット」ではありません。この意味は実装によって決まります。
CDIS_DROPHILITED
項目は現在、ドラッグアンドドロップ操作のドロップ先になっています。
lItemlParamLPARAM8/4+72+44アプリケーション定義の項目データです。

公式ドキュメント

NM_CUSTOMDRAW 通知コードに固有の情報を格納します。

解説(Remarks)

アプリケーションが返す値は、現在の描画ステージによって異なります。対応する NMCUSTOMDRAW 構造体の dwDrawStage メンバーには、描画ステージを指定する値が格納されます。dwDrawStage メンバーが CDDS_PREPAINT および CDDS_PREERASE の場合、一部のコントロールは最初に CDDS_PREERASE メッセージを送信し、その戻り値によって後続のどのメッセージが送信されるかが示されることを期待します。状態と描画ステージを示すコードサンプルについては、カスタム描画を使用したコントロールの外観のカスタマイズ を参照してください。

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

各言語での定義

#include <windows.h>

// NMHDR  (x64 24 / x86 12 バイト)
typedef struct NMHDR {
    HWND hwndFrom;
    UINT_PTR idFrom;
    DWORD code;
} NMHDR;

// RECT  (x64 16 / x86 16 バイト)
typedef struct RECT {
    INT left;
    INT top;
    INT right;
    INT bottom;
} RECT;

// NMCUSTOMDRAW  (x64 80 / x86 48 バイト)
typedef struct NMCUSTOMDRAW {
    NMHDR hdr;
    NMCUSTOMDRAW_DRAW_STAGE dwDrawStage;
    HDC hdc;
    RECT rc;
    UINT_PTR dwItemSpec;
    NMCUSTOMDRAW_DRAW_STATE_FLAGS uItemState;
    LPARAM lItemlParam;
} NMCUSTOMDRAW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct NMHDR
{
    public IntPtr hwndFrom;
    public UIntPtr idFrom;
    public uint code;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RECT
{
    public int left;
    public int top;
    public int right;
    public int bottom;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct NMCUSTOMDRAW
{
    public NMHDR hdr;
    public uint dwDrawStage;
    public IntPtr hdc;
    public RECT rc;
    public UIntPtr dwItemSpec;
    public uint uItemState;
    public IntPtr lItemlParam;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure NMHDR
    Public hwndFrom As IntPtr
    Public idFrom As UIntPtr
    Public code As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RECT
    Public left As Integer
    Public top As Integer
    Public right As Integer
    Public bottom As Integer
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure NMCUSTOMDRAW
    Public hdr As NMHDR
    Public dwDrawStage As UInteger
    Public hdc As IntPtr
    Public rc As RECT
    Public dwItemSpec As UIntPtr
    Public uItemState As UInteger
    Public lItemlParam As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class NMHDR(ctypes.Structure):
    _fields_ = [
        ("hwndFrom", ctypes.c_void_p),
        ("idFrom", ctypes.c_size_t),
        ("code", wintypes.DWORD),
    ]

class RECT(ctypes.Structure):
    _fields_ = [
        ("left", ctypes.c_int),
        ("top", ctypes.c_int),
        ("right", ctypes.c_int),
        ("bottom", ctypes.c_int),
    ]

class NMCUSTOMDRAW(ctypes.Structure):
    _fields_ = [
        ("hdr", NMHDR),
        ("dwDrawStage", wintypes.DWORD),
        ("hdc", ctypes.c_void_p),
        ("rc", RECT),
        ("dwItemSpec", ctypes.c_size_t),
        ("uItemState", wintypes.DWORD),
        ("lItemlParam", ctypes.c_ssize_t),
    ]
#[repr(C)]
pub struct NMHDR {
    pub hwndFrom: *mut core::ffi::c_void,
    pub idFrom: usize,
    pub code: u32,
}

#[repr(C)]
pub struct RECT {
    pub left: i32,
    pub top: i32,
    pub right: i32,
    pub bottom: i32,
}

#[repr(C)]
pub struct NMCUSTOMDRAW {
    pub hdr: NMHDR,
    pub dwDrawStage: u32,
    pub hdc: *mut core::ffi::c_void,
    pub rc: RECT,
    pub dwItemSpec: usize,
    pub uItemState: u32,
    pub lItemlParam: isize,
}
import "golang.org/x/sys/windows"

type NMHDR struct {
	hwndFrom uintptr
	idFrom uintptr
	code uint32
}

type RECT struct {
	left int32
	top int32
	right int32
	bottom int32
}

type NMCUSTOMDRAW struct {
	hdr NMHDR
	dwDrawStage uint32
	hdc uintptr
	rc RECT
	dwItemSpec uintptr
	uItemState uint32
	lItemlParam uintptr
}
type
  NMHDR = record
    hwndFrom: Pointer;
    idFrom: NativeUInt;
    code: DWORD;
  end;

  RECT = record
    left: Integer;
    top: Integer;
    right: Integer;
    bottom: Integer;
  end;

  NMCUSTOMDRAW = record
    hdr: NMHDR;
    dwDrawStage: DWORD;
    hdc: Pointer;
    rc: RECT;
    dwItemSpec: NativeUInt;
    uItemState: DWORD;
    lItemlParam: NativeInt;
  end;
const NMHDR = extern struct {
    hwndFrom: ?*anyopaque,
    idFrom: usize,
    code: u32,
};

const RECT = extern struct {
    left: i32,
    top: i32,
    right: i32,
    bottom: i32,
};

const NMCUSTOMDRAW = extern struct {
    hdr: NMHDR,
    dwDrawStage: u32,
    hdc: ?*anyopaque,
    rc: RECT,
    dwItemSpec: usize,
    uItemState: u32,
    lItemlParam: isize,
};
type
  NMHDR {.bycopy.} = object
    hwndFrom: pointer
    idFrom: uint
    code: uint32

  RECT {.bycopy.} = object
    left: int32
    top: int32
    right: int32
    bottom: int32

  NMCUSTOMDRAW {.bycopy.} = object
    hdr: NMHDR
    dwDrawStage: uint32
    hdc: pointer
    rc: RECT
    dwItemSpec: uint
    uItemState: uint32
    lItemlParam: int
struct NMHDR
{
    void* hwndFrom;
    size_t idFrom;
    uint code;
}

struct RECT
{
    int left;
    int top;
    int right;
    int bottom;
}

struct NMCUSTOMDRAW
{
    NMHDR hdr;
    uint dwDrawStage;
    void* hdc;
    RECT rc;
    size_t dwItemSpec;
    uint uItemState;
    ptrdiff_t lItemlParam;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; NMCUSTOMDRAW サイズ: 48 バイト(x86)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; hdr : NMHDR (+0, 12byte)  varptr(st)+0 を基点に操作(12byte:入れ子/配列)
; dwDrawStage : NMCUSTOMDRAW_DRAW_STAGE (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; hdc : HDC (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; rc : RECT (+20, 16byte)  varptr(st)+20 を基点に操作(16byte:入れ子/配列)
; dwItemSpec : UINT_PTR (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; uItemState : NMCUSTOMDRAW_DRAW_STATE_FLAGS (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; lItemlParam : LPARAM (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; NMCUSTOMDRAW サイズ: 80 バイト(x64)
dim st, 20    ; 4byte整数×20(構造体サイズ 80 / 4 切り上げ)
; hdr : NMHDR (+0, 24byte)  varptr(st)+0 を基点に操作(24byte:入れ子/配列)
; dwDrawStage : NMCUSTOMDRAW_DRAW_STAGE (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; hdc : HDC (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; rc : RECT (+40, 16byte)  varptr(st)+40 を基点に操作(16byte:入れ子/配列)
; dwItemSpec : UINT_PTR (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; uItemState : NMCUSTOMDRAW_DRAW_STATE_FLAGS (+64, 4byte)  st.16 = 値  /  値 = st.16   (lpoke/lpeek も可)
; lItemlParam : LPARAM (+72, 8byte)  qpoke st,72,値 / qpeek(st,72)  ※IronHSPのみ。3.7/3.8は lpoke st,72,下位 : lpoke st,76,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global NMHDR
    #field intptr hwndFrom
    #field intptr idFrom
    #field int code
#endstruct

#defstruct global RECT
    #field int left
    #field int top
    #field int right
    #field int bottom
#endstruct

#defstruct global NMCUSTOMDRAW
    #field NMHDR hdr
    #field int dwDrawStage
    #field intptr hdc
    #field RECT rc
    #field intptr dwItemSpec
    #field int uItemState
    #field intptr lItemlParam
#endstruct

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