Merge lp:~azzar1/nux/focus-on-enter into lp:nux/2.0

[Andrea Azzarone]

Adds the support for the "focus on mouse enter" feature.

[lp:~azzar1/nux/focus-on-enter]

577. By Andrea Azzarone on 2012-02-17

Change abi version.

578. By Andrea Azzarone on 2012-02-17

Fixes.

[Jay Taoko (jaytaoko)]

+1

review: Approve

=== modified file 'Nux/Area.h'
--- Nux/Area.h	2012-01-28 05:35:42 +0000
+++ Nux/Area.h	2012-02-17 20:49:19 +0000
@@ -515,7 +515,7 @@
       const char* character);
 
     virtual bool AcceptKeyNavFocus();
-    
+
     virtual Area* KeyNavIteration(KeyNavDirection direction);
 
     bool HasKeyFocus() const;

=== modified file 'Nux/InputArea.cpp'
--- Nux/InputArea.cpp	2012-01-04 00:47:59 +0000
+++ Nux/InputArea.cpp	2012-02-17 20:49:19 +0000
@@ -44,6 +44,7 @@
   : Area(NUX_FILE_LINE_PARAM)
   , area_color_(color::Green)
   , accept_key_nav_focus_on_mouse_down_(true)
+  , accept_key_nav_focus_on_mouse_enter_(false)
   {
     SetGeometry(0, 0, 1, 1);
 
@@ -79,11 +80,6 @@
     return GetWindowThread()->GetWindowCompositor().GetKeyFocusArea() == this;
   }
 
-  void InputArea::SetAcceptKeyNavFocusOnMouseDown(bool accept)
-  {
-    accept_key_nav_focus_on_mouse_down_ = accept;
-  }
-
   bool InputArea::IsMouseInside()
   {
     return mouse_in_;
@@ -399,9 +395,24 @@
     return false;
   }
   
-  bool InputArea::AcceptKeyNavFocusOnMouseDown()
+  bool InputArea::AcceptKeyNavFocusOnMouseDown() const
   {
     return accept_key_nav_focus_on_mouse_down_;
   }
+
+  bool InputArea::AcceptKeyNavFocusOnMouseEnter() const
+  {
+    return accept_key_nav_focus_on_mouse_enter_;
+  }
+
+  void InputArea::SetAcceptKeyNavFocusOnMouseDown(bool accept)
+  {
+    accept_key_nav_focus_on_mouse_down_ = accept;
+  }
+
+  void InputArea::SetAcceptKeyNavFocusOnMouseEnter(bool accept)
+  {
+    accept_key_nav_focus_on_mouse_enter_ = accept;
+  }
 }
 

=== modified file 'Nux/InputArea.h'
--- Nux/InputArea.h	2012-01-04 00:47:59 +0000
+++ Nux/InputArea.h	2012-02-17 20:49:19 +0000
@@ -59,7 +59,6 @@
     virtual void OverlayDrawing(GraphicsEngine &graphics_engine) {}
 
     bool HasKeyboardFocus();
-    void SetAcceptKeyNavFocusOnMouseDown(bool accept);
 
     bool MouseFocusOnOtherArea();
     void CaptureMouseDownAnyWhereElse(bool b);
@@ -82,6 +81,9 @@
 
     void SetKeyboardReceiverIgnoreMouseDownOutside(bool ignore_mouse_down_outside);
 
+    void SetAcceptKeyNavFocusOnMouseDown(bool accept);
+    void SetAcceptKeyNavFocusOnMouseEnter(bool accept);
+
     bool KeyboardReceiverIgnoreMouseDownOutside();
 
     virtual bool IsArea() const
@@ -147,8 +149,6 @@
     
     int _dnd_safety_x;
     int _dnd_safety_y;
-    
-    bool accept_key_nav_focus_on_mouse_down_;
 
   protected:
     bool _capture_mouse_down_any_where_else;
@@ -156,6 +156,10 @@
 
     bool _keyboard_receiver_ignore_mouse_down_outside;
 
+    bool accept_key_nav_focus_on_mouse_down_;
+    bool accept_key_nav_focus_on_mouse_enter_;
+
+
 #if defined(NUX_OS_LINUX)
     // DnD support
     // Rather than being implemented with signals, DND support is implemented with protected virtual function.
@@ -307,7 +311,8 @@
     protected:
 
       virtual bool AcceptKeyNavFocus();
-      virtual bool AcceptKeyNavFocusOnMouseDown();
+      virtual bool AcceptKeyNavFocusOnMouseDown() const;
+      virtual bool AcceptKeyNavFocusOnMouseEnter() const;
 
       // == Signals with 1 to 1 mapping to input device ==
       virtual void EmitMouseDownSignal        (int x, int y, unsigned long mouse_button_state, unsigned long special_keys_state);

=== modified file 'Nux/WindowCompositor.cpp'
--- Nux/WindowCompositor.cpp	2012-02-04 00:19:46 +0000
+++ Nux/WindowCompositor.cpp	2012-02-17 20:49:19 +0000
@@ -430,9 +430,16 @@
 
               mouse_over_area_->EmitMouseLeaveSignal(x, y, event.GetMouseState(), event.GetKeyState());
             }
-
             // The area we found under the mouse pointer receives a "mouse enter signal".
             SetMouseOverArea(hit_view);
+
+            if (mouse_over_area_ != GetKeyFocusArea() &&
+                mouse_over_area_ && mouse_over_area_->AcceptKeyNavFocusOnMouseEnter())
+            {
+              SetKeyFocusArea(mouse_over_area_);
+            }
+          
+          
             mouse_over_area_->EmitMouseEnterSignal(hit_view_x, hit_view_y, event.GetMouseState(), event.GetKeyState());
             emit_delta = false;
           }
@@ -476,7 +483,8 @@
           // In the case of a mouse down event, if there is currently a keyboard event receiver and it is different
           // from the area returned by GetAreaUnderMouse, then stop that receiver from receiving anymore keyboard events and switch
           // make mouse_over_area_ the new receiver(if it accept keyboard events).
-          if (mouse_over_area_ != GetKeyFocusArea() and mouse_over_area_->AcceptKeyNavFocusOnMouseDown())
+          if (mouse_over_area_ != GetKeyFocusArea() && 
+              mouse_over_area_ && mouse_over_area_->AcceptKeyNavFocusOnMouseDown())
           {
             InputArea* grab_area = GetKeyboardGrabArea();
             if (grab_area)

=== modified file 'configure.ac'
--- configure.ac	2012-02-12 23:28:17 +0000
+++ configure.ac	2012-02-17 20:49:19 +0000
@@ -22,7 +22,7 @@
 # The number format is : year/month/day
 # e.g.: december 5th, 2011 is: 20111205
 # To make more than one API change in a day, add a number to the date. Like 20111205.xx
-m4_define([nux_abi_version], [20120212.01])
+m4_define([nux_abi_version], [20120217.01])
 
 m4_define([nux_version],
           [nux_major_version.nux_minor_version.nux_micro_version])

=== modified file 'tests/Makefile.am'
--- tests/Makefile.am	2012-02-13 15:22:30 +0000
+++ tests/Makefile.am	2012-02-17 20:49:19 +0000
@@ -13,6 +13,7 @@
   xtest-vlayout-key-navigation \
   xtest-scrollbar \
   xtest-focus-on-mouse-down \
+  xtest-focus-on-mouse-enter \
   xtest-keynav-directions
 
 # Please keep alphabetical
@@ -198,6 +199,14 @@
 xtest_focus_on_mouse_down_LDADD = $(TestLibs)
 xtest_focus_on_mouse_down_LDFLAGS = -lpthread -lXtst
 
+xtest_focus_on_mouse_enter_SOURCES = xtest-focus-on-mouse-enter.cpp \
+  nux_automated_test_framework.cpp \
+  nux_automated_test_framework.h
+
+xtest_focus_on_mouse_enter_CPPFLAGS = $(TestFlags)
+xtest_focus_on_mouse_enter_LDADD = $(TestLibs)
+xtest_focus_on_mouse_enter_LDFLAGS = -lpthread -lXtst
+
 xtest_scrollbar_SOURCES = xtest-scrollbar.cpp \
   nux_automated_test_framework.cpp \
   nux_automated_test_framework.h \
@@ -230,7 +239,7 @@
 check-headless: gtest-nux-core
 	@gtester --verbose -k -o=test-nux-results.xml ./gtest-nux-core
 
-test-apps: test-graphics-display test-empty-window xtest-button xtest-mouse-events xtest-mouse-buttons xtest-hgrid-key-navigation xtest-hlayout-key-navigation xtest-vlayout-key-navigation xtest-scrollbar xtest-focus-on-mouse-down xtest-keynav-directions
+test-apps: test-graphics-display test-empty-window xtest-button xtest-mouse-events xtest-mouse-buttons xtest-hgrid-key-navigation xtest-hlayout-key-navigation xtest-vlayout-key-navigation xtest-scrollbar xtest-focus-on-mouse-down xtest-focus-on-mouse-enter xtest-keynav-directions
 	./test-graphics-display
 	./test-empty-window
 	./xtest-button
@@ -241,6 +250,7 @@
 	./xtest-vlayout-key-navigation
 	./xtest-scrollbar
 	./xtest-focus-on-mouse-down
+	./xtest-focus-on-mouse-enter
 	./xtest-keynav-directions
 
 check-report:

=== modified file 'tests/Readme.txt'
--- tests/Readme.txt	2012-01-30 08:43:49 +0000
+++ tests/Readme.txt	2012-02-17 20:49:19 +0000
@@ -48,5 +48,8 @@
 xtest-focus-on-mouse-down
   Make sure that AcceptKeyNavFocusOnMouseDown works well.
 
+xtest-focus-on-mouse-enter
+  Make sure that AcceptKeyNavFocusOnMouseEnter works well.
+
 xtest-keynav-direction
-  Test key navigation. Especially test the direction a key nav is coming from when the view is getting the focus.
\ No newline at end of file
+  Test key navigation. Especially test the direction a key nav is coming from when the view is getting the focus.

=== added file 'tests/xtest-focus-on-mouse-enter.cpp'
--- tests/xtest-focus-on-mouse-enter.cpp	1970-01-01 00:00:00 +0000
+++ tests/xtest-focus-on-mouse-enter.cpp	2012-02-17 20:49:19 +0000
@@ -0,0 +1,140 @@
+/*
+ * Copyright 2012 Inalogic Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the  Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 3 along with this program.  If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Andrea Azzarone <[e-mail]>
+ *
+ */
+
+#include "Nux/Nux.h"
+#include "Nux/WindowThread.h"
+#include "Nux/VLayout.h"
+#include "Nux/ProgramFramework/ProgramTemplate.h"
+#include "Nux/ProgramFramework/TestView.h"
+#include <X11/extensions/XTest.h>
+#include <X11/keysym.h>
+#include "nux_automated_test_framework.h"
+
+class FocusOnMouseEnterTest: public ProgramTemplate
+{
+public:
+  FocusOnMouseEnterTest(const char* program_name, int window_width, int window_height, int program_life_span);
+  ~FocusOnMouseEnterTest();
+
+  virtual void UserInterfaceSetup();
+
+  TestView* focus_view_;
+  TestView* no_focus_view_;
+};
+
+FocusOnMouseEnterTest::FocusOnMouseEnterTest(const char* program_name,
+                                            int window_width,
+                                            int window_height,
+                                            int program_life_span)
+: ProgramTemplate(program_name, window_width, window_height, program_life_span)
+, focus_view_(nullptr)
+, no_focus_view_(nullptr)
+{
+}
+
+FocusOnMouseEnterTest::~FocusOnMouseEnterTest()
+{}
+
+void FocusOnMouseEnterTest::UserInterfaceSetup()
+{
+  nux::VLayout* main_layout = new nux::VLayout(NUX_TRACKER_LOCATION);
+  main_layout->SetSpaceBetweenChildren(10);
+  main_layout->SetPadding(10, 10);
+
+  no_focus_view_ = new TestView(NUX_TRACKER_LOCATION);
+  no_focus_view_->can_focus_ = true;
+  no_focus_view_->SetAcceptKeyNavFocusOnMouseEnter(false);
+  main_layout->AddView(no_focus_view_, 1, nux::MINOR_POSITION_CENTER, nux::MINOR_SIZE_FULL);
+
+  focus_view_ = new TestView(NUX_TRACKER_LOCATION);
+  focus_view_->can_focus_ = true;
+  focus_view_->SetAcceptKeyNavFocusOnMouseEnter(true);
+  main_layout->AddView(focus_view_, 1, nux::MINOR_POSITION_CENTER, nux::MINOR_SIZE_FULL);
+
+  static_cast<nux::WindowThread*>(window_thread_)->SetLayout(main_layout);
+
+  nux::ColorLayer background(nux::Color(0xFF4D4D4D));
+  static_cast<nux::WindowThread*>(window_thread_)->SetWindowBackgroundPaintLayer(&background);
+}
+
+FocusOnMouseEnterTest* focus_on_mouse_enter_test = nullptr;
+
+void TestingThread(nux::NThread* thread, void* user_data)
+{
+  while (focus_on_mouse_enter_test->ReadyToGo() == false)
+  {
+    nuxDebugMsg("Waiting to start");
+    nux::SleepForMilliseconds(300);
+  }
+
+  nux::SleepForMilliseconds(1000);
+
+  nux::WindowThread* wnd_thread = static_cast<nux::WindowThread*>(user_data);
+
+  NuxAutomatedTestFramework test(wnd_thread);
+
+  test.Startup();
+
+  // Set the mouse at coordinates (0, 0) (top-left corner) on the display
+  test.PutMouseAt(0, 0);
+
+  test.TestReportMsg(focus_on_mouse_enter_test->focus_view_, "Focus view created");
+  test.TestReportMsg(focus_on_mouse_enter_test->no_focus_view_, "No focus view created");
+
+  // Move mouse to center of no_focus_view_
+  test.ViewSendMouseMotionToCenter(focus_on_mouse_enter_test->no_focus_view_);
+  nux::SleepForMilliseconds(500);
+  test.TestReportMsg(!focus_on_mouse_enter_test->no_focus_view_->has_focus_, "no_focus_view_ did not take the focus");
+
+   // Move mouse to center of focus_view_
+  test.ViewSendMouseMotionToCenter(focus_on_mouse_enter_test->focus_view_);
+  nux::SleepForMilliseconds(500);
+  test.TestReportMsg(focus_on_mouse_enter_test->focus_view_->has_focus_, "focus_view_ has the focus");
+
+  if (test.WhenDoneTerminateProgram())
+  {
+    nux::SleepForMilliseconds(1000);
+    wnd_thread->ExitMainLoop();
+  }
+  nuxDebugMsg("Exit testing thread");
+}
+
+int main(int argc, char** argv)
+{
+  int xstatus = XInitThreads();
+  nuxAssertMsg(xstatus > 0, "XInitThreads has failed");
+
+  focus_on_mouse_enter_test = new FocusOnMouseEnterTest("Focus On Mouse Enter Test", 300, 300, 15000);
+  focus_on_mouse_enter_test->Startup();
+  focus_on_mouse_enter_test->UserInterfaceSetup();
+
+  nux::SystemThread* test_thread = nux::CreateSystemThread(focus_on_mouse_enter_test->GetWindowThread(),
+                                                           &TestingThread,
+                                                           focus_on_mouse_enter_test->GetWindowThread());
+
+  test_thread->Start(focus_on_mouse_enter_test);
+
+  focus_on_mouse_enter_test->Run();
+
+  delete test_thread;
+  delete focus_on_mouse_enter_test;
+
+  return 0;
+}