ホーム › UI.Controls › HitTestThemeBackground

HitTestThemeBackground

関数

テーマ背景に対する指定座標のヒットテストを行いコードを返す。

DLLUXTHEME.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// UXTHEME.dll
#include <windows.h>

HRESULT HitTestThemeBackground(
    HTHEME hTheme,
    HDC hdc,   // optional
    INT iPartId,
    INT iStateId,
    HIT_TEST_BACKGROUND_OPTIONS dwOptions,
    RECT* pRect,
    HRGN hrgn,   // optional
    POINT ptTest,
    WORD* pwHitTestCode
);

パラメーター

名前	型	方向	説明
hTheme	HTHEME	in	ウィンドウに指定されたテーマデータへのハンドル。HTHEME を作成するには OpenThemeData を使用します。
hdc	HDC	inoptional	描画時に使用する HDC。このパラメーターには NULL を設定できます。
iPartId	INT	in	パーツを指定する int 型の値。Parts and States を参照してください。
iStateId	INT	in	パーツの状態を指定する int 型の値。Parts and States を参照してください。
dwOptions	HIT_TEST_BACKGROUND_OPTIONS	in	ヒットテストオプションを指定する DWORD。オプションの一覧については Hit Test Options を参照してください。
pRect	RECT*	in	背景を囲む四角形を論理座標で格納する RECT 構造体へのポインター。
hrgn	HRGN	inoptional	ヒットテスト領域の境界を指定するために使用できるリージョンへのハンドル。このパラメーターには NULL を設定できます。
ptTest	POINT	in	点の座標を格納する POINT 構造体。
pwHitTestCode	WORD*	out	ptTest の点が pRect または hrgn で囲まれた背景領域内にあるかどうかを示すヒットテストコードを受け取る WORD。返される値の一覧については Hit Test Return Values を参照してください。

戻り値の型: HRESULT

公式ドキュメント

ビジュアルスタイルで指定された背景内の点に対するヒットテストコードを取得します。

戻り値

型: HRESULT

この関数が成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ptTest と pRect の値は、クライアント座標やスクリーン座標など、同じ座標系で指定する必要があります。hrgn パラメーターを使用する場合は、pRect および ptTest と同じ座標系で指定する必要があります。

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

各言語での呼び出し定義

// UXTHEME.dll
#include <windows.h>

HRESULT HitTestThemeBackground(
    HTHEME hTheme,
    HDC hdc,   // optional
    INT iPartId,
    INT iStateId,
    HIT_TEST_BACKGROUND_OPTIONS dwOptions,
    RECT* pRect,
    HRGN hrgn,   // optional
    POINT ptTest,
    WORD* pwHitTestCode
);

[DllImport("UXTHEME.dll", ExactSpelling = true)]
static extern int HitTestThemeBackground(
    IntPtr hTheme,   // HTHEME
    IntPtr hdc,   // HDC optional
    int iPartId,   // INT
    int iStateId,   // INT
    uint dwOptions,   // HIT_TEST_BACKGROUND_OPTIONS
    IntPtr pRect,   // RECT*
    IntPtr hrgn,   // HRGN optional
    POINT ptTest,   // POINT
    out ushort pwHitTestCode   // WORD* out
);

<DllImport("UXTHEME.dll", ExactSpelling:=True)>
Public Shared Function HitTestThemeBackground(
    hTheme As IntPtr,   ' HTHEME
    hdc As IntPtr,   ' HDC optional
    iPartId As Integer,   ' INT
    iStateId As Integer,   ' INT
    dwOptions As UInteger,   ' HIT_TEST_BACKGROUND_OPTIONS
    pRect As IntPtr,   ' RECT*
    hrgn As IntPtr,   ' HRGN optional
    ptTest As POINT,   ' POINT
    <Out> ByRef pwHitTestCode As UShort   ' WORD* out
) As Integer
End Function

' hTheme : HTHEME
' hdc : HDC optional
' iPartId : INT
' iStateId : INT
' dwOptions : HIT_TEST_BACKGROUND_OPTIONS
' pRect : RECT*
' hrgn : HRGN optional
' ptTest : POINT
' pwHitTestCode : WORD* out
Declare PtrSafe Function HitTestThemeBackground Lib "uxtheme" ( _
    ByVal hTheme As LongPtr, _
    ByVal hdc As LongPtr, _
    ByVal iPartId As Long, _
    ByVal iStateId As Long, _
    ByVal dwOptions As Long, _
    ByVal pRect As LongPtr, _
    ByVal hrgn As LongPtr, _
    ByVal ptTest As LongPtr, _
    ByRef pwHitTestCode As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HitTestThemeBackground = ctypes.windll.uxtheme.HitTestThemeBackground
HitTestThemeBackground.restype = ctypes.c_int
HitTestThemeBackground.argtypes = [
    ctypes.c_ssize_t,  # hTheme : HTHEME
    wintypes.HANDLE,  # hdc : HDC optional
    ctypes.c_int,  # iPartId : INT
    ctypes.c_int,  # iStateId : INT
    wintypes.DWORD,  # dwOptions : HIT_TEST_BACKGROUND_OPTIONS
    ctypes.c_void_p,  # pRect : RECT*
    wintypes.HANDLE,  # hrgn : HRGN optional
    POINT,  # ptTest : POINT
    ctypes.POINTER(ctypes.c_ushort),  # pwHitTestCode : WORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
HitTestThemeBackground = Fiddle::Function.new(
  lib['HitTestThemeBackground'],
  [
    Fiddle::TYPE_INTPTR_T,  # hTheme : HTHEME
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_INT,  # iPartId : INT
    Fiddle::TYPE_INT,  # iStateId : INT
    -Fiddle::TYPE_INT,  # dwOptions : HIT_TEST_BACKGROUND_OPTIONS
    Fiddle::TYPE_VOIDP,  # pRect : RECT*
    Fiddle::TYPE_VOIDP,  # hrgn : HRGN optional
    Fiddle::TYPE_VOIDP,  # ptTest : POINT
    Fiddle::TYPE_VOIDP,  # pwHitTestCode : WORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "uxtheme")]
extern "system" {
    fn HitTestThemeBackground(
        hTheme: isize,  // HTHEME
        hdc: *mut core::ffi::c_void,  // HDC optional
        iPartId: i32,  // INT
        iStateId: i32,  // INT
        dwOptions: u32,  // HIT_TEST_BACKGROUND_OPTIONS
        pRect: *mut RECT,  // RECT*
        hrgn: *mut core::ffi::c_void,  // HRGN optional
        ptTest: POINT,  // POINT
        pwHitTestCode: *mut u16  // WORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("UXTHEME.dll")]
public static extern int HitTestThemeBackground(IntPtr hTheme, IntPtr hdc, int iPartId, int iStateId, uint dwOptions, IntPtr pRect, IntPtr hrgn, POINT ptTest, out ushort pwHitTestCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UXTHEME_HitTestThemeBackground' -Namespace Win32 -PassThru
# $api::HitTestThemeBackground(hTheme, hdc, iPartId, iStateId, dwOptions, pRect, hrgn, ptTest, pwHitTestCode)

#uselib "UXTHEME.dll"
#func global HitTestThemeBackground "HitTestThemeBackground" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; HitTestThemeBackground hTheme, hdc, iPartId, iStateId, dwOptions, varptr(pRect), hrgn, ptTest, varptr(pwHitTestCode)   ; 戻り値は stat
; hTheme : HTHEME -> "sptr"
; hdc : HDC optional -> "sptr"
; iPartId : INT -> "sptr"
; iStateId : INT -> "sptr"
; dwOptions : HIT_TEST_BACKGROUND_OPTIONS -> "sptr"
; pRect : RECT* -> "sptr"
; hrgn : HRGN optional -> "sptr"
; ptTest : POINT -> "sptr"
; pwHitTestCode : WORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "UXTHEME.dll"
#cfunc global HitTestThemeBackground "HitTestThemeBackground" sptr, sptr, int, int, int, var, sptr, int, var
; res = HitTestThemeBackground(hTheme, hdc, iPartId, iStateId, dwOptions, pRect, hrgn, ptTest, pwHitTestCode)
; hTheme : HTHEME -> "sptr"
; hdc : HDC optional -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; dwOptions : HIT_TEST_BACKGROUND_OPTIONS -> "int"
; pRect : RECT* -> "var"
; hrgn : HRGN optional -> "sptr"
; ptTest : POINT -> "int"
; pwHitTestCode : WORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "UXTHEME.dll"
#cfunc global HitTestThemeBackground "HitTestThemeBackground" sptr, sptr, int, int, int, sptr, sptr, int, sptr
; res = HitTestThemeBackground(hTheme, hdc, iPartId, iStateId, dwOptions, varptr(pRect), hrgn, ptTest, varptr(pwHitTestCode))
; hTheme : HTHEME -> "sptr"
; hdc : HDC optional -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; dwOptions : HIT_TEST_BACKGROUND_OPTIONS -> "int"
; pRect : RECT* -> "sptr"
; hrgn : HRGN optional -> "sptr"
; ptTest : POINT -> "int"
; pwHitTestCode : WORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。