#include <MyGUI_WidgetInput.h>

Inheritance diagram for MyGUI::WidgetInput:

Public Member Functions
	WidgetInput ()

virtual	~WidgetInput ()

void	setNeedToolTip (bool _value)

bool	getNeedToolTip () const

void	setPointer (const std::string &_value)

const std::string &	getPointer () const

void	setNeedKeyFocus (bool _value)

bool	getNeedKeyFocus () const

void	setNeedMouseFocus (bool _value)

bool	getNeedMouseFocus () const

void	setInheritsPick (bool _value)

bool	getInheritsPick () const

void	setMaskPick (const std::string &_filename)

void	setMaskPick (const MaskPickInfo &_info)

bool	isMaskPickInside (const IntPoint &_point, const IntCoord &_coord) const

bool	getRootMouseFocus () const

bool	getRootKeyFocus () const

void	_riseMouseLostFocus (Widget *_new)

void	_riseMouseSetFocus (Widget *_old)

void	_riseMouseDrag (int _left, int _top, MouseButton _id)

void	_riseMouseMove (int _left, int _top)

void	_riseMouseWheel (int _rel)

void	_riseMouseButtonPressed (int _left, int _top, MouseButton _id)

void	_riseMouseButtonReleased (int _left, int _top, MouseButton _id)

void	_riseMouseButtonClick ()

void	_riseMouseButtonDoubleClick ()

void	_riseKeyLostFocus (Widget *_new)

void	_riseKeySetFocus (Widget *_old)

void	_riseKeyButtonPressed (KeyCode _key, Char _char)

void	_riseKeyButtonReleased (KeyCode _key)

void	_riseMouseChangeRootFocus (bool _focus)

void	_riseKeyChangeRootFocus (bool _focus)

void	_setRootMouseFocus (bool _value)

void	_setRootKeyFocus (bool _value)

Data Fields
EventHandle_WidgetWidget	eventMouseLostFocus

EventHandle_WidgetWidget	eventMouseSetFocus

EventPairAddParameter < EventHandle_WidgetIntInt, EventHandle_WidgetIntIntButton >	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

Protected Member Functions
virtual void	onMouseLostFocus (Widget *_new)

virtual void	onMouseSetFocus (Widget *_old)

virtual void	onMouseDrag (int _left, int _top, MouseButton _id)

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 (Widget *_new)

virtual void	onKeySetFocus (Widget *_old)

virtual void	onKeyButtonPressed (KeyCode _key, Char _char)

virtual void	onKeyButtonReleased (KeyCode _key)

virtual void	onMouseChangeRootFocus (bool _focus)

virtual void	onKeyChangeRootFocus (bool _focus)

Detailed Description

Definition at line 59 of file MyGUI_WidgetInput.h.

Constructor & Destructor Documentation

MyGUI::WidgetInput::WidgetInput ( )

Definition at line 14 of file MyGUI_WidgetInput.cpp.

MyGUI::WidgetInput::~WidgetInput ( )

virtual

Definition at line 24 of file MyGUI_WidgetInput.cpp.

Member Function Documentation

void MyGUI::WidgetInput::_riseKeyButtonPressed	(	KeyCode	_key,
		Char	_char
	)

Definition at line 112 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseKeyButtonReleased ( KeyCode _key )

Definition at line 118 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseKeyChangeRootFocus ( bool _focus )

Definition at line 130 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseKeyLostFocus ( Widget * _new )

Definition at line 100 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseKeySetFocus ( Widget * _old )

Definition at line 106 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseButtonClick ( )

Definition at line 88 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseButtonDoubleClick ( )

Definition at line 94 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseButtonPressed	(	int	_left,
		int	_top,
		MouseButton	_id
	)

Definition at line 76 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseButtonReleased	(	int	_left,
		int	_top,
		MouseButton	_id
	)

Definition at line 82 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseChangeRootFocus ( bool _focus )

Definition at line 124 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseDrag	(	int	_left,
		int	_top,
		MouseButton	_id
	)

Definition at line 58 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseLostFocus ( Widget * _new )

Definition at line 46 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseMove	(	int	_left,
		int	_top
	)

Definition at line 64 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseSetFocus ( Widget * _old )

Definition at line 52 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_riseMouseWheel ( int _rel )

Definition at line 70 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_setRootKeyFocus ( bool _value )

Definition at line 201 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::_setRootMouseFocus ( bool _value )

Definition at line 196 of file MyGUI_WidgetInput.cpp.

bool MyGUI::WidgetInput::getInheritsPick ( ) const

Get inherits mode flag

Definition at line 181 of file MyGUI_WidgetInput.cpp.

bool MyGUI::WidgetInput::getNeedKeyFocus ( ) const

Is need key focus If disable this widget won't be reacting on keyboard at all.
Enabled (true) by default.

Definition at line 161 of file MyGUI_WidgetInput.cpp.

bool MyGUI::WidgetInput::getNeedMouseFocus ( ) const

Is need mouse focus If disable this widget won't be reacting on mouse at all.
Enabled (true) by default.

Definition at line 171 of file MyGUI_WidgetInput.cpp.

bool MyGUI::WidgetInput::getNeedToolTip ( ) const

Get need tool tip mode flag

Definition at line 141 of file MyGUI_WidgetInput.cpp.

const std::string & MyGUI::WidgetInput::getPointer ( ) const

Get mouse pointer name for this widget

Definition at line 151 of file MyGUI_WidgetInput.cpp.

bool MyGUI::WidgetInput::getRootKeyFocus ( ) const

Definition at line 191 of file MyGUI_WidgetInput.cpp.

bool MyGUI::WidgetInput::getRootMouseFocus ( ) const

Definition at line 186 of file MyGUI_WidgetInput.cpp.

bool MyGUI::WidgetInput::isMaskPickInside	(	const IntPoint &	_point,
		const IntCoord &	_coord
	)		const

Definition at line 41 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onKeyButtonPressed	(	KeyCode	_key,
		Char	_char
	)

protectedvirtual

Reimplemented in MyGUI::EditBox, MyGUI::ListBox, MyGUI::ItemBox, and MyGUI::ComboBox.

Definition at line 250 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onKeyButtonReleased ( KeyCode _key )

protectedvirtual

Reimplemented in MyGUI::ListBox, and MyGUI::ItemBox.

Definition at line 254 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onKeyChangeRootFocus ( bool _focus )

protectedvirtual

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

Definition at line 262 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onKeyLostFocus ( Widget * _new )

protectedvirtual

Reimplemented in MyGUI::EditBox, and MyGUI::ItemBox.

Definition at line 242 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onKeySetFocus ( Widget * _old )

protectedvirtual

Reimplemented in MyGUI::EditBox, and MyGUI::ItemBox.

Definition at line 246 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseButtonClick ( )

protectedvirtual

Definition at line 234 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseButtonDoubleClick ( )

protectedvirtual

Definition at line 238 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseButtonPressed	(	int	_left,
		int	_top,
		MouseButton	_id
	)

protectedvirtual

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

Definition at line 226 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseButtonReleased	(	int	_left,
		int	_top,
		MouseButton	_id
	)

protectedvirtual

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

Definition at line 230 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseChangeRootFocus ( bool _focus )

protectedvirtual

Reimplemented in MyGUI::Window.

Definition at line 258 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseDrag	(	int	_left,
		int	_top,
		MouseButton	_id
	)

protectedvirtual

Reimplemented in MyGUI::EditBox, MyGUI::ItemBox, MyGUI::Window, and MyGUI::DDContainer.

Definition at line 214 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseLostFocus ( Widget * _new )

protectedvirtual

Reimplemented in MyGUI::Button.

Definition at line 206 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseMove	(	int	_left,
		int	_top
	)

protectedvirtual

Definition at line 218 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseSetFocus ( Widget * _old )

protectedvirtual

Reimplemented in MyGUI::Button.

Definition at line 210 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseWheel ( int _rel )

protectedvirtual

Reimplemented in MyGUI::ListBox, MyGUI::ItemBox, and MyGUI::ScrollBar.

Definition at line 222 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::setInheritsPick ( bool _value )

Set inherits mode flag This mode makes all child widgets pickable even if widget don't need mouse focus (was set setNeedKeyFocus(false) ).
Disabled (false) by default.

Definition at line 176 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::setMaskPick ( const std::string & _filename )

Set picking mask for widget

Definition at line 28 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::setMaskPick ( const MaskPickInfo & _info )

Set picking mask for widget

Definition at line 36 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::setNeedKeyFocus ( bool _value )

Set need key focus flag

Definition at line 156 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::setNeedMouseFocus ( bool _value )

Set need mouse focus flag

Definition at line 166 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::setNeedToolTip ( bool _value )

Set need tool tip mode flag. Enable this if you need tool tip events for widget

Definition at line 136 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::setPointer ( const std::string & _value )

Set mouse pointer for this widget

Definition at line 146 of file MyGUI_WidgetInput.cpp.

Field Documentation

EventHandle_WidgetKeyCodeChar MyGUI::WidgetInput::eventKeyButtonPressed

Event : Key pressed.
signature : void method(MyGUI::Widget* _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 197 of file MyGUI_WidgetInput.h.

EventHandle_WidgetKeyCode MyGUI::WidgetInput::eventKeyButtonReleased

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

Parameters

_sender	widget that called this event
_key	code

Definition at line 204 of file MyGUI_WidgetInput.h.

EventHandle_WidgetWidget MyGUI::WidgetInput::eventKeyLostFocus

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

Parameters

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

Definition at line 182 of file MyGUI_WidgetInput.h.

EventHandle_WidgetWidget MyGUI::WidgetInput::eventKeySetFocus

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

Parameters

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

Definition at line 189 of file MyGUI_WidgetInput.h.

EventHandle_WidgetVoid MyGUI::WidgetInput::eventMouseButtonClick

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

Parameters

_sender widget that called this event

Definition at line 169 of file MyGUI_WidgetInput.h.

EventHandle_WidgetVoid MyGUI::WidgetInput::eventMouseButtonDoubleClick

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

Parameters

_sender widget that called this event

Definition at line 175 of file MyGUI_WidgetInput.h.

EventHandle_WidgetIntIntButton MyGUI::WidgetInput::eventMouseButtonPressed

Event : Mouse button pressed.
signature : void method(MyGUI::Widget* _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 154 of file MyGUI_WidgetInput.h.

EventHandle_WidgetIntIntButton MyGUI::WidgetInput::eventMouseButtonReleased

Event : Mouse button released.
signature : void method(MyGUI::Widget* _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 163 of file MyGUI_WidgetInput.h.

EventPairAddParameter<EventHandle_WidgetIntInt, EventHandle_WidgetIntIntButton> MyGUI::WidgetInput::eventMouseDrag

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

Parameters

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

Definition at line 130 of file MyGUI_WidgetInput.h.

EventHandle_WidgetWidget MyGUI::WidgetInput::eventMouseLostFocus

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

Parameters

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

Definition at line 115 of file MyGUI_WidgetInput.h.

EventHandle_WidgetIntInt MyGUI::WidgetInput::eventMouseMove

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

Parameters

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

Definition at line 138 of file MyGUI_WidgetInput.h.

EventHandle_WidgetWidget MyGUI::WidgetInput::eventMouseSetFocus

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

Parameters

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

Definition at line 122 of file MyGUI_WidgetInput.h.

EventHandle_WidgetInt MyGUI::WidgetInput::eventMouseWheel

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

Parameters

_sender	widget that called this event
_rel	relative wheel position

Definition at line 145 of file MyGUI_WidgetInput.h.

EventHandle_WidgetBool MyGUI::WidgetInput::eventRootKeyChangeFocus

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

Parameters

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

Definition at line 220 of file MyGUI_WidgetInput.h.

EventHandle_WidgetBool MyGUI::WidgetInput::eventRootMouseChangeFocus

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

Parameters

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

Definition at line 212 of file MyGUI_WidgetInput.h.

EventHandle_WidgetToolTip MyGUI::WidgetInput::eventToolTip

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

Parameters

_sender	widget that called this event
_info	about tooltip

Definition at line 227 of file MyGUI_WidgetInput.h.

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

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation