Event Handlers for WidgetMenu

Functions
void	SmartWin::WidgetMenu::appendCheckedItem (unsigned id, const SmartUtil::tstring &name, itsVoidMenuFunctionTakingUInt eventHandler)
	Appends a checked menu item.
void	SmartWin::WidgetMenu::appendItem (unsigned int id, const SmartUtil::tstring &name, itsVoidMenuFunctionTakingUInt eventHandler)
	Appends a "normal" menu item.

---

Detailed Description

General info on event handlers and events.
An event handler is a typesafe callback function defined by your application which will be "raised" or called whenever the specified event occurs.
E.g. if you define a WidgetWindow::onClosing event handler for a WidgetWindow widget your function will be called when your widget is being closed.
All event handlers are completely typesafe which means if you don't supply the right signature or try to set an event handler to a member of another class you will get a compile bug.
Also all events can be set to either a global/static member function or a member function of your derived WidgetWindow class, if you're setting an event handler to a global or static function you will recieve a pointer to the calling widget in the event handler (it will be expected to be part of the function signature) if you're setting an event handler to a member function of your class, this is not necessary off course since you will then be able to access the widget anyway. Also all Event Handlers handled by the "parent" Widget or another Widget then the Widget raising the event will demand passing the Widget pointer as the first parameter to the event handler function. Meaning a member version of an event for a WidgetButton taking an integer returning a bool will look like this; bool foo( WidgetButton * btn, int value ); and must be a member of the parent class. A global/static event handler for the same event if the class name is Bar will look like this; bool foo( Bar * bar, WidgetButton * btn, int value );

---

Function Documentation

void appendCheckedItem	(	unsigned	id,
		const SmartUtil::tstring &	name,
		itsVoidMenuFunctionTakingUInt	eventHandler
	)			[inherited]

Appends a checked menu item.

eventHandler is the function that will receive the "click" event from the menu item.
Event handler's signature must be "void foo( WidgetMenuPtr, unsigned int )" and it must be contained as a member
of the class that is defined as the EventHandlerClass, normally either the WidgetWindow derived class or the class derived from WidgetMenu.
See e.g. WidgetFun for an example.
The reason to why we have this "id" is because the same event handler can be defined for several menu items
even in fact across menu objects, therefore this number should be unique across the application.

void appendItem	(	unsigned int	id,
		const SmartUtil::tstring &	name,
		itsVoidMenuFunctionTakingUInt	eventHandler
	)			[inherited]

Appends a "normal" menu item.

eventHandler is the function that will receive the "click" event from the menu item.
Event handler's signature must be "void foo( WidgetMenuPtr, unsigned int )" and it must be contained as a member
of the class that is defined as the EventHandlerClass, normally either the WidgetWindow derived class or the class derived from WidgetMenu.
See e.g. WidgetFun for an example.
The reason to why we have this "id" is because the same event handler can be defined for several menu items
even in fact across menu objects, therefore this number should be unique across the application.

Back to SmartWin website