Win32 API 日本語リファレンス
ホーム › UI.Controls.RichEdit › IRichEditOleCallback

IRichEditOleCallback

COM
📘 Microsoft Learn (日本語) · English
IID00020d03-0000-0000-c000-000000000046継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IRichEditOleCallback インターフェイスは、リッチテキスト編集コントロールがクライアントから OLE 関連の情報を取得するために使用します。

メソッド 10

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

vtbl 3 HRESULT GetNewStorage(IStorage** lplpstg)

クリップボードから貼り付けられた、またはリッチテキスト形式 (RTF) ストリームから読み込まれた新しいオブジェクトのためのストレージを提供します。

lplpstgIStorage**out新しいオブジェクトのために作成された IStorage インターフェイスのアドレス。

戻り値

型: HRESULT

成功すると S_OK を返します。メソッドが失敗した場合は、次のいずれかの値を返すことがあります。

リターンコード 説明
E_INVALIDARG
 無効な引数が指定されました。
E_OUTOFMEMORY
 操作を実行するのに十分なメモリがありませんでした。

解説(Remarks)

このメソッドは、コンポーネントオブジェクトモデル (COM) オブジェクトのカット、コピー、貼り付け、ドラッグ、ドロップの各操作を可能にするために実装する必要があります。

vtbl 4 HRESULT GetInPlaceContext(IOleInPlaceFrame** lplpFrame, IOleInPlaceUIWindow** lplpDoc, OLEINPLACEFRAMEINFO* lpFrameInfo)

インプレースアクティベーションをサポートするために必要な、アプリケーションレベルおよびドキュメントレベルのインターフェイスと情報を提供します。

lplpFrameIOleInPlaceFrame**outリッチエディットコントロールのクライアントのフレームウィンドウを表す IOleInPlaceFrame インターフェイスのアドレス。参照カウントをインクリメントするには AddRef メソッドを使用します。リッチエディットコントロールは、このインターフェイスが不要になると解放します。
lplpDocIOleInPlaceUIWindow**outリッチエディットコントロールのクライアントのドキュメントウィンドウを表す IOleInPlaceUIWindow インターフェイスのアドレス。フレームウィンドウとドキュメントウィンドウが同じ場合は、インターフェイスを返す必要はありません。参照カウントをインクリメントするには AddRef メソッドを使用します。リッチエディットコントロールは、このインターフェイスが不要になると解放します。
lpFrameInfoOLEINPLACEFRAMEINFO*inoutアクセラレータ情報。

戻り値

型: HRESULT

成功すると S_OK を返します。メソッドが失敗した場合は、次の値を返すことがあります。

リターンコード 説明
E_INVALIDARG
 無効な引数が指定されました。
vtbl 5 HRESULT ShowContainerUI(BOOL fShow)

アプリケーションがコンテナー UI を表示するかどうかを示します。

fShowBOOLinコンテナー UI を表示するかどうかのフラグ。コンテナー UI を表示する場合は TRUE、表示しない場合は FALSE です。

戻り値

型: HRESULT

成功すると S_OK を返します。メソッドが失敗した場合は、次の値を返すことがあります。

リターンコード 説明
E_INVALIDARG
 無効な引数が指定されました。

解説(Remarks)

IRichEditOleCallback::ShowContainerUI メソッドは、IOleInPlaceSite インターフェイスの IOleInPlaceSite::OnUIActivate メソッドおよび IOleInPlaceSite::OnUIDeactivate メソッドから呼び出されます。

vtbl 6 HRESULT QueryInsertObject(GUID* lpclsid, IStorage* lpstg, INT cp)

オブジェクトを挿入すべきかどうかをアプリケーションに問い合わせます。このメンバーは、貼り付け時およびリッチテキスト形式 (RTF) の読み込み時に呼び出されます。

lpclsidGUID*inout挿入するオブジェクトのクラス識別子。
lpstgIStorage*inオブジェクトを格納しているストレージ。
cpINTinオブジェクトが挿入される文字位置。

戻り値

型: HRESULT

成功すると S_OK を返します。戻り値が S_OK でない場合、オブジェクトは挿入されていません。メソッドが失敗した場合は、次の値を返すことがあります。

リターンコード 説明
E_INVALIDARG
 無効な引数が指定されました。
vtbl 7 HRESULT DeleteObject(IOleObject* lpoleobj)

オブジェクトがリッチエディットコントロールから削除されようとしていることを通知します。このメンバーが呼び出された時点で、オブジェクトが必ずしも解放されるわけではありません。

lpoleobjIOleObject*in削除されようとしているオブジェクト。

戻り値

型: HRESULT

S_OK を返します。

vtbl 8 HRESULT QueryAcceptData(IDataObject* lpdataobj, WORD* lpcfFormat, RECO_FLAGS reco, BOOL fReally, HGLOBAL hMetaPict)

貼り付け操作またはドラッグイベントの際に、貼り付けまたはドラッグされたデータを受け入れるかどうかを決定します。

lpdataobjIDataObject*in貼り付けまたはドラッグされているデータオブジェクト。
lpcfFormatWORD*inout貼り付けまたはドロップ操作に使用されるクリップボード形式。lpcfFormat が指す値が 0 の場合は、利用可能な最適な形式が使用されます。コールバックが lpcfFormat が指す値を変更した場合、リッチエディットコントロールはその形式のみを使用し、その形式が利用できない場合は操作が失敗します。
recoRECO_FLAGSin

クリップボード操作フラグ。次のいずれかの値を指定できます。

値 意味
RECO_DROP
 ドロップ操作 (ドラッグアンドドロップ)。
RECO_PASTE
 クリップボードからの貼り付け。
fReallyBOOLinドラッグドロップが実際に行われているのか、それとも単なる問い合わせなのかを示します。0 以外の値は、貼り付けまたはドロップが実際に行われていることを示します。0 の値は、EM_CANPASTE の場合などのように、操作が単なる問い合わせであることを示します。
hMetaPictHGLOBALin形式を選択して貼り付け操作によってオブジェクトに DVASPECT_ICON が適用されている場合に、オブジェクトのアイコン表示を含むメタファイルへのハンドル。

戻り値

型: HRESULT

成功すると S_OK を返します。「解説」を参照してください。

解説(Remarks)

失敗した場合、リッチエディットコントロールはデータを拒否し、操作を終了します。それ以外の場合、コントロールは受け入れ可能な形式かどうかをデータ自身でチェックします。S_OK 以外の成功コードは、コールバックがデータ自身をチェックした (fReally が FALSE の場合)、またはデータ自身をインポートした (fReally が TRUE の場合) ことを意味します。アプリケーションが S_OK 以外の成功コードを返した場合、コントロールは編集コントロールの読み取り専用状態をチェックしません。

vtbl 9 HRESULT ContextSensitiveHelp(BOOL fEnterMode)

アプリケーションがコンテキスト依存ヘルプモードに移行するか、またはそのモードから抜けるかを示します。このメソッドは、IOleWindow::ContextSensitiveHelp で説明されている機能を実装する必要があります。

fEnterModeBOOLinTRUE の場合、アプリケーションはコンテキスト依存ヘルプモードに移行します。FALSE の場合、アプリケーションはコンテキスト依存ヘルプモードを終了します。

戻り値

型: HRESULT

成功すると S_OK を返します。メソッドが失敗した場合は、次の値になることがあります。

リターンコード 説明
E_INVALIDARG
 無効な引数が指定されました。
vtbl 10 HRESULT GetClipboardData(CHARRANGE* lpchrg, DWORD reco, IDataObject** lplpdataobj)

クライアントが独自のクリップボードオブジェクトを提供できるようにします。

lpchrgCHARRANGE*inoutクリップボードオブジェクトの範囲。
recoDWORDin

クリップボード操作フラグ。次のいずれかの値を指定できます。

値 意味
RECO_COPY
 クリップボードへのコピー。
RECO_CUT
 クリップボードへの切り取り。
lplpdataobjIDataObject**outlpchrg パラメーターで指定された範囲を表す IDataObject 実装のアドレスを受け取るポインター変数へのポインター。エラーが返された場合、lplpdataobj の値は無視されます。

戻り値

型: HRESULT

成功すると S_OK を返します。戻り値が E_NOTIMPL の場合、リッチエディットコントロールは独自のクリップボードオブジェクトを作成しました。戻り値が E_NOTIMPL 以外の失敗コードの場合、操作は失敗しています。

vtbl 11 HRESULT GetDragDropEffect(BOOL fDrag, MODIFIERKEYS_FLAGS grfKeyState, DROPEFFECT* pdwEffect)

クライアントがドロップ操作の効果を指定できるようにします。

fDragBOOLin問い合わせが IDropTarget::DragEnter または IDropTarget::DragOver に対するものである場合は TRUE。問い合わせが IDropTarget::Drop に対するものである場合は FALSE。
grfKeyStateMODIFIERKEYS_FLAGSinOLE で定義されているキー状態。
pdwEffectDROPEFFECT*inoutリッチエディットコントロールが使用する効果。fDrag が TRUE の場合、戻り時にその内容にはリッチエディットコントロールが許容する効果が設定されます。fDrag が FALSE の場合、戻り時にこの変数には使用する効果が設定されます。

戻り値

型: HRESULT

このメソッドは S_OK を返します。

vtbl 12 HRESULT GetContextMenu(RICH_EDIT_GET_CONTEXT_MENU_SEL_TYPE seltype, IOleObject* lpoleobj, CHARRANGE* lpchrg, HMENU* lphmenu)

右クリックイベント時に使用するコンテキストメニューをアプリケーションに問い合わせます。

seltypeRICH_EDIT_GET_CONTEXT_MENU_SEL_TYPEin

選択の種類。この値は新しい選択範囲の内容を指定し、次の値の 1 つ以上を指定できます。

値 意味
SEL_EMPTY
 選択範囲が空です。
SEL_TEXT
 テキスト。
SEL_OBJECT
 少なくとも 1 つの COM オブジェクト。
SEL_MULTICHAR
 2 文字以上のテキスト。
SEL_MULTIOBJECT
 2 つ以上の COM オブジェクト。
GCM_RIGHTMOUSEDROP
 右マウスボタンによるドラッグドロップ用のコンテキストメニューを生成すべきことを示します。lpoleobj パラメーターは、ドロップされるオブジェクトの IDataObject インターフェイスへのポインターです。
lpoleobjIOleObject*inインターフェイスへのポインター。seltype パラメーターに SEL_OBJECT フラグが含まれている場合、lpoleobj は最初に選択された COM オブジェクトの IOleObject インターフェイスへのポインターです。seltype に GCM_RIGHTMOUSEDROP フラグが含まれている場合、lpoleobj は IDataObject インターフェイスへのポインターです。それ以外の場合、lpoleobj は NULL です。インターフェイスポインターを保持する場合は、AddRef メソッドを呼び出してオブジェクトの参照カウントをインクリメントする必要があります。
lpchrgCHARRANGE*inout現在の選択範囲を含む CHARRANGE 構造体へのポインター。
lphmenuHMENU*inout使用するコンテキストメニューのハンドル。エラーが返された場合、このパラメーターは無視されます。リッチエディットコントロールはメニューの使用が終わるとそのメニューを破棄するため、クライアントは破棄すべきではありません。

戻り値

型: HRESULT

成功すると S_OK を返します。メソッドが失敗した場合は、次の値になることがあります。

リターンコード 説明
E_INVALIDARG
 無効な引数が指定されました。

解説(Remarks)

ユーザーがコンテキストウィンドウから項目を選択すると、WM_COMMAND メッセージがリッチエディットコントロールの親ウィンドウに送信されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IRichEditOleCallback "{00020D03-0000-0000-C000-000000000046}"
#usecom global IRichEditOleCallback IID_IRichEditOleCallback "{}"
#comfunc global IRichEditOleCallback_GetNewStorage         3 sptr
#comfunc global IRichEditOleCallback_GetInPlaceContext     4 sptr,sptr,var
#comfunc global IRichEditOleCallback_ShowContainerUI       5 int
#comfunc global IRichEditOleCallback_QueryInsertObject     6 var,sptr,int
#comfunc global IRichEditOleCallback_DeleteObject          7 sptr
#comfunc global IRichEditOleCallback_QueryAcceptData       8 sptr,var,int,int,sptr
#comfunc global IRichEditOleCallback_ContextSensitiveHelp  9 int
#comfunc global IRichEditOleCallback_GetClipboardData      10 var,int,sptr
#comfunc global IRichEditOleCallback_GetDragDropEffect     11 int,int,var
#comfunc global IRichEditOleCallback_GetContextMenu        12 int,sptr,var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。