.. index:: pair: class; EE::Scene::KeyEvent
.. _doxid-class_e_e_1_1_scene_1_1_key_event:

class EE::Scene::KeyEvent
=========================

.. toctree::
	:hidden:

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <keyevent.hpp>
	
	class KeyEvent: public :ref:`EE::Scene::Event<doxid-class_e_e_1_1_scene_1_1_event>` {
	public:
		// construction
	
		:target:`KeyEvent<doxid-class_e_e_1_1_scene_1_1_key_event_1a2654912a76b4063d7ae42451b6545d23>`(:ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`* node, const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& eventNum, const :ref:`Keycode<doxid-namespace_e_e_1_1_window_1af4042921e3ebf55b5ec9635695610c87>`& keyCode, const :ref:`Scancode<doxid-namespace_e_e_1_1_window_1abcf1065882e172250ed43e932e271a4b>`& scancode, const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& chr, const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& mod);
		:target:`KeyEvent<doxid-class_e_e_1_1_scene_1_1_key_event_1a602e87ffc0ed5b529dcfd6a25fd8c58d>`(const KeyEvent& event);
		:target:`~KeyEvent<doxid-class_e_e_1_1_scene_1_1_key_event_1ab97d8d6a5bd1a8968640f40144477202>`();

		// methods
	
		const :ref:`Keycode<doxid-namespace_e_e_1_1_window_1af4042921e3ebf55b5ec9635695610c87>`& :target:`getKeyCode<doxid-class_e_e_1_1_scene_1_1_key_event_1ac0296667d6d61c6c7972df41ab0d23db>`() const;
		const :ref:`Scancode<doxid-namespace_e_e_1_1_window_1abcf1065882e172250ed43e932e271a4b>`& :target:`getScancode<doxid-class_e_e_1_1_scene_1_1_key_event_1a7a005259ea73d63ab96a4423ca97388e>`() const;
		const :ref:`String::StringBaseType<doxid-class_e_e_1_1_string_1a4a5e3117ce4641d9b888f5afac086790>`& :target:`getChar<doxid-class_e_e_1_1_scene_1_1_key_event_1a4e1093b59bbd67b16ff17415557a28d0>`() const;
		const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& :target:`getMod<doxid-class_e_e_1_1_scene_1_1_key_event_1ad3a0fbd8a7bc9a619152f790404813f0>`() const;
		:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`getSanitizedMod<doxid-class_e_e_1_1_scene_1_1_key_event_1aa666606eeb83bddccefed67d01286763>`() const;
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// enums
	
		enum :ref:`EventType<doxid-class_e_e_1_1_scene_1_1_event_1a230934826f432a3bb4b3694760b59b69>`;

		// methods
	
		:ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`* :ref:`getNode<doxid-class_e_e_1_1_scene_1_1_event_1a8422f5f2c68c7112fb5494aa8b8f3661>`() const;
		const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& :ref:`getType<doxid-class_e_e_1_1_scene_1_1_event_1aaf6d0aa5be00a7abeb1ff4edba940be7>`() const;
		const :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>`& :ref:`getCallbackId<doxid-class_e_e_1_1_scene_1_1_event_1a9be61e84da6c738c1a1cb5bab6826532>`() const;
		const :ref:`MouseEvent<doxid-class_e_e_1_1_scene_1_1_mouse_event>`* :ref:`asMouseEvent<doxid-class_e_e_1_1_scene_1_1_event_1ae13e499d0ec056e63ecd768f538587dd>`() const;
		const KeyEvent* :ref:`asKeyEvent<doxid-class_e_e_1_1_scene_1_1_event_1a5ede297448c186af4b64e502f62023ae>`() const;
		const :ref:`DropEvent<doxid-class_e_e_1_1_scene_1_1_drop_event>`* :ref:`asDropEvent<doxid-class_e_e_1_1_scene_1_1_event_1ad82377698557215ff67ac6ef01312c84>`() const;
		const :ref:`TextEvent<doxid-class_e_e_1_1_scene_1_1_text_event>`* :ref:`asTextEvent<doxid-class_e_e_1_1_scene_1_1_event_1a05ffa183d6115abf4162caf3c295599c>`() const;
		const :ref:`TextInputEvent<doxid-class_e_e_1_1_scene_1_1_text_input_event>`* :ref:`asTextInputEvent<doxid-class_e_e_1_1_scene_1_1_event_1ad32c81e5d2886797233e63bc90c8df6a>`() const;
		const :ref:`WindowEvent<doxid-class_e_e_1_1_scene_1_1_window_event>`* :ref:`asWindowEvent<doxid-class_e_e_1_1_scene_1_1_event_1a023c12afbeb7a9423063b3925d6c2a14>`() const;
		const :ref:`ItemValueEvent<doxid-class_e_e_1_1_scene_1_1_item_value_event>`* :ref:`asItemValueEvent<doxid-class_e_e_1_1_scene_1_1_event_1acc39c2e0f5bded5cb3c6e599d2340dae>`() const;
		const :ref:`RowCreatedEvent<doxid-class_e_e_1_1_scene_1_1_row_created_event>`* :ref:`asRowCreatedEvent<doxid-class_e_e_1_1_scene_1_1_event_1a2fdb8d691e333dc6b5e8b5b681f39a93>`() const;
		const :ref:`FocusEvent<doxid-class_e_e_1_1_scene_1_1_focus_event>`* :ref:`asFocusEvent<doxid-class_e_e_1_1_scene_1_1_event_1a765905e567fdd9918da130a0937e6bd6>`() const;

.. _details-class_e_e_1_1_scene_1_1_key_event:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Methods
-------

.. index:: pair: function; getSanitizedMod
.. _doxid-class_e_e_1_1_scene_1_1_key_event_1aa666606eeb83bddccefed67d01286763:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` getSanitizedMod() const

The modifier key mask only for CTRL ALT SHIFT and META (no caps, num, etc)