.. index:: pair: class; EE::UI::UICommandBindingSet
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set:

template class EE::UI::UICommandBindingSet
==========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Owns a command together with its primary widget and shortcut bindings. :ref:`More...<details-class_e_e_1_1_u_i_1_1_u_i_command_binding_set>`


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

	#include <uicommand.hpp>
	
	template <typename ShortcutTarget>
	class UICommandBindingSet {
	public:
		// construction
	
		:ref:`UICommandBindingSet<doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1ad83bf69baf81c236eae00155d1561783>`(std::function<void()> execute, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`& widget, ShortcutTarget& shortcutTarget, const :ref:`KeyBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_key_bindings_1_1_shortcut>`& shortcut);
	
		template <typename Source>
		:ref:`UICommandBindingSet<doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a830cb88e8dc033449c16623376d8a05a>`(std::function<void()> execute, Source& enabled, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`& widget, ShortcutTarget& shortcutTarget, const :ref:`KeyBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_key_bindings_1_1_shortcut>`& shortcut);
	
		:target:`UICommandBindingSet<doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a4477226ff866df5b74fa3b13a92ed144>`(const UICommandBindingSet&);
		:target:`UICommandBindingSet<doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a957cb0f5b57891537eddcc3a08bfbed1>`(UICommandBindingSet&&);

		// methods
	
		UICommandBindingSet& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a913a03b298e049fe4a8c4f3f4436c791>`(const UICommandBindingSet&);
		UICommandBindingSet& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a4916538dabf29ebe0263bc0b1a3d4145>`(UICommandBindingSet&&);
		:ref:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command>`& :ref:`command<doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a7c7588973dee22d8ca82175a71199e3c>`();
		const :ref:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command>`& :ref:`command<doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a0cf898288b1d1759a1114c033fc5f688>`() const;
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_command_binding_set:

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

Owns a command together with its primary widget and shortcut bindings.

This is the concise form for the common case where an action is exposed by one clickable widget and one default shortcut. Keep the returned object alive for as long as both bindings are needed.

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

.. index:: pair: function; UICommandBindingSet
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1ad83bf69baf81c236eae00155d1561783:

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

	UICommandBindingSet(std::function<void()> execute, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`& widget, ShortcutTarget& shortcutTarget, const :ref:`KeyBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_key_bindings_1_1_shortcut>`& shortcut)

Creates an always-enabled command with widget and shortcut endpoints.

.. index:: pair: function; UICommandBindingSet
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a830cb88e8dc033449c16623376d8a05a:

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

	template <typename Source>
	UICommandBindingSet(std::function<void()> execute, Source& enabled, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`& widget, ShortcutTarget& shortcutTarget, const :ref:`KeyBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_key_bindings_1_1_shortcut>`& shortcut)

Creates a command following ``enabled`` with widget and shortcut endpoints.

Methods
-------

.. index:: pair: function; command
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a7c7588973dee22d8ca82175a71199e3c:

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

	:ref:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command>`& command()



.. rubric:: Returns:

The owned command for explicit execution or additional endpoint bindings.

.. index:: pair: function; command
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_binding_set_1a0cf898288b1d1759a1114c033fc5f688:

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

	const :ref:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command>`& command() const



.. rubric:: Returns:

The owned command.