Allow configuring events that trigger Button:OnClick

Author: cschreib

include/lxgui/gui_button.hpp

@@ -27,16 +27,25 @@ class font_string;
  * case, the "normal" font is rendered with a slight offset that you
  * are free to define.
  *
- * Note that a button has frame::enable_mouse set to `true` by
+ * The button "click" event will be triggered by all registered combinations
+ * of mouse events configured with button::enable_button_clicks.
+ *
+ * Note that a button has frame::enable_mouse set to `true` and
+ * button::enable_button_clicks set to `true` for `"LeftMouseUp"` by
  * default.
  *
  * __Events.__ Hard-coded events available to all buttons, in
  * addition to those from frame:
  *
  * - `OnClick`: Triggered when the button is clicked, either when
- * button::click is called, or just when a mouse button is pressed
- * when the cursor is over the button.
- * - `OnDoubleClick`: Triggered when the button is double-clicked.
+ * button::click is called, or just when a mouse button is released or
+ * pressed when the cursor is over the button (depending on whether clicks
+ * are enabled for the mouse button and mouse button state, see
+ * button::enable_button_clicks). This event provides five arguments to
+ * the registered callback: a number identifying the mouse button, a number
+ * identifying the mouse button event, a string containing the human-readable
+ * name of this button event (e.g., `"LeftButtonUp"`, `"RightButtonDown"`, ...),
+ * and the mouse X and Y position.
  * - `OnEnable`: Triggered by button::enable.
  * - `OnDisable`: Triggered by button::disable.
  */
@@ -345,6 +354,99 @@ class button : public frame {
      */
     const vector2f& get_pushed_text_offset() const;
 
+    /**
+     * \brief Make this button generate OnClick events when a specific mouse event occurs over the button.
+     * \param mouse_event The mouse event for which to enable or disable OnClick events
+     * \param enable 'true' to enable, 'false' to disable
+     * \see enable_button_clicks()
+     * \see disable_button_clicks()
+     */
+    void set_button_clicks_enabled(const std::string& mouse_event, bool enable) {
+        if (enable) {
+            enable_button_clicks(mouse_event);
+        } else {
+            disable_button_clicks(mouse_event);
+        }
+    }
+
+    /**
+     * \brief Make this button generate OnClick events when a specific mouse event occurs over the button.
+     * \param button_id The mouse button for which to enable or disable OnClick events
+     * \param button_event The mouse button event for which to enable or disable OnClick events
+     * \param enable 'true' to enable, 'false' to disable
+     * \see enable_button_clicks()
+     * \see disable_button_clicks()
+     */
+    void set_button_clicks_enabled(
+        input::mouse_button button_id, input::mouse_button_event button_event, bool enable) {
+        if (enable) {
+            enable_button_clicks(button_id, button_event);
+        } else {
+            disable_button_clicks(button_id, button_event);
+        }
+    }
+
+    /**
+     * \brief Make this button generate OnClick events when a specific mouse event occurs over the button.
+     * \param mouse_event The mouse event for which to enable OnClick events
+     * \note The mouse event string must be of the form "<button>Up" or "<button>Down". For
+     * example, "LeftButtonUp".
+     * \see disable_button_clicks()
+     */
+    void enable_button_clicks(const std::string& mouse_event);
+
+    /**
+     * \brief Make this button generate OnClick events when a specific mouse event occurs over the button.
+     * \param button_id The mouse button for which to enable OnClick events
+     * \param button_event The mouse button event for which to enable OnClick events
+     * \note See @ref enable_button_clicks(const std::string&) for more information.
+     * \see disable_button_clicks()
+     */
+    void
+    enable_button_clicks(input::mouse_button button_id, input::mouse_button_event button_event);
+
+    /**
+     * \brief Stop this button from generating OnClick events when a specific mouse event occurs over the button.
+     * \param mouse_event The mouse event for which to stop generating OnClick events
+     * \see enable_button_clicks()
+     */
+    void disable_button_clicks(const std::string& mouse_event);
+
+    /**
+     * \brief Stop this button from generating OnClick events when a specific mouse event occurs over the button.
+     * \param button_id The mouse button for which to stop generating OnClick events
+     * \param button_event The state of the button for which to stop generating OnClick events
+     * \note See @ref disable_button_clicks(const std::string&) for more information.
+     * \see enable_button_clicks()
+     */
+    void
+    disable_button_clicks(input::mouse_button button_id, input::mouse_button_event button_event);
+
+    /**
+     * \brief Stop this button from generating OnClick events.
+     * \see enable_button_clicks()
+     * \see is_button_clicks_enabled()
+     */
+    void disable_button_clicks();
+
+    /**
+     * \brief Checks if this button can generate OnClick events when a specific mouse event occurs over the button.
+     * \param mouse_event The mouse event to check
+     * \return 'true' if this button can generate OnClick events from this mouse event
+     * \see enable_button_clicks()
+     */
+    bool is_button_clicks_enabled(const std::string& mouse_event) const;
+
+    /**
+     * \brief Checks if this button can generate OnClick events when a specific mouse event occurs over the button.
+     * \param button_id The mouse button for which to check
+     * \param button_event The mouse button event for which to check
+     * \return 'true' if this button can generate OnClick events from this mouse event
+     * \see enable_button_clicks()
+     */
+    bool is_button_clicks_enabled(
+        input::mouse_button button_id, input::mouse_button_event button_event) const;
+
     /// Registers this region class to the provided Lua state
     static void register_on_lua(sol::state& lua);
 
@@ -373,6 +475,8 @@ class button : public frame {
     utils::observer_ptr<font_string> current_font_string_ = nullptr;
 
     vector2f pushed_text_offset_ = vector2f::zero;
+
+    std::set<std::string> reg_click_list_;
 };
 
 } // namespace lxgui::gui

src/gui_button.cpp

@@ -16,6 +16,7 @@ button::button(utils::control_block& block, manager& mgr, const frame_core_attri
     initialize_(*this, attr);
 
     enable_mouse();
+    enable_button_clicks(input::mouse_button::left, input::mouse_button_event::up);
 }
 
 std::string button::serialize(const std::string& tab) const {
@@ -44,15 +45,35 @@ void button::fire_script(const std::string& script_name, const event_data& data)
                 release();
         }
 
-        if (script_name == "OnMouseDown") {
-            push();
-            fire_script("OnClick");
-            if (!checker.is_alive())
-                return;
+        if (script_name == "OnMouseDown" || script_name == "OnMouseUp" ||
+            script_name == "OnDoubleClick") {
+
+            const input::mouse_button_event event_id =
+                script_name == "OnMouseDown" ? input::mouse_button_event::down
+                : script_name == "OnMouseUp" ? input::mouse_button_event::up
+                                             : input::mouse_button_event::double_click;
+
+            const auto event_name = data.get<std::string>(1) +
+                                    std::string{input::get_mouse_button_event_codename(event_id)};
+
+            if (is_button_clicks_enabled(event_name)) {
+                if (event_id == input::mouse_button_event::down)
+                    push();
+                else if (event_id == input::mouse_button_event::up)
+                    release();
+
+                event_data new_data;
+                new_data.add(data.get(0)); // Mouse button ID
+                new_data.add(static_cast<std::underlying_type_t<input::mouse_button_event>>(
+                    event_id)); // Mouse button event
+                new_data.add(event_name); // Mouse button event name
+                new_data.add(data.get(2)); // Mouse pos X
+                new_data.add(data.get(3)); // Mouse pos Y
+                fire_script("OnClick", new_data);
+                if (!checker.is_alive())
+                    return;
+            }
         }
-
-        if (script_name == "OnMouseUp")
-            release();
     }
 }
 
@@ -436,6 +457,44 @@ const vector2f& button::get_pushed_text_offset() const {
     return pushed_text_offset_;
 }
 
+void button::enable_button_clicks(const std::string& mouse_state) {
+    reg_click_list_.insert(mouse_state);
+}
+
+void button::enable_button_clicks(
+    input::mouse_button button_id, input::mouse_button_event button_event) {
+    reg_click_list_.insert(
+        std::string{input::get_mouse_button_codename(button_id)} +
+        std::string{input::get_mouse_button_event_codename(button_event)});
+}
+
+void button::disable_button_clicks(const std::string& mouse_state) {
+    reg_click_list_.erase(mouse_state);
+}
+
+void button::disable_button_clicks(
+    input::mouse_button button_id, input::mouse_button_event button_event) {
+    reg_click_list_.erase(
+        std::string{input::get_mouse_button_codename(button_id)} +
+        std::string{input::get_mouse_button_event_codename(button_event)});
+}
+
+void button::disable_button_clicks() {
+    reg_click_list_.clear();
+}
+
+bool button::is_button_clicks_enabled(const std::string& mouse_event) const {
+    return reg_click_list_.find(mouse_event) != reg_click_list_.end();
+}
+
+bool button::is_button_clicks_enabled(
+    input::mouse_button button_id, input::mouse_button_event button_event) const {
+    return reg_click_list_.find(
+               std::string{input::get_mouse_button_codename(button_id)} +
+               std::string{input::get_mouse_button_event_codename(button_event)}) !=
+           reg_click_list_.end();
+}
+
 const std::vector<std::string>& button::get_type_list_() const {
     return get_type_list_impl_<button>();
 }

src/gui_button_glues.cpp

@@ -20,16 +20,25 @@
  * case, the "normal" font is rendered with a slight offset that you
  * are free to define.
  *
- * Note that a @{Button} has @{Frame:enable_mouse} set to `true` by
+ * The button "click" event will be triggered by all registered combinations
+ * of mouse button events configured with @{Button:enable_button_clicks}.
+ *
+ * Note that a @{Button} has @{Frame:enable_mouse} set to `true` and
+ * @{Button:enable_button_clicks} set to `true` for `"LeftMouseUp"` by
  * default.
  *
  * __Events.__ Hard-coded events available to all @{Button}s, in
  * addition to those from @{Frame}:
  *
  * - `OnClick`: Triggered when the button is clicked, either when
- * @{Button:click} is called, or just when a mouse button is pressed
- * when the cursor is over the button.
- * - `OnDoubleClick`: Triggered when the button is double-clicked.
+ * @{Button:click} is called, or just when a mouse button is released or
+ * pressed when the cursor is over the button (depending on whether clicks
+ * are enabled for the mouse button and mouse button state, see
+ * @{Button:enable_button_clicks}). This event provides five arguments to
+ * the registered callback: a number identifying the mouse button, a number
+ * identifying the mouse button event, a string containing the human-readable
+ * name of this button event (e.g., `"LeftButtonUp"`, `"RightButtonDown"`, ...),
+ * and the mouse X and Y position.
  * - `OnEnable`: Triggered by @{Button:enable}.
  * - `OnDisable`: Triggered by @{Button:disable}.
  *
@@ -293,6 +302,40 @@ void button::register_on_lua(sol::state& lua) {
     /** @function unlock_highlight
      */
     type.set_function("unlock_highlight", member_function<&button::unlock_highlight>());
+
+    /** @function disable_button_clicks
+     */
+    type.set_function(
+        "disable_button_clicks", [](button& self, sol::optional<std::string> mouse_event_name) {
+            if (mouse_event_name.has_value()) {
+                self.disable_button_clicks(mouse_event_name.value());
+            } else {
+                self.disable_button_clicks();
+            }
+        });
+
+    /** @function enable_button_clicks
+     */
+    type.set_function(
+        "enable_button_clicks",
+        member_function< // select the right overload for Lua
+            static_cast<void (button::*)(const std::string&)>(&button::enable_button_clicks)>());
+
+    /** @function is_button_clicks_enabled
+     */
+    type.set_function(
+        "is_button_clicks_enabled",
+        member_function< // select the right overload for Lua
+            static_cast<bool (button::*)(const std::string&) const>(
+                &button::is_button_clicks_enabled)>());
+
+    /** @function set_button_clicks_enabled
+     */
+    type.set_function(
+        "set_button_clicks_enabled",
+        member_function< // select the right overload for Lua
+            static_cast<void (button::*)(const std::string&, bool)>(
+                &button::set_button_clicks_enabled)>());
 }
 
 } // namespace lxgui::gui