Event Handlers for WidgetToolbar

Functions
void	SmartWin::WidgetToolbar::addButton (unsigned int id, int iconIndex, const SmartUtil::tstring &text, const SmartUtil::tstring &toolTip, bool checkButton, typename ThisMessageMap::itsVoidFunctionTakingUInt eventHandler)
	Adds a button to the toolbar.
void	SmartWin::WidgetToolbar::addButton (unsigned int id, int iconIndex, typename ThisMessageMap::itsVoidFunctionTakingUInt eventHandler)
	Adds a button to the toolbar.
void	SmartWin::WidgetToolbar::addButton (unsigned int id, int iconIndex, const SmartUtil::tstring &toolTip, typename ThisMessageMap::itsVoidFunctionTakingUInt eventHandler)
	Adds a button to the toolbar.
void	SmartWin::WidgetToolbar::addButton (unsigned int id, const SmartUtil::tstring &text, typename ThisMessageMap::itsVoidFunctionTakingUInt eventHandler)
	Adds a button to the toolbar.
void	SmartWin::WidgetToolbar::addButton (unsigned int id, const SmartUtil::tstring &text, const SmartUtil::tstring &toolTip, typename ThisMessageMap::itsVoidFunctionTakingUInt eventHandler)
	Adds a button to the Toolbar.

---

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 addButton	(	unsigned int	id,
		int	iconIndex,
		const SmartUtil::tstring &	text,
		const SmartUtil::tstring &	toolTip,
		bool	checkButton,
		typename ThisMessageMap::itsVoidFunctionTakingUInt	eventHandler
	)			[inherited]

Adds a button to the toolbar.

eventHandler is the event handler function that will be called when the button is clicked id is an identification number that will be passed into the event handler when somebody clicks your button.
The reason to why we have this "id" is because the same event handler can be defined for several buttons even in fact across toolbar objects, therefore this number should be unique across the application.
iconIndex is the ( zero indexed ) index of icon on the previously associated image list.
text is the text that will appear on your button.
toolTip is the tooltip that will be associated with your button ( when someone hoovers the mouse over your button )
Parameters passed expected by event handler is unsigned int which is the id of the toolbar button.
You must call setNormalImageList BEFORE setting event handlers with iconIndex's

void addButton	(	unsigned int	id,
		int	iconIndex,
		typename ThisMessageMap::itsVoidFunctionTakingUInt	eventHandler
	)			[inherited]

Adds a button to the toolbar.

eventHandler is the event handler function that will be called when the button is clicked id is an identification number that will be passed into the event handler when somebody clicks your button.
The reason to why we have this "id" is because the same event handler can be defined for several buttons even in fact across toolbar objects, therefore this number should be unique across the application.
iconIndex is the ( zero indexed ) index of icon on the previously associated image list.
Parameters passed expected by event handler is unsigned int which is the id of the toolbar button.
You must call setNormalImageList BEFORE setting event handlers with iconIndex's

void addButton	(	unsigned int	id,
		int	iconIndex,
		const SmartUtil::tstring &	toolTip,
		typename ThisMessageMap::itsVoidFunctionTakingUInt	eventHandler
	)			[inherited]

Adds a button to the toolbar.

eventHandler is the event handler function that will be called when the button is clicked id is an identification number that will be passed into the event handler when somebody clicks your button.
The reason to why we have this "id" is because the same event handler can be defined for several buttons even in fact across toolbar objects, therefore this number should be unique across the application.
toolTip is the tooltip that will be associated with your button ( when someone hoovers the mouse over your button )
iconIndex is the ( zero indexed ) index of icon on the previously associated image list.
Parameters passed expected by event handler is unsigned int which is the id of the toolbar button.
You must call setNormalImageList BEFORE setting event handlers with iconIndex's

void addButton	(	unsigned int	id,
		const SmartUtil::tstring &	text,
		typename ThisMessageMap::itsVoidFunctionTakingUInt	eventHandler
	)			[inherited]

Adds a button to the toolbar.

eventHandler is the event handler function that will be called when the button is clicked id is an identification number that will be passed into the event handler when somebody clicks your button.
The reason to why we have this "id" is because the same event handler can be defined for several buttons even in fact across toolbar objects, therefore this number should be unique across the application.
text is the text that will appear on your button.
Parameters passed expected by event handler is unsigned int which is the id of the toolbar button.

void addButton	(	unsigned int	id,
		const SmartUtil::tstring &	text,
		const SmartUtil::tstring &	toolTip,
		typename ThisMessageMap::itsVoidFunctionTakingUInt	eventHandler
	)			[inherited]

Adds a button to the Toolbar.

eventHandler is the event handler function that will be called when the button is clicked id is an identification number that will be passed into the event handler when somebody clicks your button.
The reason to why we have this "id" is because the same event handler can be defined for several buttons even in fact across toolbar objects, therefore this number should be unique across the application.
text is the text that will appear on your button.
toolTip is the tooltip that will be associated with your button ( when someone hoovers the mouse over your button )
Parameters passed expected by event handler is unsigned int which is the id of the toolbar button.

Back to SmartWin website