.. index:: pair: class; EE::UI::UICommandShortcutBinding
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding:

template class EE::UI::UICommandShortcutBinding
===============================================

.. toctree::
	:hidden:

	struct_EE_UI_UICommandShortcutBinding_State.rst

Overview
~~~~~~~~

Scoped binding of a command to a shortcut consumed by :ref:`UISceneNode <doxid-class_e_e_1_1_u_i_1_1_u_i_scene_node>` or :ref:`UIWindow <doxid-class_e_e_1_1_u_i_1_1_u_i_window>`. :ref:`More...<details-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding>`


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

	#include <uicommand.hpp>
	
	template <typename Target>
	class UICommandShortcutBinding {
	public:
		// structs
	
		struct :ref:`State<doxid-struct_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1_1_state>`;

		// construction
	
		:target:`UICommandShortcutBinding<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1a1daaab16c741cc52adc24ec8317f9446>`();
		:ref:`UICommandShortcutBinding<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1ac678c992be6cfeeb8648c276651f88ea>`(:ref:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command>`& command, Target& target, const :ref:`KeyBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_key_bindings_1_1_shortcut>`& shortcut);
		:target:`UICommandShortcutBinding<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1a93cc5f8e30b89ace178724d461df7f6f>`(const UICommandShortcutBinding&);
		:target:`UICommandShortcutBinding<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1a0808589cc03e47503933e3cd86acdb5a>`(UICommandShortcutBinding&& other);
		:target:`~UICommandShortcutBinding<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1aa3e1f60396961a75344d56536a44be35>`();

		// methods
	
		UICommandShortcutBinding& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1a0f32ac892393b79de8dd0f58d938af4f>`(const UICommandShortcutBinding&);
		UICommandShortcutBinding& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1aed20bdc2ee872592a89de5affa099ddb>`(UICommandShortcutBinding&& other);
		void :ref:`disconnect<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1a3862f0354a6c834d6fec66c217daad45>`();
		:target:`operator bool<doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1a28c2a478d9966b2341163df99eeaaade>`() const;
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding:

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

Scoped binding of a command to a shortcut consumed by :ref:`UISceneNode <doxid-class_e_e_1_1_u_i_1_1_u_i_scene_node>` or :ref:`UIWindow <doxid-class_e_e_1_1_u_i_1_1_u_i_window>`.

The previous command mapped to the shortcut is restored when this binding disconnects. The generated command registration and shortcut are removed safely when the target closes first.

Construction
------------

.. index:: pair: function; UICommandShortcutBinding
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1ac678c992be6cfeeb8648c276651f88ea:

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

	UICommandShortcutBinding(:ref:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command>`& command, Target& target, const :ref:`KeyBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_key_bindings_1_1_shortcut>`& shortcut)

Registers ``shortcut`` on ``target`` as another endpoint for ``command``.

If the shortcut was already mapped, that mapping is restored when this binding disconnects.

Methods
-------

.. index:: pair: function; disconnect
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_shortcut_binding_1a3862f0354a6c834d6fec66c217daad45:

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

	void disconnect()

Removes this shortcut endpoint and restores any previous mapping.