MyGUI::WidgetEvent Class Reference

#include <MyGUI_WidgetEvent.h>

Inheritance diagram for MyGUI::WidgetEvent:

Public Member Functions
virtual	~WidgetEvent ()
Data Fields
EventHandle_WidgetWidget	eventMouseLostFocus
EventHandle_WidgetWidget	eventMouseSetFocus
EventHandle_WidgetIntInt	eventMouseDrag
EventHandle_WidgetIntInt	eventMouseMove
EventHandle_WidgetInt	eventMouseWheel
EventHandle_WidgetIntIntButton	eventMouseButtonPressed
EventHandle_WidgetIntIntButton	eventMouseButtonReleased
EventHandle_WidgetVoid	eventMouseButtonClick
EventHandle_WidgetVoid	eventMouseButtonDoubleClick
EventHandle_WidgetWidget	eventKeyLostFocus
EventHandle_WidgetWidget	eventKeySetFocus
EventHandle_WidgetKeyCodeChar	eventKeyButtonPressed
EventHandle_WidgetKeyCode	eventKeyButtonReleased
EventHandle_WidgetBool	eventRootMouseChangeFocus
EventHandle_WidgetBool	eventRootKeyChangeFocus
EventHandle_WidgetToolTip	eventToolTip
EventHandle_WidgetStringString	eventActionInfo
EventHandle_WidgetRefWidgetRefSizeT	_requestGetContainer
Protected Member Functions
	WidgetEvent ()
virtual void	onMouseLostFocus (WidgetPtr _new)
virtual void	onMouseSetFocus (WidgetPtr _old)
virtual void	onMouseDrag (int _left, int _top)
virtual void	onMouseMove (int _left, int _top)
virtual void	onMouseWheel (int _rel)
virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)
virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void	onMouseButtonClick ()
virtual void	onMouseButtonDoubleClick ()
virtual void	onKeyLostFocus (WidgetPtr _new)
virtual void	onKeySetFocus (WidgetPtr _old)
virtual void	onKeyButtonPressed (KeyCode _key, Char _char)
virtual void	onKeyButtonReleased (KeyCode _key)
virtual void	onMouseChangeRootFocus (bool _focus)
virtual void	onKeyChangeRootFocus (bool _focus)
Protected Attributes
WidgetPtr	mWidgetEventSender
Friends
class	InputManager

Detailed Description

Definition at line 72 of file MyGUI_WidgetEvent.h.

Constructor & Destructor Documentation

virtual MyGUI::WidgetEvent::~WidgetEvent ( ) [inline, virtual]

Definition at line 77 of file MyGUI_WidgetEvent.h.

MyGUI::WidgetEvent::WidgetEvent ( ) [inline, protected]

Definition at line 80 of file MyGUI_WidgetEvent.h.

Member Function Documentation

virtual void MyGUI::WidgetEvent::onKeyButtonPressed	(	KeyCode	_key,
		Char	_char
	)			`[inline, protected, virtual]`

Reimplemented in MyGUI::ComboBox, MyGUI::Edit, MyGUI::List, and MyGUI::Message.

Definition at line 293 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onKeyButtonReleased ( KeyCode _key ) [inline, protected, virtual]

Definition at line 299 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onKeyChangeRootFocus ( bool _focus ) [inline, protected, virtual]

Reimplemented in MyGUI::MenuCtrl, and MyGUI::Window.

Definition at line 311 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onKeyLostFocus ( WidgetPtr _new ) [inline, protected, virtual]

Reimplemented in MyGUI::Edit, MyGUI::ItemBox, MyGUI::List, MyGUI::ListCtrl, and MyGUI::ScrollView.

Definition at line 281 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onKeySetFocus ( WidgetPtr _old ) [inline, protected, virtual]

Reimplemented in MyGUI::Edit, MyGUI::ItemBox, MyGUI::List, MyGUI::ListCtrl, and MyGUI::ScrollView.

Definition at line 287 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseButtonClick ( ) [inline, protected, virtual]

Definition at line 269 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseButtonDoubleClick ( ) [inline, protected, virtual]

Definition at line 275 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseButtonPressed	(	int	_left,
		int	_top,
		MouseButton	_id
	)			`[inline, protected, virtual]`

Reimplemented in MyGUI::Button, MyGUI::DDContainer, MyGUI::ItemBox, MyGUI::ListCtrl, and MyGUI::Window.

Definition at line 257 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseButtonReleased	(	int	_left,
		int	_top,
		MouseButton	_id
	)			`[inline, protected, virtual]`

Reimplemented in MyGUI::Button, MyGUI::DDContainer, MyGUI::ItemBox, and MyGUI::ListCtrl.

Definition at line 263 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseChangeRootFocus ( bool _focus ) [inline, protected, virtual]

Reimplemented in MyGUI::Window.

Definition at line 305 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseDrag	(	int	_left,
		int	_top
	)			`[inline, protected, virtual]`

Reimplemented in MyGUI::DDContainer, MyGUI::Edit, MyGUI::ItemBox, MyGUI::ListCtrl, and MyGUI::Window.

Definition at line 239 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseLostFocus ( WidgetPtr _new ) [inline, protected, virtual]

Reimplemented in MyGUI::Button.

Definition at line 227 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseMove	(	int	_left,
		int	_top
	)			`[inline, protected, virtual]`

Definition at line 245 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseSetFocus ( WidgetPtr _old ) [inline, protected, virtual]

Reimplemented in MyGUI::Button.

Definition at line 233 of file MyGUI_WidgetEvent.h.

virtual void MyGUI::WidgetEvent::onMouseWheel ( int _rel ) [inline, protected, virtual]

Reimplemented in MyGUI::ItemBox, MyGUI::List, MyGUI::ListCtrl, and MyGUI::VScroll.

Definition at line 251 of file MyGUI_WidgetEvent.h.

Friends And Related Function Documentation

friend class InputManager [friend]

Definition at line 74 of file MyGUI_WidgetEvent.h.

Field Documentation

EventHandle_WidgetRefWidgetRefSizeT MyGUI::WidgetEvent::_requestGetContainer

Event : Internal request for parent and item index, used for any widget.
signature : void method(MyGUI::WidgetPtr _sender, MyGUI::WidgetPtr& _container, size_t& _index);

Parameters:

	_sender	widget that called this event
	_container	parent
	_index	of container

Definition at line 222 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetStringString MyGUI::WidgetEvent::eventActionInfo

Event : Extendeble event for special cases or plugins.
signature : void method(MyGUI::WidgetPtr _sender, const std::string& _key, const std::string& _value);

Parameters:

	_sender	widget that called this event
	_key
	_value

Definition at line 214 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetKeyCodeChar MyGUI::WidgetEvent::eventKeyButtonPressed

Event : Key pressed.
signature : void method(MyGUI::WidgetPtr _sender, MyGUI::KeyCode _key, MyGUI::Char _char)

Parameters:

	_sender	widget that called this event
	_key	code
	_char	of pressed symbol (for multilanguage applications)

Definition at line 176 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetKeyCode MyGUI::WidgetEvent::eventKeyButtonReleased

Event : Key released.
signature : void method(MyGUI::WidgetPtr _sender, MyGUI::KeyCode _key)

Parameters:

	_sender	widget that called this event
	_key	code

Definition at line 183 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetWidget MyGUI::WidgetEvent::eventKeyLostFocus

Event : Widget lost keyboard focus.
signature : void method(MyGUI::WidgetPtr _sender, MyGUI::WidgetPtr _new)

Parameters:

	_sender	widget that called this event
	_new	widget with keyboard focus or nullptr

Definition at line 161 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetWidget MyGUI::WidgetEvent::eventKeySetFocus

Event : Widget got keyboard focus.
signature : void method(MyGUI::WidgetPtr _sender, MyGUI::WidgetPtr _old)

Parameters:

	_sender	widget that called this event
	_old	widget with keyboard focus or nullptr

Definition at line 168 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetVoid MyGUI::WidgetEvent::eventMouseButtonClick

Event : Mouse button pressed and released.
signature : void method(MyGUI::WidgetPtr _sender)

Parameters:

_sender

widget that called this event

Definition at line 148 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetVoid MyGUI::WidgetEvent::eventMouseButtonDoubleClick

Event : Mouse button double click.
signature : void method(MyGUI::WidgetPtr _sender)

Parameters:

_sender

widget that called this event

Definition at line 154 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetIntIntButton MyGUI::WidgetEvent::eventMouseButtonPressed

Event : Mouse button pressed.
signature : void method(MyGUI::WidgetPtr _sender, int _left, int _top, MyGUI::MouseButton _id)

Parameters:

	_sender	widget that called this event
	_left	- pointer position
	_top	- pointer position
	_id	Mouse button id

Definition at line 133 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetIntIntButton MyGUI::WidgetEvent::eventMouseButtonReleased

Event : Mouse button released.
signature : void method(MyGUI::WidgetPtr _sender, int _left, int _top, MyGUI::MouseButton _id)

Parameters:

	_sender	widget that called this event
	_left	- pointer position
	_top	- pointer position
	_id	Mouse button id

Definition at line 142 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetIntInt MyGUI::WidgetEvent::eventMouseDrag

Event : Widget mouse move with captured widget.
signature : void method(MyGUI::WidgetPtr _sender, int _left, int _top)

Parameters:

	_sender	widget that called this event
	_left	- pointer position
	_top	- pointer position

Definition at line 109 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetWidget MyGUI::WidgetEvent::eventMouseLostFocus

Event : Widget lost mouse focus.
signature : void method(MyGUI::WidgetPtr _sender, MyGUI::WidgetPtr _new)

Parameters:

	_sender	widget that called this event
	_new	widget with mouse focus or nullptr

Definition at line 94 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetIntInt MyGUI::WidgetEvent::eventMouseMove

Event : Mouse move over widget.
signature : void method(MyGUI::WidgetPtr _sender, int _left, int _top)

Parameters:

	_sender	widget that called this event
	_left	- pointer position
	_top	- pointer position

Definition at line 117 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetWidget MyGUI::WidgetEvent::eventMouseSetFocus

Event : Widget got mouse focus.
signature : void method(MyGUI::WidgetPtr _sender, MyGUI::WidgetPtr _old)

Parameters:

	_sender	widget that called this event
	_old	widget with mouse focus or nullptr

Definition at line 101 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetInt MyGUI::WidgetEvent::eventMouseWheel

Event : Mouse wheel over widget.
signature : void method(MyGUI::WidgetPtr _sender, int _rel)

Parameters:

	_sender	widget that called this event
	_rel	relative wheel position

Definition at line 124 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetBool MyGUI::WidgetEvent::eventRootKeyChangeFocus

Event : Root widget changed keyboard focus.
info : this event sends only to root widget
signature : void method(MyGUI::WidgetPtr _sender, bool _focus);

Parameters:

	_sender	widget that called this event
	_focus	Is widget got keyboard focus.

Definition at line 199 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetBool MyGUI::WidgetEvent::eventRootMouseChangeFocus

Event : Root widget changed mouse focus.
info : this event sends only to root widget
signature : void method(MyGUI::WidgetPtr _sender, bool _focus);

Parameters:

	_sender	widget that called this event
	_focus	Is widget got mouse focus.

Definition at line 191 of file MyGUI_WidgetEvent.h.

EventHandle_WidgetToolTip MyGUI::WidgetEvent::eventToolTip

Event : Event about changing tooltip state.
signature : void method(MyGUI::WidgetPtr _sender, const MyGUI::ToolTipInfo& _info);

Parameters:

	_sender	widget that called this event
	_info	about tooltip

Definition at line 206 of file MyGUI_WidgetEvent.h.

WidgetPtr MyGUI::WidgetEvent::mWidgetEventSender [protected]

Definition at line 317 of file MyGUI_WidgetEvent.h.

The documentation for this class was generated from the following file:

MyGUI_WidgetEvent.h

MyGUI::WidgetEvent Class Reference

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation