ホーム › UI.Shell › IDockingWindowSite

IDockingWindowSite

COM

IID2a342fc2-7b26-11d0-8ca9-00a0c92dbfe8継承元IOleWindow自前メソッド開始 vtbl5

公式ドキュメント

1 つ以上の IDockingWindow オブジェクトのボーダー領域を管理するメソッドを公開します。このインターフェイスはブラウザーによって実装され、IOleInPlaceUIWindow インターフェイスに類似しています。

解説(Remarks)

IDockingWindowSite は IOleWindow から派生しています。この継承を通じて IDockingWindowSite でも利用できるこれらのメソッドの詳細については、以下のトピックを参照してください。

その他の IDockingWindowSite メソッド
IOleWindow::GetWindow
IOleWindow::ContextSensitiveHelp

実装するタイミング

通常、IDockingWindowSite インターフェイスを実装することはありません。シェルブラウザーは、ブラウザーフレーム内のドッキングされたウィンドウをサポートするためにこのインターフェイスを実装します。

使用するタイミング

ブラウザーフレーム内のドッキングウィンドウオブジェクトの領域を調整するために IDockingWindowSite を使用します。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 5 HRESULT GetBorderDW(IUnknown* punkObj, RECT* prcBorder)

指定した IDockingWindow オブジェクトに割り当てられているボーダー領域を取得します。

punkObj	IUnknown*	in	ボーダー領域が要求される対象の IDockingWindow オブジェクトへのポインター。
prcBorder	RECT*	out	このメソッドが正常に返ったときに、ブラウザーで利用可能なボーダー領域全体を受け取る構造体へのポインター。ドッキングウィンドウオブジェクトは、この情報を使用して自身を配置する場所を決定する必要があります。詳細については、IDockingWindow::ResizeBorderDW メソッドを参照してください。

戻り値

型: HRESULT

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

vtbl 6 HRESULT RequestBorderSpaceDW(IUnknown* punkObj, RECT* pbw)

IDockingWindow オブジェクトのボーダー領域に対する要求を承認、変更、または拒否します。ボーダー領域は、SetBorderSpaceDW メソッドが呼び出されるまで割り当てられません。

punkObj	IUnknown*	in	ボーダー領域が要求される対象の IDockingWindow オブジェクトへのポインター。
pbw	RECT*	in	BORDERWIDTHS 構造体へのポインター。このメソッドを呼び出す前に、構造体には希望するボーダー領域を設定しておく必要があります。メソッドが正常に返った後、構造体には承認されたボーダー領域が格納されます。IDockingWindowSite オブジェクトはこれらの値を変更する場合があります。ボーダー領域が重要な場合は、返されたボーダー領域が十分であるかどうかを判断するのは呼び出し側の責任です。

戻り値

型: HRESULT

ボーダー領域の要求が承認または変更された場合は S_OK を返します。それ以外の場合はエラー値を返します。

vtbl 7 HRESULT SetBorderSpaceDW(IUnknown* punkObj, RECT* pbw)

IDockingWindow オブジェクトのボーダー領域を割り当てて予約します。

punkObj	IUnknown*	in	ボーダー領域が設定される対象の IDockingWindow オブジェクトへのポインター。
pbw	RECT*	in	IDockingWindow オブジェクトのボーダー領域の座標を含む BORDERWIDTHS 構造体へのポインター。これらの座標で SetBorderSpaceDW を呼び出す前に、IDockingWindowSite::RequestBorderSpaceDW メソッドの呼び出しを成功させて、ボーダー領域を承認しておく必要があります。

戻り値

型: HRESULT

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

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IDockingWindowSite "{2A342FC2-7B26-11D0-8CA9-00A0C92DBFE8}"
#usecom global IDockingWindowSite IID_IDockingWindowSite "{}"
#comfunc global IDockingWindowSite_GetBorderDW           5 sptr,var
#comfunc global IDockingWindowSite_RequestBorderSpaceDW  6 sptr,var
#comfunc global IDockingWindowSite_SetBorderSpaceDW      7 sptr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IDockingWindowSite "{2A342FC2-7B26-11D0-8CA9-00A0C92DBFE8}"
#usecom global IDockingWindowSite IID_IDockingWindowSite "{}"
#comfunc global IDockingWindowSite_GetBorderDW           5 sptr,sptr
#comfunc global IDockingWindowSite_RequestBorderSpaceDW  6 sptr,sptr
#comfunc global IDockingWindowSite_SetBorderSpaceDW      7 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。