CTextEventSink Class Reference

#include <sinks.h>

Inheritance diagram for CTextEventSink:

Collaboration diagram for CTextEventSink:

Public Member Functions
	CTextEventSink (FN_ENDEDIT fnEndEdit, LPVOID pCallbackPV)
	@implemented
virtual	~CTextEventSink ()
	@implemented
HRESULT	_Advise (IUnknown *pUnknown, UINT uFlags)
	@implemented
HRESULT	_Unadvise ()
	@implemented
STDMETHODIMP	QueryInterface (REFIID riid, LPVOID *ppvObj) override
	@implemented
	STDMETHODIMP_ (ULONG) AddRef() override
	STDMETHODIMP_ (ULONG) Release() override
STDMETHODIMP	OnEndEdit (ITfContext *pic, TfEditCookie ecReadOnly, ITfEditRecord *pEditRecord) override
	@implemented
STDMETHODIMP	OnLayoutChange (ITfContext *pContext, TfLayoutCode lcode, ITfContextView *pContextView) override
	@implemented
HRESULT	OnEndEdit ([in] ITfContext *pic, [in] TfEditCookie ecReadOnly, [in] ITfEditRecord *pEditRecord)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Protected Attributes
LONG	m_cRefs
IUnknown *	m_pUnknown
DWORD	m_dwEditSinkCookie
DWORD	m_dwLayoutSinkCookie
union {
UINT   m_uFlags
FN_LAYOUTCHANGE   m_fnLayoutChange
};
FN_ENDEDIT	m_fnEndEdit
LPVOID	m_pCallbackPV

Additional Inherited Members
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Private Types inherited from ITfTextLayoutSink
enum	TfLayoutCode { TF_LC_CREATE = 0 , TF_LC_CHANGE = 1 , TF_LC_DESTROY = 2 }
Private Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
HRESULT	OnLayoutChange ([in] ITfContext *pic, [in] TfLayoutCode lcode, [in] ITfContextView *pView)
Private Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Detailed Description

Definition at line 48 of file sinks.h.

Constructor & Destructor Documentation

CTextEventSink()

CTextEventSink::CTextEventSink	(	FN_ENDEDIT	fnEndEdit,
		LPVOID	pCallbackPV
	)

@implemented

Definition at line 133 of file sinks.cpp.

{
    m_cRefs = 1;
    m_pUnknown = NULL;
    m_dwEditSinkCookie = (DWORD)-1;
    m_dwLayoutSinkCookie = (DWORD)-1;
    m_fnLayoutChange = NULL;
    m_fnEndEdit = fnEndEdit;
    m_pCallbackPV = pCallbackPV;
}

~CTextEventSink()

CTextEventSink::~CTextEventSink ( )

virtual

@implemented

Definition at line 145 of file sinks.cpp.

{
}

Member Function Documentation

_Advise()

HRESULT CTextEventSink::_Advise	(	IUnknown *	pUnknown,
		UINT	uFlags
	)

@implemented

Definition at line 215 of file sinks.cpp.

{
    m_pUnknown = NULL;
    m_uFlags = uFlags;
 
    ITfSource *pSource = NULL;
    HRESULT hr = pUnknown->QueryInterface(IID_ITfSource, (void**)&pSource);
    if (SUCCEEDED(hr))
    {
        ITfTextEditSink *pSink = static_cast<ITfTextEditSink*>(this);
        if (uFlags & 1)
            hr = pSource->AdviseSink(IID_ITfTextEditSink, pSink, &m_dwEditSinkCookie);
        if (SUCCEEDED(hr) && (uFlags & 2))
            hr = pSource->AdviseSink(IID_ITfTextLayoutSink, pSink, &m_dwLayoutSinkCookie);
 
        if (SUCCEEDED(hr))
        {
            m_pUnknown = pUnknown;
            pUnknown->AddRef();
        }
        else
        {
            pSource->UnadviseSink(m_dwEditSinkCookie);
        }
    }
 
    if (pSource)
        pSource->Release();
 
    return hr;
}

_Unadvise()

HRESULT CTextEventSink::_Unadvise

(

)

@implemented

Definition at line 248 of file sinks.cpp.

{
    if (!m_pUnknown)
        return E_FAIL;
 
    ITfSource *pSource = NULL;
    HRESULT hr = m_pUnknown->QueryInterface(IID_ITfSource, (void**)&pSource);
    if (SUCCEEDED(hr))
    {
        if (m_uFlags & 1)
            hr = pSource->UnadviseSink(m_dwEditSinkCookie);
        if (m_uFlags & 2)
            hr = pSource->UnadviseSink(m_dwLayoutSinkCookie);
 
        pSource->Release();
    }
 
    m_pUnknown->Release();
    m_pUnknown = NULL;
 
    return E_NOTIMPL;
}

Referenced by CicInputContext::DestroyInputContext().

OnEndEdit()

STDMETHODIMP CTextEventSink::OnEndEdit ( ITfContext *  pic, TfEditCookie  ecReadOnly, ITfEditRecord *  pEditRecord  )

override

@implemented

Implements ITfTextEditSink.

Definition at line 186 of file sinks.cpp.

{
    TEXT_EVENT_SINK_END_EDIT Data = { ecReadOnly, pEditRecord, pic };
    return m_fnEndEdit(1, m_pCallbackPV, (LPVOID)&Data);
}

OnLayoutChange()

STDMETHODIMP CTextEventSink::OnLayoutChange ( ITfContext *  pContext, TfLayoutCode  lcode, ITfContextView *  pContextView  )

override

@implemented

Implements ITfTextLayoutSink.

Definition at line 196 of file sinks.cpp.

{
    switch (lcode)
    {
        case TF_LC_CREATE:
            return m_fnLayoutChange(3, m_fnEndEdit, pContextView);
        case TF_LC_CHANGE:
            return m_fnLayoutChange(2, m_fnEndEdit, pContextView);
        case TF_LC_DESTROY:
            return m_fnLayoutChange(4, m_fnEndEdit, pContextView);
        default:
            return E_INVALIDARG;
    }
}

QueryInterface()

STDMETHODIMP CTextEventSink::QueryInterface ( REFIID  riid, LPVOID *  ppvObj  )

override

@implemented

Definition at line 150 of file sinks.cpp.

{
    static const QITAB c_tab[] =
    {
        QITABENT(CTextEventSink, ITfTextEditSink),
        QITABENT(CTextEventSink, ITfTextLayoutSink),
        { NULL }
    };
    return ::QISearch(this, c_tab, riid, ppvObj);
}

STDMETHODIMP_() [1/2]

CTextEventSink::STDMETHODIMP_ ( ULONG  )

override

STDMETHODIMP_() [2/2]

CTextEventSink::STDMETHODIMP_ ( ULONG  )

override

Member Data Documentation

union { ... } CTextEventSink::@291

m_cRefs

LONG CTextEventSink::m_cRefs

protected

Definition at line 51 of file sinks.h.

Referenced by CTextEventSink().

m_dwEditSinkCookie

DWORD CTextEventSink::m_dwEditSinkCookie

protected

Definition at line 53 of file sinks.h.

Referenced by _Advise(), _Unadvise(), and CTextEventSink().

m_dwLayoutSinkCookie

DWORD CTextEventSink::m_dwLayoutSinkCookie

protected

Definition at line 54 of file sinks.h.

Referenced by _Advise(), _Unadvise(), and CTextEventSink().

m_fnEndEdit

FN_ENDEDIT CTextEventSink::m_fnEndEdit

protected

Definition at line 60 of file sinks.h.

Referenced by CTextEventSink(), OnEndEdit(), and OnLayoutChange().

m_fnLayoutChange

FN_LAYOUTCHANGE CTextEventSink::m_fnLayoutChange

Definition at line 58 of file sinks.h.

Referenced by CTextEventSink(), and OnLayoutChange().

m_pCallbackPV

LPVOID CTextEventSink::m_pCallbackPV

protected

Definition at line 61 of file sinks.h.

Referenced by CTextEventSink(), and OnEndEdit().

m_pUnknown

IUnknown* CTextEventSink::m_pUnknown

protected

Definition at line 52 of file sinks.h.

Referenced by _Advise(), _Unadvise(), and CTextEventSink().

m_uFlags

UINT CTextEventSink::m_uFlags

Definition at line 57 of file sinks.h.

Referenced by _Advise(), and _Unadvise().

---

The documentation for this class was generated from the following files:

• dll/ime/msctfime/sinks.h
• dll/ime/msctfime/sinks.cpp