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

IUICollectionChangedEvent

COM
📘 Microsoft Learn (日本語) · English
IID6502ae91-a14d-44b5-bbd0-62aacc581d52継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IUICollectionChangedEvent インターフェイスはアプリケーション側で実装され、実行時のコレクションの変更を処理するために必要なメソッドを定義します。

解説(Remarks)

Windows リボン フレームワークは、実行時にコレクション変更イベントをリッスンして処理するために、コネクタブル オブジェクトという標準的な Component Object Model (COM) のクライアント/サーバー機構を利用します。

リボンは、クライアント (リボン ホスト アプリケーション) 向けに受信側と送信側の両方の通知インターフェイスを定義する COM サーバーのコネクタブル オブジェクトとして機能します。受信側のインターフェイスはリボンが実装します。送信側のインターフェイスは、アプリケーションが作成する専用のオブジェクト (クライアント接続シンクと呼ばれます) 内でアプリケーションが実装します。このシンクは、コネクタブル オブジェクトとの接続を確立するために使用されます。

受信側と送信側のインターフェイスを定義することに加えて、リボンは IConnectionPointContainer インターフェイスを実装し、IConnectionPoint インターフェイスを実装してクライアント シンクとの接続を管理する接続ポイント オブジェクトを少なくとも 1 つ作成する必要があります。

メモ クライアントは、シンク オブジェクトの作成を試みる前に、コネクタブル オブジェクトに対して IConnectionPointContainer をクエリし、そのオブジェクトが接続可能かどうかを判断する必要があります。
リボンの場合、IUICollectionChangedEvent はフレームワークが定義し、アプリケーションが実装する送信側のインターフェイスです。リボンは、コレクションが変更されたとき (たとえば、クイック アクセス ツール バー (QAT) へのコマンドの追加など) に送信通知を発行し、クライアント内の IUICollectionChangedEvent::OnChanged イベントを発生させます。

メソッド 1

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

vtbl 3 HRESULT OnChanged(UI_COLLECTIONCHANGE action, DWORD oldIndex, IUnknown* oldItem, DWORD newIndex, IUnknown* newItem)

IUICollection が変更されたときに呼び出されます。

actionUI_COLLECTIONCHANGEinIUICollection に対して実行されたアクション。
oldIndexDWORDin削除または置換の場合は、古い項目のインデックス。それ以外の場合は UI_COLLECTION_INVALIDINDEX。
oldItemIUnknown*inoptional削除または置換の場合は、古い項目へのポインター。それ以外の場合は NULL。
newIndexDWORDin挿入、追加、または置換の場合は、新しい項目のインデックス。それ以外の場合は UI_COLLECTION_INVALIDINDEX。
newItemIUnknown*inoptional挿入、追加、または置換の場合は、新しい項目へのポインター。それ以外の場合は NULL。

戻り値

型: HRESULT

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

解説(Remarks)

IUICollectionChangedEvent::OnChanged インターフェイスは、リボン (コネクタブル オブジェクト) が発生させるコレクション変更イベントのリスナーとして、リボン ホスト アプリケーション (クライアント接続シンク) が実装します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUICollectionChangedEvent "{6502AE91-A14D-44B5-BBD0-62AACC581D52}"
#usecom global IUICollectionChangedEvent IID_IUICollectionChangedEvent "{}"
#comfunc global IUICollectionChangedEvent_OnChanged  3 int,int,sptr,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。