Added support for event filtering for automatic hide of overlay

Author: sadko4u

include/lsp-plug.in/tk/widgets/containers/Overlay.h

@@ -60,6 +60,15 @@ namespace lsp
          */
         typedef bool (*overlay_position_t)(ws::rectangle_t *rect, Overlay *overlay, void *data);
 
+        /**
+         * Function for filtering events on automatic overlay hide
+         * @param ev the event for filtering
+         * @param overlay overlay that triggered the filtering
+         * @param data supplementary data
+         * @return true on success execution
+         */
+        typedef bool (*overlay_filter_t)(const ws::event_t *ev, Overlay *overlay, void *data);
+
         /**
          * Overlayment, implements a single widget container that Overlays the child widget
          * according to the layout settings. The container ignores allocation() property
@@ -91,7 +100,10 @@ namespace lsp
                 prop::Padding           sIPadding;          // Internal padding
 
                 overlay_position_t      pPosFunc;           // Position calculation function
-                void                   *pPosData;           // Position data function
+                void                   *pPosData;           // Position function data
+
+                overlay_filter_t        pFilterFunc;        // Event filter function
+                void                   *pFilterData;        // Event filter data
 
             protected:
                 void                    do_destroy();
@@ -152,7 +164,9 @@ namespace lsp
 
             public:
                 void                    set_position_function(overlay_position_t func, void *data = NULL);
+                void                    set_filter_function(overlay_filter_t func, void *data = NULL);
                 bool                    calculate_position(ws::rectangle_t *rect);
+                bool                    filter_event(const ws::event_t *ev);
         };
 
     } /* namespace tk */

include/lsp-plug.in/tk/widgets/containers/Window.h

@@ -140,7 +140,7 @@ namespace lsp
                 status_t            do_render();
                 void                do_destroy();
                 void                draw_widgets(ws::ISurface *s);
-                void                auto_close_overlays(ssize_t x, ssize_t y);
+                void                auto_close_overlays(const ws::event_t *ev);
                 Overlay            *find_overlay(ssize_t x, ssize_t y);
                 virtual status_t    sync_size(bool force);
                 status_t            update_pointer();

src/main/widgets/containers/Overlay.cpp

@@ -93,6 +93,8 @@ namespace lsp
             wWidget         = NULL;
             pPosFunc        = NULL;
             pPosData        = NULL;
+            pFilterFunc     = NULL;
+            pFilterData     = NULL;
         }
 
         Overlay::~Overlay()
@@ -466,6 +468,12 @@ namespace lsp
             query_resize();
         }
 
+        void Overlay::set_filter_function(overlay_filter_t func, void *data)
+        {
+            pFilterFunc     = func;
+            pFilterData     = data;
+        }
+
         bool Overlay::calculate_position(ws::rectangle_t *rect)
         {
             if (rect == NULL)
@@ -478,6 +486,16 @@ namespace lsp
             return true;
         }
 
+        bool Overlay::filter_event(const ws::event_t *ev)
+        {
+            if (ev == NULL)
+                return false;
+            if (!sAutoClose.get())
+                return false;
+
+            return (pFilterFunc != NULL) ? pFilterFunc(ev, this, pFilterData) : false;
+        }
+
     } /* namespace tk */
 } /* namespace lsp */
 

src/main/widgets/containers/Window.cpp

@@ -857,9 +857,9 @@ namespace lsp
             return hKeys.vKeys.size();
         }
 
-        void Window::auto_close_overlays(ssize_t x, ssize_t y)
+        void Window::auto_close_overlays(const ws::event_t *ev)
         {
-            Overlay *ov     = find_overlay(x, y);
+            Overlay *ov     = find_overlay(ev->nLeft, ev->nTop);
             size_t updates  = 0;
 
             for (size_t i=0, n=vDrawOverlays.size(); i<n; ++i)
@@ -874,8 +874,11 @@ namespace lsp
                     continue;
                 if (!xov->auto_close()->get())
                     continue;
+                if (xov == ov)
+                    continue;
 
-                if (xov != ov)
+                // Hide the overlay if the event was not filtered
+                if (!xov->filter_event(ev))
                 {
                     xov->visibility()->set(false);
                     ++updates;
@@ -986,10 +989,9 @@ namespace lsp
 
                 case ws::UIE_MOUSE_DOWN:
                 {
-                    auto_close_overlays(e->nLeft, e->nTop);
+                    auto_close_overlays(e);
 
                     Widget *h       = acquire_mouse_handler(e);
-//                    int old_state   = hMouse.nState;
                     hMouse.nState  |= (size_t(1) << e->nCode);
                     hMouse.nLeft    = e->nLeft;
                     hMouse.nTop     = e->nTop;
@@ -1030,7 +1032,7 @@ namespace lsp
                 case ws::UIE_MOUSE_TRI_CLICK:
                 case ws::UIE_MOUSE_SCROLL:
                 {
-                    auto_close_overlays(e->nLeft, e->nTop);
+                    auto_close_overlays(e);
 
                     Widget *h = acquire_mouse_handler(e);
                     if (h == this)