ITfContext Interface Reference

Inheritance diagram for ITfContext:

Collaboration diagram for ITfContext:

Classes
struct	TF_SELECTION
struct	TF_SELECTIONSTYLE

Public Types
enum	TfActiveSelEnd { TF_AE_NONE , TF_AE_START , TF_AE_END }
typedef struct ITfContext::TF_SELECTIONSTYLE	TF_SELECTIONSTYLE
typedef struct ITfContext::TF_SELECTION	TF_SELECTION
typedef TS_STATUS	TF_STATUS
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Public Member Functions
HRESULT	RequestEditSession ([in] TfClientId tid, [in] ITfEditSession *pes, [in] DWORD dwFlags, [out] HRESULT *phrSession)
HRESULT	InWriteSession ([in] TfClientId tid, [out] BOOL *pfWriteSession)
HRESULT	GetSelection ([in] TfEditCookie ec, [in] ULONG ulIndex, [in] ULONG ulCount, [out, size_is(ulCount), length_is(*pcFetched)] TF_SELECTION *pSelection, [out] ULONG *pcFetched)
HRESULT	SetSelection ([in] TfEditCookie ec, [in] ULONG ulCount, [in, size_is(ulCount)] const TF_SELECTION *pSelection)
HRESULT	GetStart ([in] TfEditCookie ec, [out] ITfRange **ppStart)
HRESULT	GetEnd ([in] TfEditCookie ec, [out] ITfRange **ppEnd)
HRESULT	GetActiveView ([out] ITfContextView **ppView)
HRESULT	EnumViews ([out] IEnumTfContextViews **ppEnum)
HRESULT	GetStatus ([out] TF_STATUS *pdcs)
HRESULT	GetProperty ([in] REFGUID guidProp, [out] ITfProperty **ppProp)
HRESULT	GetAppProperty ([in] REFGUID guidProp, [out] ITfReadOnlyProperty **ppProp)
HRESULT	TrackProperties ([in, size_is(cProp)] const GUID **prgProp, [in] ULONG cProp, [in, size_is(cAppProp)] const GUID **prgAppProp, [in] ULONG cAppProp, [out] ITfReadOnlyProperty **ppProperty)
HRESULT	EnumProperties ([out] IEnumTfProperties **ppEnum)
HRESULT	GetDocumentMgr ([out] ITfDocumentMgr **ppDm)
HRESULT	CreateRangeBackup ([in] TfEditCookie ec, [in] ITfRange *pRange, [out] ITfRangeBackup **ppBackup)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Public Attributes
const DWORD	TF_ES_ASYNCDONTCARE = 0x0
const DWORD	TF_ES_SYNC = 0x1
const DWORD	TF_ES_READ = 0x2
const DWORD	TF_ES_READWRITE = 0x6
const DWORD	TF_ES_ASYNC = 0x8
const ULONG	TF_DEFAULT_SELECTION = TS_DEFAULT_SELECTION
const DWORD	TF_SD_READONLY = TS_SD_READONLY
const DWORD	TF_SD_LOADING = TS_SD_LOADING
const DWORD	TF_SS_DISJOINTSEL = TS_SS_DISJOINTSEL
const DWORD	TF_SS_REGIONS = TS_SS_REGIONS
const DWORD	TF_SS_TRANSITORY = TS_SS_TRANSITORY

Detailed Description

Definition at line 409 of file msctf.idl.

Member Typedef Documentation

TF_SELECTION

typedef struct ITfContext::TF_SELECTION ITfContext::TF_SELECTION

TF_SELECTIONSTYLE

typedef struct ITfContext::TF_SELECTIONSTYLE ITfContext::TF_SELECTIONSTYLE

TF_STATUS

typedef TS_STATUS ITfContext::TF_STATUS

Definition at line 463 of file msctf.idl.

Member Enumeration Documentation

TfActiveSelEnd

enum ITfContext::TfActiveSelEnd

Enumerator
TF_AE_NONE
TF_AE_START
TF_AE_END

Definition at line 427 of file msctf.idl.

{ TF_AE_NONE, TF_AE_START, TF_AE_END } TfActiveSelEnd;

Member Function Documentation

CreateRangeBackup()

HRESULT ITfContext::CreateRangeBackup	(	[in] TfEditCookie	ec,
		[in] ITfRange *	pRange,
		[out] ITfRangeBackup **	ppBackup
	)

EnumProperties()

HRESULT ITfContext::EnumProperties

(

[out] IEnumTfProperties **

ppEnum

)

EnumViews()

HRESULT ITfContext::EnumViews

(

[out] IEnumTfContextViews **

ppEnum

)

GetActiveView()

HRESULT ITfContext::GetActiveView

(

[out] ITfContextView **

ppView

)

GetAppProperty()

HRESULT ITfContext::GetAppProperty	(	[in] REFGUID	guidProp,
		[out] ITfReadOnlyProperty **	ppProp
	)

GetDocumentMgr()

HRESULT ITfContext::GetDocumentMgr

(

[out] ITfDocumentMgr **

ppDm

)

GetEnd()

HRESULT ITfContext::GetEnd	(	[in] TfEditCookie	ec,
		[out] ITfRange **	ppEnd
	)

GetProperty()

HRESULT ITfContext::GetProperty	(	[in] REFGUID	guidProp,
		[out] ITfProperty **	ppProp
	)

GetSelection()

HRESULT ITfContext::GetSelection	(	[in] TfEditCookie	ec,
		[in] ULONG	ulIndex,
		[in] ULONG	ulCount,
		[out, size_is(ulCount), length_is(*pcFetched)] TF_SELECTION *	pSelection,
		[out] ULONG *	pcFetched
	)

GetStart()

HRESULT ITfContext::GetStart	(	[in] TfEditCookie	ec,
		[out] ITfRange **	ppStart
	)

GetStatus()

HRESULT ITfContext::GetStatus

(

[out] TF_STATUS *

pdcs

)

InWriteSession()

HRESULT ITfContext::InWriteSession	(	[in] TfClientId	tid,
		[out] BOOL *	pfWriteSession
	)

RequestEditSession()

HRESULT ITfContext::RequestEditSession	(	[in] TfClientId	tid,
		[in] ITfEditSession *	pes,
		[in] DWORD	dwFlags,
		[out] HRESULT *	phrSession
	)

SetSelection()

HRESULT ITfContext::SetSelection	(	[in] TfEditCookie	ec,
		[in] ULONG	ulCount,
		[in, size_is(ulCount)] const TF_SELECTION *	pSelection
	)

TrackProperties()

HRESULT ITfContext::TrackProperties	(	[in, size_is(cProp)] const GUID **	prgProp,
		[in] ULONG	cProp,
		[in, size_is(cAppProp)] const GUID **	prgAppProp,
		[in] ULONG	cAppProp,
		[out] ITfReadOnlyProperty **	ppProperty
	)

Member Data Documentation

TF_DEFAULT_SELECTION

const ULONG ITfContext::TF_DEFAULT_SELECTION = TS_DEFAULT_SELECTION

Definition at line 441 of file msctf.idl.

Referenced by CContext::GetSelection().

TF_ES_ASYNC

const DWORD ITfContext::TF_ES_ASYNC = 0x8

Definition at line 415 of file msctf.idl.

Referenced by CContext::RequestEditSession().

TF_ES_ASYNCDONTCARE

const DWORD ITfContext::TF_ES_ASYNCDONTCARE = 0x0

Definition at line 411 of file msctf.idl.

TF_ES_READ

const DWORD ITfContext::TF_ES_READ = 0x2

Definition at line 413 of file msctf.idl.

Referenced by CContext::CreateInstance(), and CContext::RequestEditSession().

TF_ES_READWRITE

const DWORD ITfContext::TF_ES_READWRITE = 0x6

Definition at line 414 of file msctf.idl.

Referenced by CContext::RequestEditSession().

TF_ES_SYNC

const DWORD ITfContext::TF_ES_SYNC = 0x1

Definition at line 412 of file msctf.idl.

TF_SD_LOADING

const DWORD ITfContext::TF_SD_LOADING = TS_SD_LOADING

Definition at line 465 of file msctf.idl.

TF_SD_READONLY

const DWORD ITfContext::TF_SD_READONLY = TS_SD_READONLY

Definition at line 464 of file msctf.idl.

TF_SS_DISJOINTSEL

const DWORD ITfContext::TF_SS_DISJOINTSEL = TS_SS_DISJOINTSEL

Definition at line 466 of file msctf.idl.

TF_SS_REGIONS

const DWORD ITfContext::TF_SS_REGIONS = TS_SS_REGIONS

Definition at line 467 of file msctf.idl.

TF_SS_TRANSITORY

const DWORD ITfContext::TF_SS_TRANSITORY = TS_SS_TRANSITORY

Definition at line 468 of file msctf.idl.

---

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

• sdk/include/psdk/msctf.idl