ITfKeystrokeMgr Interface Reference

Inheritance diagram for ITfKeystrokeMgr:

Collaboration diagram for ITfKeystrokeMgr:

Public Member Functions
HRESULT	AdviseKeyEventSink ([in] TfClientId tid, [in] ITfKeyEventSink *pSink, [in] BOOL fForeground)
HRESULT	UnadviseKeyEventSink ([in] TfClientId tid)
HRESULT	GetForeground ([out] CLSID *pclsid)
HRESULT	TestKeyDown ([in] WPARAM wParam, [in] LPARAM lParam, [out] BOOL *pfEaten)
HRESULT	TestKeyUp ([in] WPARAM wParam, [in] LPARAM lParam, [out] BOOL *pfEaten)
HRESULT	KeyDown ([in] WPARAM wParam, [in] LPARAM lParam, [out] BOOL *pfEaten)
HRESULT	KeyUp ([in] WPARAM wParam, [in] LPARAM lParam, [out] BOOL *pfEaten)
HRESULT	GetPreservedKey ([in] ITfContext *pic, [in] const TF_PRESERVEDKEY *pprekey, [out] GUID *pguid)
HRESULT	IsPreservedKey ([in] REFGUID rguid, [in] const TF_PRESERVEDKEY *pprekey, [out] BOOL *pfRegistered)
HRESULT	PreserveKey ([in] TfClientId tid, [in] REFGUID rguid, [in] const TF_PRESERVEDKEY *prekey, [in, size_is(cchDesc)] const WCHAR *pchDesc, [in] ULONG cchDesc)
HRESULT	UnpreserveKey ([in] REFGUID rguid, [in] const TF_PRESERVEDKEY *pprekey)
HRESULT	SetPreservedKeyDescription ([in] REFGUID rguid, [in, size_is(cchDesc)] const WCHAR *pchDesc, [in] ULONG cchDesc)
HRESULT	GetPreservedKeyDescription ([in] REFGUID rguid, [out] BSTR *pbstrDesc)
HRESULT	SimulatePreservedKey ([in] ITfContext *pic, [in] REFGUID rguid, [out] BOOL *pfEaten)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Additional Inherited Members
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Detailed Description

Definition at line 1083 of file msctf.idl.

Member Function Documentation

AdviseKeyEventSink()

HRESULT ITfKeystrokeMgr::AdviseKeyEventSink	(	[in] TfClientId	tid,
		[in] ITfKeyEventSink *	pSink,
		[in] BOOL	fForeground
	)

GetForeground()

HRESULT ITfKeystrokeMgr::GetForeground

(

[out] CLSID *

pclsid

)

GetPreservedKey()

HRESULT ITfKeystrokeMgr::GetPreservedKey	(	[in] ITfContext *	pic,
		[in] const TF_PRESERVEDKEY *	pprekey,
		[out] GUID *	pguid
	)

GetPreservedKeyDescription()

HRESULT ITfKeystrokeMgr::GetPreservedKeyDescription	(	[in] REFGUID	rguid,
		[out] BSTR *	pbstrDesc
	)

IsPreservedKey()

HRESULT ITfKeystrokeMgr::IsPreservedKey	(	[in] REFGUID	rguid,
		[in] const TF_PRESERVEDKEY *	pprekey,
		[out] BOOL *	pfRegistered
	)

KeyDown()

HRESULT ITfKeystrokeMgr::KeyDown	(	[in] WPARAM	wParam,
		[in] LPARAM	lParam,
		[out] BOOL *	pfEaten
	)

KeyUp()

HRESULT ITfKeystrokeMgr::KeyUp	(	[in] WPARAM	wParam,
		[in] LPARAM	lParam,
		[out] BOOL *	pfEaten
	)

PreserveKey()

HRESULT ITfKeystrokeMgr::PreserveKey	(	[in] TfClientId	tid,
		[in] REFGUID	rguid,
		[in] const TF_PRESERVEDKEY *	prekey,
		[in, size_is(cchDesc)] const WCHAR *	pchDesc,
		[in] ULONG	cchDesc
	)

SetPreservedKeyDescription()

HRESULT ITfKeystrokeMgr::SetPreservedKeyDescription	(	[in] REFGUID	rguid,
		[in, size_is(cchDesc)] const WCHAR *	pchDesc,
		[in] ULONG	cchDesc
	)

SimulatePreservedKey()

HRESULT ITfKeystrokeMgr::SimulatePreservedKey	(	[in] ITfContext *	pic,
		[in] REFGUID	rguid,
		[out] BOOL *	pfEaten
	)

TestKeyDown()

HRESULT ITfKeystrokeMgr::TestKeyDown	(	[in] WPARAM	wParam,
		[in] LPARAM	lParam,
		[out] BOOL *	pfEaten
	)

TestKeyUp()

HRESULT ITfKeystrokeMgr::TestKeyUp	(	[in] WPARAM	wParam,
		[in] LPARAM	lParam,
		[out] BOOL *	pfEaten
	)

UnadviseKeyEventSink()

HRESULT ITfKeystrokeMgr::UnadviseKeyEventSink

(

[in] TfClientId

tid

)

UnpreserveKey()

HRESULT ITfKeystrokeMgr::UnpreserveKey	(	[in] REFGUID	rguid,
		[in] const TF_PRESERVEDKEY *	pprekey
	)

---

The documentation for this interface was generated from the following file:

• sdk/include/psdk/msctf.idl