.. index:: pair: class; EE::UI::MouseBindings
.. _doxid-class_e_e_1_1_u_i_1_1_mouse_bindings:

class EE::UI::MouseBindings
===========================

.. toctree::
	:hidden:

	struct_EE_UI_MouseBindings_Shortcut.rst
	struct_EE_UI_MouseBindings_ShortcutHash.rst

Overview
~~~~~~~~




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

	#include <mouseshortcut.hpp>
	
	class MouseBindings {
	public:
		// typedefs
	
		typedef std::unordered_map<:ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`, std::string, :ref:`ShortcutHash<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut_hash>`> :target:`ShortcutMap<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a269f7c9a520bc4fa2cfe1f100a3e8478>`;

		// structs
	
		struct :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`;
		struct :ref:`ShortcutHash<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut_hash>`;

		// methods
	
		static std::string :target:`mouseActionToString<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1aa57fab6a552c283c528634893dd9e945>`(:ref:`MouseAction<doxid-namespace_e_e_1_1_window_1a432fc64b7d7c0d1150516d221dd4cdfb>` action);
		static :ref:`MouseAction<doxid-namespace_e_e_1_1_window_1a432fc64b7d7c0d1150516d221dd4cdfb>` :target:`mouseActionFromString<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a0cf4b76bb64fa8aa1202ab810c9dfdd2>`(std::string_view action);
		static :ref:`MouseButtonsMask<doxid-namespace_e_e_1_1_window_1a1b545a326cc25ec4a77fce7f2793da89>` :target:`getMouseButtonsMask<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a37c0f30d3f88d36e2473e842695de539>`(const std::string& str);
		static std::string :target:`getMouseButtonsName<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a29c059426d72b5104d6979c3051beda5>`(:ref:`MouseButtonsMask<doxid-namespace_e_e_1_1_window_1a1b545a326cc25ec4a77fce7f2793da89>` mask);
		static :ref:`MouseBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>` :target:`sanitizeShortcut<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a0c7dd141f90fa44da5d646954b85662b>`(const :ref:`MouseBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`& shortcut);
		static std::string :target:`mousebindFormat<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a6a01dfd437bd960041a77c0337d177f2>`(std::string str);
		static :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>` :target:`toShortcut<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a31138ae2ca0abc76b6c64921e3650d5c>`(const std::string& keys);
		static std::string :target:`fromShortcut<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1ac6fc931fed2c59185cc92e4eb859034c>`(:ref:`MouseBindings::Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>` shortcut, bool format = false);
		void :target:`addMousebindsString<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1ab74913cdbcf7f4f39d64fc20a42de293>`(const std::unordered_map<std::string, std::string>& binds);
		void :target:`addMousebinds<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a8dda61593c10915cf6dfdcdfafbe154a>`(const :ref:`ShortcutMap<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a269f7c9a520bc4fa2cfe1f100a3e8478>`& binds);
		void :target:`addMousebindString<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a6d9a476ef79c20e7337a13c1d0782f58>`(const std::string& key, const std::string& command);
		void :target:`addMousebind<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a47187dd37e40e04554020136426eba55>`(const :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`& key, const std::string& command);
		void :ref:`replaceMousebindString<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a9f055e549a3fbeeff958db5a81ed9028>`(const std::string& keys, const std::string& command);
		void :ref:`replaceMousebind<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a77809de13f6e9289f2c14fe69695d4e4>`(const :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`& keys, const std::string& command);
		:ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>` :target:`getShortcutFromString<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a932b17ac89fc1ce04e6b5cc5690ee2c9>`(const std::string& keys);
		void :target:`removeMousebind<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a522d4ac44e7896839b78051cca7726b7>`(const :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`& keys);
		void :target:`removeMousebind<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a60fffa38452f68ab4629d881bb53af5d>`(const std::string& kb);
		bool :target:`existsMousebind<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a7f4a2f8db22f5401fcaf16a5bf630590>`(const :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`& keys);
		bool :target:`hasCommand<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a820359a0992c6d61372d8cee51b7743a>`(const std::string& command);
		void :target:`removeCommandMousebind<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a1ac1f018b24c1e9e210325abf8d58738>`(const std::string& command);
		void :target:`removeCommandsMousebind<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1af5dcfa4611b7b3df09adea57f4c88794>`(const std::vector<std::string>& command);
		std::string :target:`getCommandFromMousebind<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1ab75a308fa907cdd4194c239948599f03>`(const :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`& keys);
		std::string :target:`getCommandMousebindString<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a85f971492b93bcce43b13c5c77f5d10a>`(const std::string& command) const;
		void :target:`reset<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a49f27933741215a7dff876a41e0eb3dd>`();
		const :ref:`ShortcutMap<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a269f7c9a520bc4fa2cfe1f100a3e8478>`& :target:`getShortcutMap<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a47538b660d04f5d4f0ef7e05d2b4cc1b>`() const;
		const std::unordered_map<std::string, :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`>& :target:`getMousebindings<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a01f668fc29d7075a82903cd61ca0a645>`() const;
		:ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>` :target:`getShortcutFromCommand<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1ab91159584f77db33a5db1d0955ba4ea8>`(const std::string& cmd) const;
		std::string :target:`getShortcutString<doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1adac5f8c4d928d960aa18c22320f4babc>`(:ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>` shortcut, bool format = false) const;
	};
.. _details-class_e_e_1_1_u_i_1_1_mouse_bindings:

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



Methods
-------

.. index:: pair: function; replaceMousebindString
.. _doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a9f055e549a3fbeeff958db5a81ed9028:

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

	void replaceMousebindString(const std::string& keys, const std::string& command)

If the command is already on the list, it will remove the previous keybind.

.. index:: pair: function; replaceMousebind
.. _doxid-class_e_e_1_1_u_i_1_1_mouse_bindings_1a77809de13f6e9289f2c14fe69695d4e4:

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

	void replaceMousebind(const :ref:`Shortcut<doxid-struct_e_e_1_1_u_i_1_1_mouse_bindings_1_1_shortcut>`& keys, const std::string& command)

If the command is already on the list, it will remove the previous keybind.