IRhRdkCommandUpdate Class Reference

#include <RhRdkContentEditorCustomButtonProvider.h>

Public Types
enum	Checks : unsigned int { Checks::Unchecked, Checks::Checked, Checks::Indeterminate }

Public Member Functions
virtual unsigned int	CommandId (void) const =0
virtual void *	EVF (const wchar_t *wszFunc, void *pvData)=0
virtual unsigned int	Position (void) const =0
virtual void	SetCheck (Checks c)=0
virtual void	SetEnable (bool bEnable=true)=0
virtual void	SetRadio (bool bOn=true)=0
virtual void	SetText (const wchar_t *wszText)=0

Protected Member Functions
virtual	~IRhRdkCommandUpdate ()

Detailed Description

This interface is used to update custom menu or tool bar UI elements. It is similar to the MFC CCmdUI object but does not need MFC to work.

Member Enumeration Documentation

Checks

enum IRhRdkCommandUpdate::Checks : unsigned int

strong

Enumerator
Unchecked
Checked
Indeterminate

Constructor & Destructor Documentation

~IRhRdkCommandUpdate()

virtual IRhRdkCommandUpdate::~IRhRdkCommandUpdate ( )

inlineprotectedvirtual

Member Function Documentation

CommandId()

virtual unsigned int IRhRdkCommandUpdate::CommandId ( void  ) const

pure virtual

Returns

the command id of the UI element.

EVF()

virtual void* IRhRdkCommandUpdate::EVF ( const wchar_t *  wszFunc, void *  pvData  )

pure virtual

Emergency virtual function for future expansion.

Position()

virtual unsigned int IRhRdkCommandUpdate::Position ( void  ) const

pure virtual

Returns

the UI element's position.

SetCheck()

virtual void IRhRdkCommandUpdate::SetCheck ( Checks  c )

pure virtual

Call this method to set the checked state of the UI item.

SetEnable()

virtual void IRhRdkCommandUpdate::SetEnable ( bool  bEnable = true )

pure virtual

Call this method to enable or disable the UI item.

SetRadio()

virtual void IRhRdkCommandUpdate::SetRadio ( bool  bOn = true )

pure virtual

Call this method to check or uncheck the UI item radio state.

SetText()

virtual void IRhRdkCommandUpdate::SetText ( const wchar_t *  wszText )

pure virtual

Call this method to set the text of the UI item.