Merge lp:~azzar1/nux/please-dont-focus-me-on-mouse-down into lp:nux/2.0

[Andrea Azzarone]

Adds a way to disable the focus on mouse down behaviour. Adds a simple test too.

[Tim Penhey (thumper)]

Looks good.

review: Approve

[Jay Taoko (jaytaoko)]

There is no need to have Area::AcceptKeyNavFocusOnMouseDown use GetInputEventSensitivity().
Area::AcceptKeyNavFocus() uses GetInputEventSensitivity() already.

I propose the following

class InputArea
{

  virtual bool AcceptKeyNavFocusOnMouseDown();
  void SetAcceptKeyNavFocusOnMouseDown(bool accept);

  bool accept_key_nav_focus_on_mouse_down_;
}

InputArea::InputArea()
{
  accept_key_nav_focus_on_mouse_down_ = true;
}

bool InputArea::AcceptKeyNavFocusOnMouseDown()
{
  return accept_key_nav_focus_on_mouse_down_;
}

void InputArea::SetAcceptKeyNavFocusOnMouseDown(bool accept)
{
  accept_key_nav_focus_on_mouse_down_ = accept;
}

BaseWindow::BaseWindow(...)
{

  SetAcceptKeyNavFocusOnMouseDown(false);

}

That way we can also get other Views to not get the focus on mouse down events if there is a need for it. Not just BaseWindows. Let me know if this still works with your branch.

There is a similar problem with InputArea::AcceptKeyNavFocus(). I will re-factor it to work like SetAcceptKeyNavFocusOnMouseDown.

review: Needs Fixing

[Andrea Azzarone (azzar1)]

Done.

[lp:~azzar1/nux/please-dont-focus-me-on-mouse-down]

530. By Andrea Azzarone on 2012-01-02

Makes sure that the scroll wheel works with nux::VScrollbar. Fixes: https://bugs.launchpad.net/bugs/888819. Appoved by Jay Taoko.

531. By Jay Taoko on 2012-01-03

Added separate file for GLib main loop functions
* Cleanup: variable renaming
* Marked some functions as obsolete
* Core objects take the WindowThread as a constructor parameters: Painter, WindowCompositor.... Fixes: . Appoved by Jason Smith.

532. By Jay Taoko on 2012-01-03

* Removed API:
   GraphicsDisplay& GetWindow();
   GraphicsEngine& GetGraphicsEngine();
   NThread* GetThreadApplication();
   WindowThread* GetGraphicsThread();

* Modified code to to use GetWindowThread() to access its internal objects.

* Added tests:
   - WindowThread
   - StaticText
. Fixes: . Appoved by Jason Smith.

533. By Andrea Azzarone on 2012-01-03

Adds the possiblity to don't get the focus on mouse down.

[Jay Taoko (jaytaoko)]

review: Approve

=== modified file 'Nux/BaseWindow.cpp'
--- Nux/BaseWindow.cpp	2011-12-06 16:29:06 +0000
+++ Nux/BaseWindow.cpp	2012-01-03 14:49:27 +0000
@@ -68,6 +68,8 @@
     _entering_hidden_state = false;
     _enter_focus_input_area = NULL;
     accept_key_nav_focus_ = false;
+    
+    SetAcceptKeyNavFocusOnMouseDown(false);
 
     // Should be at the end of the constructor
     GetWindowThread()->GetWindowCompositor().RegisterWindow(this);
 
=== modified file 'Nux/InputArea.cpp'
--- Nux/InputArea.cpp	2011-12-06 22:44:57 +0000
+++ Nux/InputArea.cpp	2012-01-03 14:49:27 +0000
@@ -43,6 +43,7 @@
   InputArea::InputArea(NUX_FILE_LINE_DECL)
     :   Area(NUX_FILE_LINE_PARAM)
     ,   m_AreaColor(color::Green)
+    ,   accept_key_nav_focus_on_mouse_down_(true)
   {
     SetGeometry(0, 0, 1, 1);
     _has_keyboard_focus = false;
@@ -82,6 +83,11 @@
   {
     _has_keyboard_focus = b;
   }
+  
+  void InputArea::SetAcceptKeyNavFocusOnMouseDown(bool accept)
+  {
+    accept_key_nav_focus_on_mouse_down_ = accept;
+  }
 
   int InputArea::GetMouseX()
   {
@@ -418,5 +424,10 @@
   {
     return false;
   }
+  
+  bool InputArea::AcceptKeyNavFocusOnMouseDown()
+  {
+    return accept_key_nav_focus_on_mouse_down_;
+  }
 }
 
 
=== modified file 'Nux/InputArea.h'
--- Nux/InputArea.h	2011-10-17 21:23:50 +0000
+++ Nux/InputArea.h	2012-01-03 14:49:27 +0000
@@ -61,6 +61,7 @@
 
     bool HasKeyboardFocus();
     void SetKeyboardFocus(bool b);
+    void SetAcceptKeyNavFocusOnMouseDown(bool accept);
     int GetMouseX();
     int GetMouseY();
     
@@ -154,6 +155,8 @@
     
     int _dnd_safety_x;
     int _dnd_safety_y;
+    
+    bool accept_key_nav_focus_on_mouse_down_;
 
   protected:
 
@@ -314,6 +317,7 @@
     protected:
 
       virtual bool AcceptKeyNavFocus();
+      virtual bool AcceptKeyNavFocusOnMouseDown();
 
       // == 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	2011-12-29 18:06:53 +0000
+++ Nux/WindowCompositor.cpp	2012-01-03 14:49:27 +0000
@@ -473,7 +473,7 @@
           // 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())
+          if (mouse_over_area_ != GetKeyFocusArea() and mouse_over_area_->AcceptKeyNavFocusOnMouseDown())
           {
             InputArea* grab_area = GetKeyboardGrabArea();
             if (grab_area)
 
=== modified file 'configure.ac'
--- configure.ac	2012-01-03 03:10:54 +0000
+++ configure.ac	2012-01-03 14:49:27 +0000
@@ -22,7 +22,7 @@
 # The number format is : year/month/day
 # e.g.: december 5th, 2011 is: 20111205
 # So far there is no provision for more than one break in a day.
-m4_define([nux_abi_version], [20111211])
+m4_define([nux_abi_version], [20111212])
 
 m4_define([nux_version],
           [nux_major_version.nux_minor_version.nux_micro_version])
 
=== modified file 'tests/Makefile.am'
--- tests/Makefile.am	2012-01-03 03:10:54 +0000
+++ tests/Makefile.am	2012-01-03 14:49:27 +0000
@@ -11,7 +11,8 @@
   hgrid-key-navigation-test \
   hlayout-key-navigation-test \
   vlayout-key-navigation-test \
-  scrollbar-test
+  scrollbar-test \
+  focus-on-mouse-down-test
 
 # Please keep alphabetical
 test_nux_SOURCES = \
@@ -208,6 +209,17 @@
 vlayout_key_navigation_test_LDADD = $(TestLibs)
 vlayout_key_navigation_test_LDFLAGS = -lpthread -lXtst
 
+focus_on_mouse_down_test_SOURCES = focus-on-mouse-down-test.cpp \
+  nux_test_framework.cpp \
+  nux_test_framework.h \
+  nux_automated_test_framework.cpp \
+  nux_automated_test_framework.h \
+  test-view.cpp \
+  test-view.h
+
+focus_on_mouse_down_test_CPPFLAGS = $(TestFlags)
+focus_on_mouse_down_test_LDADD = $(TestLibs)
+focus_on_mouse_down_test_LDFLAGS = -lpthread -lXtst
 
 scrollbar_test_SOURCES = scrollbar-test.cpp \
   nux_test_framework.cpp \
@@ -234,7 +246,7 @@
 	./gtest-nux-core
 	./gtest-nux
 
-test-apps: test-graphics-display test-empty-window button-xtest mouse-events-test mouse-buttons-test hgrid-key-navigation-test hlayout-key-navigation-test vlayout-key-navigation-test scrollbar-test
+test-apps: test-graphics-display test-empty-window button-xtest mouse-events-test mouse-buttons-test hgrid-key-navigation-test hlayout-key-navigation-test vlayout-key-navigation-test scrollbar-test focus-on-mouse-down-test
 	./test-graphics-display
 	./test-empty-window
 	./button-xtest
@@ -244,6 +256,7 @@
 	./hlayout-key-navigation-test
 	./vlayout-key-navigation-test
 	./scrollbar-test
+	./focus-on-mouse-down-test
 
 check-report:
 	@gtester -k -o=test-nux-results.xml -k ./test-nux \
 
=== modified file 'tests/Readme.txt'
--- tests/Readme.txt	2011-12-12 07:21:11 +0000
+++ tests/Readme.txt	2012-01-03 14:49:27 +0000
@@ -42,6 +42,7 @@
 vlayout_key_navigation_test
   Make sure that the key navigation works well in a VLayout.
 
-
+focus_on_mouse_down_test
+  Make sure that AcceptKeyNavFocusOnMouseDown works well.
 
 
 
=== added file 'tests/focus-on-mouse-down-test.cpp'
--- tests/focus-on-mouse-down-test.cpp	1970-01-01 00:00:00 +0000
+++ tests/focus-on-mouse-down-test.cpp	2012-01-03 14:49:27 +0000
@@ -0,0 +1,157 @@
+/*
+ * Copyright 2011 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 <X11/extensions/XTest.h>
+#include <X11/keysym.h> 
+#include "nux_test_framework.h"
+#include "nux_automated_test_framework.h"
+#include "test-view.h"
+
+class FocusOnMouseDownTest: public NuxTestFramework
+{
+public:
+  FocusOnMouseDownTest(const char *program_name, int window_width, int window_height, int program_life_span);
+  ~FocusOnMouseDownTest();
+
+  virtual void UserInterfaceSetup();
+  
+  TestView* focus_view_;
+  TestView* no_focus_view_;
+};
+
+FocusOnMouseDownTest::FocusOnMouseDownTest(const char* program_name,
+                                           int window_width,
+                                           int window_height,
+                                           int program_life_span)
+  : NuxTestFramework(program_name, window_width, window_height, program_life_span)
+  , focus_view_(nullptr)
+  , no_focus_view_(nullptr)
+{
+}
+
+FocusOnMouseDownTest::~FocusOnMouseDownTest()
+{
+}
+
+void FocusOnMouseDownTest::UserInterfaceSetup()
+{
+  nux::VLayout* main_layout = new nux::VLayout(NUX_TRACKER_LOCATION);
+  main_layout->SetSpaceBetweenChildren(10);
+  main_layout->SetPadding(10, 10);
+  
+  focus_view_ = new TestView(NUX_TRACKER_LOCATION);
+  focus_view_->can_focus_ = true;
+  focus_view_->SetAcceptKeyNavFocusOnMouseDown(true);
+  main_layout->AddView(focus_view_, 1, nux::MINOR_POSITION_CENTER, nux::MINOR_SIZE_FULL);
+    
+  no_focus_view_ = new TestView(NUX_TRACKER_LOCATION);
+  no_focus_view_->can_focus_ = true;
+  no_focus_view_->SetAcceptKeyNavFocusOnMouseDown(false);
+  main_layout->AddView(no_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);
+}
+
+FocusOnMouseDownTest* focus_on_mouse_down_test = nullptr;
+
+void TestingThread(nux::NThread* thread, void* user_data)
+{
+  while (focus_on_mouse_down_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_down_test->focus_view_, "Focus view created");
+  test.TestReportMsg(focus_on_mouse_down_test->no_focus_view_, "No focus view created");
+
+  // Move mouse to center of focus_view
+  test.ViewSendMouseMotionToCenter(focus_on_mouse_down_test->focus_view_);
+
+  // Mouse down/up on focus_view_
+  test.ViewSendMouseClick(focus_on_mouse_down_test->focus_view_, 1);
+  nux::SleepForMilliseconds(500);
+  test.TestReportMsg(focus_on_mouse_down_test->focus_view_->has_focus_, "Mouse down: focus_view_ got the focus");
+  test.ViewSendMouseUp(focus_on_mouse_down_test->focus_view_, 1);
+  nux::SleepForMilliseconds(500);
+  test.TestReportMsg(focus_on_mouse_down_test->focus_view_->has_focus_, "Mouse up: focus is still on focus_view_");
+  
+   // Move mouse to center of no_focus_view
+  test.ViewSendMouseMotionToCenter(focus_on_mouse_down_test->no_focus_view_);
+
+  // Mouse down/up on no_focus_view_
+  test.ViewSendMouseDown(focus_on_mouse_down_test->no_focus_view_, 1);
+  nux::SleepForMilliseconds(500);
+  test.TestReportMsg(!focus_on_mouse_down_test->no_focus_view_->has_focus_, "Mouse down: no_focus_view_ did not take the focus");
+  test.TestReportMsg(focus_on_mouse_down_test->focus_view_->has_focus_, "Mouse down: focus is still on focus_view_");
+  test.ViewSendMouseUp(focus_on_mouse_down_test->no_focus_view_, 1);
+  nux::SleepForMilliseconds(500);
+  test.TestReportMsg(!focus_on_mouse_down_test->no_focus_view_->has_focus_, "Mouse up: no_focus_view_ still doesn't have the focus");
+  test.TestReportMsg(focus_on_mouse_down_test->focus_view_->has_focus_, "Mouse up: focus is still on focus_view_");
+  
+
+  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_down_test = new FocusOnMouseDownTest("Focus On Mouse Down Test", 300, 300, 15000);
+  focus_on_mouse_down_test->Startup();
+  focus_on_mouse_down_test->UserInterfaceSetup();
+
+  nux::SystemThread *test_thread = nux::CreateSystemThread(focus_on_mouse_down_test->GetWindowThread(), 
+                                                           &TestingThread,
+                                                           focus_on_mouse_down_test->GetWindowThread());
+
+  test_thread->Start(focus_on_mouse_down_test);
+
+  focus_on_mouse_down_test->Run();
+
+  delete test_thread;
+  delete focus_on_mouse_down_test;
+
+  return 0;
+}
+