DrawThemeBackground

関数

指定パーツと状態のテーマ背景を矩形に描画する。

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

シグネチャ

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

HRESULT DrawThemeBackground(
    HTHEME hTheme,
    HDC hdc,
    INT iPartId,
    INT iStateId,
    RECT* pRect,
    RECT* pClipRect   // optional
);

パラメーター

名前	型	方向	説明
hTheme	HTHEME	in	ウィンドウの指定されたテーマデータへのハンドル。HTHEME を作成するには OpenThemeData を使用します。
hdc	HDC	in	テーマで定義された背景イメージの描画に使用する HDC。
iPartId	INT	in	描画する部分を指定する int 型の値。Parts and States を参照してください。
iStateId	INT	in	描画する部分の状態を指定する int 型の値。Parts and States を参照してください。
pRect	RECT*	in	背景イメージを描画する矩形を論理座標で格納した RECT 構造体へのポインター。
pClipRect	RECT*	inoptional	クリッピング矩形を格納した RECT 構造体へのポインター。このパラメーターには NULL を指定できます。

戻り値の型: HRESULT

公式ドキュメント

指定したコントロール部分に対して、ビジュアルスタイルで定義された境界線と塗りつぶしを描画します。

戻り値

型: HRESULT

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

解説(Remarks)

描画操作は pRect で指定された矩形に収まるよう拡大縮小され、その矩形を超えることはありません。アプリケーションは pClipRect で指定された矩形の外側に描画しないようにしてください。

Examples

ウィンドウの背景イメージを描画するために DrawThemeBackground を呼び出す前に、IsThemeBackgroundPartiallyTransparent を呼び出すことができます。このメソッドは、部分的に透明な、またはアルファブレンドされた子コントロールの背後の背景を描画するために DrawThemeParentBackground を呼び出す必要があるかどうかを判定します。次の例で示します。

if (_hTheme)
{
  if (IsThemeBackgroundPartiallyTransparent(_hTheme, BP_PUSHBUTTON, _iStateId))
  {
    DrawThemeParentBackground(_hwnd, hdcPaint, prcPaint);
  }

  DrawThemeBackground(_hTheme,
                    hdcPaint,
                    BP_PUSHBUTTON,
                    _iStateId,
                    &rcClient,
                    prcPaint);
}

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

各言語での呼び出し定義

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

HRESULT DrawThemeBackground(
    HTHEME hTheme,
    HDC hdc,
    INT iPartId,
    INT iStateId,
    RECT* pRect,
    RECT* pClipRect   // optional
);

[DllImport("UXTHEME.dll", ExactSpelling = true)]
static extern int DrawThemeBackground(
    IntPtr hTheme,   // HTHEME
    IntPtr hdc,   // HDC
    int iPartId,   // INT
    int iStateId,   // INT
    IntPtr pRect,   // RECT*
    IntPtr pClipRect   // RECT* optional
);

<DllImport("UXTHEME.dll", ExactSpelling:=True)>
Public Shared Function DrawThemeBackground(
    hTheme As IntPtr,   ' HTHEME
    hdc As IntPtr,   ' HDC
    iPartId As Integer,   ' INT
    iStateId As Integer,   ' INT
    pRect As IntPtr,   ' RECT*
    pClipRect As IntPtr   ' RECT* optional
) As Integer
End Function

' hTheme : HTHEME
' hdc : HDC
' iPartId : INT
' iStateId : INT
' pRect : RECT*
' pClipRect : RECT* optional
Declare PtrSafe Function DrawThemeBackground Lib "uxtheme" ( _
    ByVal hTheme As LongPtr, _
    ByVal hdc As LongPtr, _
    ByVal iPartId As Long, _
    ByVal iStateId As Long, _
    ByVal pRect As LongPtr, _
    ByVal pClipRect As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DrawThemeBackground = ctypes.windll.uxtheme.DrawThemeBackground
DrawThemeBackground.restype = ctypes.c_int
DrawThemeBackground.argtypes = [
    ctypes.c_ssize_t,  # hTheme : HTHEME
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # iPartId : INT
    ctypes.c_int,  # iStateId : INT
    ctypes.c_void_p,  # pRect : RECT*
    ctypes.c_void_p,  # pClipRect : RECT* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
DrawThemeBackground = Fiddle::Function.new(
  lib['DrawThemeBackground'],
  [
    Fiddle::TYPE_INTPTR_T,  # hTheme : HTHEME
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_INT,  # iPartId : INT
    Fiddle::TYPE_INT,  # iStateId : INT
    Fiddle::TYPE_VOIDP,  # pRect : RECT*
    Fiddle::TYPE_VOIDP,  # pClipRect : RECT* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "uxtheme")]
extern "system" {
    fn DrawThemeBackground(
        hTheme: isize,  // HTHEME
        hdc: *mut core::ffi::c_void,  // HDC
        iPartId: i32,  // INT
        iStateId: i32,  // INT
        pRect: *mut RECT,  // RECT*
        pClipRect: *mut RECT  // RECT* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("UXTHEME.dll")]
public static extern int DrawThemeBackground(IntPtr hTheme, IntPtr hdc, int iPartId, int iStateId, IntPtr pRect, IntPtr pClipRect);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UXTHEME_DrawThemeBackground' -Namespace Win32 -PassThru
# $api::DrawThemeBackground(hTheme, hdc, iPartId, iStateId, pRect, pClipRect)

#uselib "UXTHEME.dll"
#func global DrawThemeBackground "DrawThemeBackground" sptr, sptr, sptr, sptr, sptr, sptr
; DrawThemeBackground hTheme, hdc, iPartId, iStateId, varptr(pRect), varptr(pClipRect)   ; 戻り値は stat
; hTheme : HTHEME -> "sptr"
; hdc : HDC -> "sptr"
; iPartId : INT -> "sptr"
; iStateId : INT -> "sptr"
; pRect : RECT* -> "sptr"
; pClipRect : RECT* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "UXTHEME.dll"
#cfunc global DrawThemeBackground "DrawThemeBackground" sptr, sptr, int, int, var, var
; res = DrawThemeBackground(hTheme, hdc, iPartId, iStateId, pRect, pClipRect)
; hTheme : HTHEME -> "sptr"
; hdc : HDC -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; pRect : RECT* -> "var"
; pClipRect : RECT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "UXTHEME.dll"
#cfunc global DrawThemeBackground "DrawThemeBackground" sptr, sptr, int, int, sptr, sptr
; res = DrawThemeBackground(hTheme, hdc, iPartId, iStateId, varptr(pRect), varptr(pClipRect))
; hTheme : HTHEME -> "sptr"
; hdc : HDC -> "sptr"
; iPartId : INT -> "int"
; iStateId : INT -> "int"
; pRect : RECT* -> "sptr"
; pClipRect : RECT* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。