CUIUpdateEvent Class

class CUIUpdateEvent: public CWinEventBase

This class encapsulates a Windows UIUpdate event. A UIUpdate event contains a UIUpdate identifier, a notification code, and possibly a handle to the control the generated the event. The WORD parameter contains the UIUpdate ID and notification code. The control handle is stored in the LONG parameter.

Defined in: UIUpdateEvent.h

Class Members

inline  CUIUpdateEvent(UINT nCommandID, IUIUpdateElement* pIUpdateElement = 0)

Construct a UIUpdate event from a command ID, notify code, and update element.

unsigned long m_ulRefCount

Reference count.

UINT m_nCommandID

Command ID to query.

IUIUpdateElement* m_pIUpdateElement

Pointer to the update element.

inline virtual bool  Dispatch(IQueryGuid* pIListener)

Dispatches the event to the given event listener.

inline virtual UINT  GetCommandID() const

Return the command ID.

inline virtual IUIUpdateElement*  GetUpdateElement() const

Return the update element.

inline virtual void  SetCommandID(const UINT nCommandID)

Set the UIUpdate ID.

inline virtual void  SetUpdateElement(IUIUpdateElement* pIUpdateElement)

Set the update element.

inline virtual ULONG STDMETHODCALLTYPE  AddRef()

Add a reference to this object.

inline virtual ULONG STDMETHODCALLTYPE  Release()

Release a reference to this object.