MyGUI  3.2.1
Public Member Functions | Data Fields | Protected Member Functions
MyGUI::WidgetInput Class Reference

#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

Definition at line 14 of file MyGUI_WidgetInput.cpp.

Definition at line 24 of file MyGUI_WidgetInput.cpp.


Member Function Documentation

Definition at line 112 of file MyGUI_WidgetInput.cpp.

Definition at line 118 of file MyGUI_WidgetInput.cpp.

Definition at line 130 of file MyGUI_WidgetInput.cpp.

Definition at line 100 of file MyGUI_WidgetInput.cpp.

Definition at line 106 of file MyGUI_WidgetInput.cpp.

Definition at line 88 of file MyGUI_WidgetInput.cpp.

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.

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.

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.

Definition at line 52 of file MyGUI_WidgetInput.cpp.

Definition at line 70 of file MyGUI_WidgetInput.cpp.

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

Definition at line 201 of file MyGUI_WidgetInput.cpp.

Definition at line 196 of file MyGUI_WidgetInput.cpp.

Get inherits mode flag

Definition at line 181 of file MyGUI_WidgetInput.cpp.

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.

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.

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.

Definition at line 191 of file MyGUI_WidgetInput.cpp.

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 
) [protected, virtual]

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

Definition at line 250 of file MyGUI_WidgetInput.cpp.

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

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

Definition at line 254 of file MyGUI_WidgetInput.cpp.

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

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

Definition at line 262 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onKeyLostFocus ( Widget _new) [protected, virtual]

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

Definition at line 242 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onKeySetFocus ( Widget _old) [protected, virtual]

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

Definition at line 246 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseButtonClick ( ) [protected, virtual]

Definition at line 234 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseButtonDoubleClick ( ) [protected, virtual]

Definition at line 238 of file MyGUI_WidgetInput.cpp.

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

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 
) [protected, virtual]

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) [protected, virtual]

Reimplemented in MyGUI::Window.

Definition at line 258 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseDrag ( int  _left,
int  _top,
MouseButton  _id 
) [protected, virtual]

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) [protected, virtual]

Reimplemented in MyGUI::Button.

Definition at line 206 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseMove ( int  _left,
int  _top 
) [protected, virtual]

Definition at line 218 of file MyGUI_WidgetInput.cpp.

void MyGUI::WidgetInput::onMouseSetFocus ( Widget _old) [protected, virtual]

Reimplemented in MyGUI::Button.

Definition at line 210 of file MyGUI_WidgetInput.cpp.

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

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.

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.

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

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

Parameters:
_senderwidget that called this event
_keycode
_charof pressed symbol (for multilanguage applications)

Definition at line 197 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_keycode

Definition at line 204 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_newwidget with keyboard focus or nullptr

Definition at line 182 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_oldwidget with keyboard focus or nullptr

Definition at line 189 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event

Definition at line 169 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event

Definition at line 175 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_left- pointer position
_top- pointer position
_idMouse button id

Definition at line 154 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_left- pointer position
_top- pointer position
_idMouse button id

Definition at line 163 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_left- pointer position
_top- pointer position

Definition at line 130 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_newwidget with mouse focus or nullptr

Definition at line 115 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_left- pointer position
_top- pointer position

Definition at line 138 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_oldwidget with mouse focus or nullptr

Definition at line 122 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_relrelative wheel position

Definition at line 145 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_focusIs widget got keyboard focus.

Definition at line 220 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_focusIs widget got mouse focus.

Definition at line 212 of file MyGUI_WidgetInput.h.

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

Parameters:
_senderwidget that called this event
_infoabout tooltip

Definition at line 227 of file MyGUI_WidgetInput.h.


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