.. index:: pair: class; EE::UI::UICommand
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command:

class EE::UI::UICommand
=======================

.. toctree::
	:hidden:

	struct_EE_UI_UICommand_SourceConnection.rst
	struct_EE_UI_UICommand_SourceConnectionBase.rst
	struct_EE_UI_UICommand_State.rst

Overview
~~~~~~~~

One action shared by :ref:`UI <doxid-namespace_e_e_1_1_u_i>` endpoints and keyboard shortcuts. :ref:`More...<details-class_e_e_1_1_u_i_1_1_u_i_command>`


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

	#include <uicommand.hpp>
	
	class UICommand {
	public:
		// structs
	
		template <typename Connection>
		struct :ref:`SourceConnection<doxid-struct_e_e_1_1_u_i_1_1_u_i_command_1_1_source_connection>`;
	
		struct :ref:`SourceConnectionBase<doxid-struct_e_e_1_1_u_i_1_1_u_i_command_1_1_source_connection_base>`;
		struct :ref:`State<doxid-struct_e_e_1_1_u_i_1_1_u_i_command_1_1_state>`;

		// construction
	
		:ref:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command_1a16f145373567ff14e3fc349e96ab564c>`(std::function<void()> execute);
	
		template <typename Source>
		:ref:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command_1a84c25f9e2a4d3ba33cb422f138bf475d>`(std::function<void()> execute, Source& enabled);
	
		:target:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command_1aebf857ae19aa96b2e3f0bd654bcd7368>`(const UICommand&);
		:target:`UICommand<doxid-class_e_e_1_1_u_i_1_1_u_i_command_1aadbb65a1249f76ab47f5ddbee4efdddb>`(UICommand&&);

		// methods
	
		UICommand& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_command_1a4122f3aa100494f46d439b70df6448d4>`(const UICommand&);
		UICommand& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_command_1a4d200951b7ba9074d0d752ce86421d5e>`(UICommand&&);
		bool :ref:`execute<doxid-class_e_e_1_1_u_i_1_1_u_i_command_1a8d84a96c0587e1883a06604806da1c21>`();
		:ref:`ObservableValue<doxid-class_e_e_1_1_observable_value>`<bool>& :ref:`enabled<doxid-class_e_e_1_1_u_i_1_1_u_i_command_1ac706b1fd99694d46bd67501a0fcbe912>`();
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_command:

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

One action shared by :ref:`UI <doxid-namespace_e_e_1_1_u_i>` endpoints and keyboard shortcuts.

.. ref-code-block:: cpp

	auto save = bindCommand(
	    [&] { saveDocument(); }, canSave, *saveButton, *uiScene,
	    { KEY_S, KeyMod::getDefaultModifier() } );

For a single button with no other representation, an ordinary onClick() callback remains the clearer choice.

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

.. index:: pair: function; UICommand
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_1a16f145373567ff14e3fc349e96ab564c:

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

	UICommand(std::function<void()> execute)

Creates an always-enabled command that invokes ``execute``.

.. index:: pair: function; UICommand
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_1a84c25f9e2a4d3ba33cb422f138bf475d:

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

	template <typename Source>
	UICommand(std::function<void()> execute, Source& enabled)

Creates a command whose enabled state follows ``enabled``.

The source must expose get() and observe() for bool values and must outlive the command if further enabled-state updates are expected.

Methods
-------

.. index:: pair: function; execute
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_1a8d84a96c0587e1883a06604806da1c21:

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

	bool execute()

Attempts to run the action.



.. rubric:: Returns:

true when it ran, or false when disabled or already executing.

.. index:: pair: function; enabled
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_command_1ac706b1fd99694d46bd67501a0fcbe912:

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

	:ref:`ObservableValue<doxid-class_e_e_1_1_observable_value>`<bool>& enabled()



.. rubric:: Returns:

Observable enabled state shared by every endpoint bound to this command.