ホーム › UI.Controls › GetThemeBackgroundContentRect

GetThemeBackgroundContentRect

関数

テーマ背景の内側コンテンツ領域の矩形を取得する。

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

シグネチャ

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

HRESULT GetThemeBackgroundContentRect(
    HTHEME hTheme,
    HDC hdc,   // optional
    INT iPartId,
    INT iStateId,
    RECT* pBoundingRect,
    RECT* pContentRect
);

パラメーター

名前	型	方向	説明
hTheme	HTHEME	in	ウィンドウの指定されたテーマデータへのハンドルです。HTHEME を作成するには OpenThemeData を使用します。
hdc	HDC	inoptional	描画に使用する HDC です。このパラメーターには NULL を設定できます。
iPartId	INT	in	コンテンツ領域を含むパーツを指定する int 型の値です。Parts and States を参照してください。
iStateId	INT	in	コンテンツ領域を含むパーツの状態を指定する int 型の値です。Parts and States を参照してください。
pBoundingRect	RECT*	in	背景の全体の矩形を論理座標で含む RECT 構造体へのポインターです。これは境界線またはマージンの内側の領域です。
pContentRect	RECT*	out	コンテンツ領域の背景矩形を論理座標で受け取る RECT 構造体へのポインターです。この矩形はコンテンツ領域に収まるように計算されます。

戻り値の型: HRESULT

公式ドキュメント

ビジュアルスタイルで定義された背景のコンテンツ領域のサイズを取得します。

戻り値

Type: HRESULT

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

解説(Remarks)

ビジュアルスタイルでは、各背景イメージ内にコンテンツ領域を定義できます。これは、背景の境界線を上書きすることなくテキストやアイコンなどのコンテンツを配置できる領域です。

Examples

ウィンドウのクライアント領域全体にテーマを適用する場合、GetClientRect を呼び出してこの領域を RECT で取得できます。これを次の例のように、ポインター経由で pContentRect パラメーターとして GetThemeBackgroundContentRect に渡すことができます。

DWORD resultFlags = GetThemeAppProperties();
bool ctrlsAreThemed = ((resultFlags & STAP_ALLOW_CONTROLS) != 0);

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

各言語での呼び出し定義

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

HRESULT GetThemeBackgroundContentRect(
    HTHEME hTheme,
    HDC hdc,   // optional
    INT iPartId,
    INT iStateId,
    RECT* pBoundingRect,
    RECT* pContentRect
);

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

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

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

import ctypes
from ctypes import wintypes

GetThemeBackgroundContentRect = ctypes.windll.uxtheme.GetThemeBackgroundContentRect
GetThemeBackgroundContentRect.restype = ctypes.c_int
GetThemeBackgroundContentRect.argtypes = [
    ctypes.c_ssize_t,  # hTheme : HTHEME
    wintypes.HANDLE,  # hdc : HDC optional
    ctypes.c_int,  # iPartId : INT
    ctypes.c_int,  # iStateId : INT
    ctypes.c_void_p,  # pBoundingRect : RECT*
    ctypes.c_void_p,  # pContentRect : RECT* out
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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