wxToolBoxEvent Class Reference

A toolbox event holds information about events associated with wxToolBox objects. More...

#include <wxToolBox.h>

List of all members.

Public Member Functions
wxEvent *	Clone (void) const
	Creates a clone of event object :).
wxToolBoxItem *	GetItem ()
	Returns toolbox item associated with event.
wxToolBoxTab *	GetTab ()
	Returns toolbox tab associated with event.
int	GetToolObjectIndex ()
	Returns index of tool object associated with event (used for handling.
int	GetToolObjectIndex1 ()
	Returns index of first tool object in wxEVT_TB_TABS_SWAPPED and wxEVT_TB_ITEMS_SWAPPED event handlers.
int	GetToolObjectIndex2 ()
	Returns index of second tool object in wxEVT_TB_TABS_SWAPPED and wxEVT_TB_ITEMS_SWAPPED event handlers.
void	SetItem (wxToolBoxItem *item)
	Associates toolbox item with event.
void	SetTab (wxToolBoxTab *tab)
	Associates toolbox tab with event.
void	SetToolObjectIndex (int value)
	Sets index of tool object associated with event (used for handling wxEVT_TB_TAB_DELETED and wxEVT_TB_ITEM_DELETED).
void	SetToolObjectIndex1 (int value)
	Sets index of first tool object in wxEVT_TB_TABS_SWAPPED and wxEVT_TB_ITEMS_SWAPPED event handlers.
void	SetToolObjectIndex2 (int value)
	Sets index of second tool object in wxEVT_TB_TABS_SWAPPED and wxEVT_TB_ITEMS_SWAPPED event handlers.
	wxToolBoxEvent (wxEventType commandType=0, int id=0)
	Default constructor.

---

Detailed Description

A toolbox event holds information about events associated with wxToolBox objects.

Event table macros
EVT_TB_TAB_ADDED(id, fn)	Process a wxEVT_TB_TAB_ADDED command, which is generated by a wxToolBox control when adding new tab.
EVT_TB_TAB_SELECTED(id, fn)	Process a wxEVT_TB_TAB_SELECTED command, which is generated by a wxToolBox control when selecting tab.
EVT_TB_TAB_DELETED(id, fn)	Process a wxEVT_TB_TAB_DELETED command, which is generated by a wxToolBox control when deleting tab.
EVT_TB_TABS_SWAPPED(id, fn)	Process a wxEVT_TB_TABS_SWAPPED command, which is generated by a wxToolBox control when swapping tabs.
EVT_TB_ITEM_ADDED(id, fn)	Process a wxEVT_TB_ITEM_ADDED command, which is generated by a wxToolBox control when adding new item.
EVT_TB_ITEM_SELECTED(id, fn)	Process a wxEVT_TB_ITEM_SELECTED command, which is generated by a wxToolBox control when selecting item.
EVT_TB_ITEM_DELETED(id, fn)	Process a wxEVT_TB_ITEM_DELETED command, which is generated by a wxToolBox control when deleting item.
EVT_TB_ITEMS_SWAPPED(id, fn)	Process a wxEVT_TB_ITEMS_SWAPPED command, which is generated by a wxToolBox control when swapping items.
EVT_TB_SKIN_LOADED(id, fn)	Process a wxEVT_TB_SKIN_LOADED command, which is generated by a wxToolBox control when loading skin.
EVT_TB_SKIN_SAVED(id, fn)	Process a wxEVT_TB_SKIN_SAVED command, which is generated by a wxToolBox control when saving skin.

---

Constructor & Destructor Documentation

wxToolBoxEvent::wxToolBoxEvent	(	wxEventType	commandType = 0,
		int	id = 0
	)

Default constructor.

Parameters:

	commandType	- event command type
	id	- component's identifier

---

Member Function Documentation

void wxToolBoxEvent::SetItem

(

wxToolBoxItem *

item

)

[inline]

Associates toolbox item with event.

Parameters:

item

- existing toolbox item

void wxToolBoxEvent::SetTab

(

wxToolBoxTab *

tab

)

[inline]

Associates toolbox tab with event.

Parameters:

tab

- existing toolbox tab

void wxToolBoxEvent::SetToolObjectIndex

(

int

value

)

[inline]

Sets index of tool object associated with event (used for handling wxEVT_TB_TAB_DELETED and wxEVT_TB_ITEM_DELETED).

Parameters:

value

- new tool object index

void wxToolBoxEvent::SetToolObjectIndex1

(

int

value

)

[inline]

Sets index of first tool object in wxEVT_TB_TABS_SWAPPED and wxEVT_TB_ITEMS_SWAPPED event handlers.

Parameters:

value

- new tool object index

void wxToolBoxEvent::SetToolObjectIndex2

(

int

value

)

[inline]

Sets index of second tool object in wxEVT_TB_TABS_SWAPPED and wxEVT_TB_ITEMS_SWAPPED event handlers.

Parameters:

value

- new tool object index

---