IMenuItem

Interface for creating context menu entries. More...

#include <menu_intf.h>

Inheritance diagram for IMenuItem:

Public Member Functions
	ADTF_IID (IMenuItem, "menuitem.chewbacca.mixinlib.disptb.adtf.iid")
	Define an interface id for this class.
virtual tVoid	SetText (const tChar *strText)=0
	Set the text of this menu item.
virtual tVoid	SetToolTip (const tChar *strToolTip)=0
	Set the tool tip of this menu item.
virtual tVoid	SetStatusTip (const tChar *strStatusTip)=0
	Set the status bar tip of this menu item.
virtual const tChar *	GetText () const=0
	Get the text of this menu item.
virtual const tChar *	GetToolTip () const=0
	Get the tool tip of this menu item.
virtual const tChar *	GetStatusTip () const=0
	Get the status bar tip of this menu item.
virtual tVoid	SetSeparator (tBool bSeparator)=0
	Mark this item as a separator.
virtual tVoid	SetCheckable (tBool bCheckable)=0
	Mark this item as checkable.
virtual tVoid	SetChecked (tBool bChecked)=0
	Set chack state of this item.
virtual tVoid	SetEnabled (tBool bEnabled)=0
	Set enabled state of this item.
virtual tVoid	SetVisible (tBool bVisible)=0
	Set visibility of this item.
virtual tBool	IsCheckable () const=0
	Query whether the item is checkable.
virtual tBool	IsChecked () const=0
	Query whether the item is checked.
virtual tBool	IsEnabled () const=0
	Query whether the item is enabled.
virtual tBool	IsVisible () const=0
	Query whether the item is visible.
virtual tBool	IsSeparator () const=0
	Query whether the item is a separator.
virtual tVoid	SetEventHandler (IMenuEventSink *pEvent)=0
	Set an event handler.
virtual adtf::disptb::mixinlib::chewbacca::IMenuEventSink *	GetEventHandler ()=0
	Get the current event handler.

Detailed Description

Interface for creating context menu entries.

Bring newest version of the interface into scope.

Definition at line 42 of file menu_intf.h.

Member Function Documentation

GetEventHandler()

virtual adtf::disptb::mixinlib::chewbacca::IMenuEventSink * GetEventHandler ( )

pure virtual

Get the current event handler.

Returns

The event handler associated with the item.

GetStatusTip()

virtual const tChar * GetStatusTip ( ) const

pure virtual

Get the status bar tip of this menu item.

Returns

The status bar tip of the item.

GetText()

virtual const tChar * GetText ( ) const

pure virtual

Get the text of this menu item.

Returns

The text of the item.

GetToolTip()

virtual const tChar * GetToolTip ( ) const

pure virtual

Get the tool tip of this menu item.

Returns

The tool tip of the item.

IsCheckable()

virtual tBool IsCheckable ( ) const

pure virtual

Query whether the item is checkable.

Returns

Boolean indicating whether item is checkable.

IsChecked()

virtual tBool IsChecked ( ) const

pure virtual

Query whether the item is checked.

Returns

Boolean indicating whether item is checked.

IsEnabled()

virtual tBool IsEnabled ( ) const

pure virtual

Query whether the item is enabled.

Returns

Boolean indicating whether item is enabled.

IsSeparator()

virtual tBool IsSeparator ( ) const

pure virtual

Query whether the item is a separator.

Returns

Boolean indicating whether item is a seperator.

IsVisible()

virtual tBool IsVisible ( ) const

pure virtual

Query whether the item is visible.

Returns

Boolean indicating whether item is visible.

SetCheckable()

virtual tVoid SetCheckable ( tBool bCheckable )

pure virtual

Mark this item as checkable.

Parameters

bCheckable

[in] Indicator whether the item shall be checkable.

SetChecked()

virtual tVoid SetChecked ( tBool bChecked )

pure virtual

Set chack state of this item.

Parameters

bChecked

[in] Indicator whether the item shall be checked.

SetEnabled()

virtual tVoid SetEnabled ( tBool bEnabled )

pure virtual

Set enabled state of this item.

Parameters

bEnabled

[in] Indicator whether the item shall be enabled.

SetEventHandler()

virtual tVoid SetEventHandler ( IMenuEventSink * pEvent )

pure virtual

Set an event handler.

This handler will be called when the item is selected.

Parameters

pEvent

[in] The event handler to be set.

SetSeparator()

virtual tVoid SetSeparator ( tBool bSeparator )

pure virtual

Mark this item as a separator.

Parameters

bSeparator

[in] Indicator whether the item shall be a seperator.

SetStatusTip()

virtual tVoid SetStatusTip ( const tChar * strStatusTip )

pure virtual

Set the status bar tip of this menu item.

Parameters

strStatusTip

[in] The status bar tip to set.

SetText()

virtual tVoid SetText ( const tChar * strText )

pure virtual

Set the text of this menu item.

Parameters

strText

[in] The text to set.

SetToolTip()

virtual tVoid SetToolTip ( const tChar * strToolTip )

pure virtual

Set the tool tip of this menu item.

Parameters

strToolTip

[in] The tool tip to set.

SetVisible()

virtual tVoid SetVisible ( tBool bVisible )

pure virtual

Set visibility of this item.

Parameters

bVisible

[in] Indicator whether the item shall be visible.