Merge lp:~sao/nux/cursor-blink into lp:nux

[Oliver Sauder]

This branch is based on the work done in lp:~greggory-hz/nux/cursor-blink.

* The cursor is now always hidden when the TextEntry does not have the focus.
* Blinking of the cursor is implemented as it was outlined in the source code comment.
* Reset of the layout is needed to correctly show the blinking of the cursor.
* When the TextEntry gains focus again the cursor will now be at the same position
as when it was when losing focus.

[Jay Taoko (jaytaoko)]

Oliver,

Thank you for your patch! Before we can accept it, we require you to agree to inalogic's contributor agreement (http://inalogic.com/license). If you accept it, send and email to <email address hidden> and state that you agree.

[Oliver Sauder (sao)]

Done.

[Jay Taoko (jaytaoko)]

I am ready to accept your branch. Due to the changes in the .h file, I cannot back-port it to Nux for and SRU. I will merge it to Nux trunk.

Thank you!

review: Approve

=== modified file 'Nux/TextEntry.cpp'
--- Nux/TextEntry.cpp	2011-05-27 04:08:01 +0000
+++ Nux/TextEntry.cpp	2011-06-03 16:02:27 +0000
@@ -137,7 +137,7 @@
     italic_ = false;
     multiline_ = false;
     wrap_ = false;
-    cursor_visible_ = true;
+    cursor_visible_ = false;
     readonly_ = false;
     content_modified_ = false;
     //selection_changed_ = false;
@@ -184,6 +184,9 @@
 
   TextEntry::~TextEntry ()
   {
+    if(cursor_blink_timer_)
+      g_source_remove(cursor_blink_timer_);
+
     cairo_font_options_destroy (font_options_);
     if (_texture2D)
       _texture2D->UnReference ();
@@ -203,13 +206,14 @@
 
   void TextEntry::DoSetFocused (bool focused)
   {
-		
+    focused_ = focused;	
+    cursor_visible_ = focused; // visibilty of cursor depends on focus
     View::DoSetFocused (focused);
     if (focused == true)
     {
       _block_focus = true;
-      SetCursor(0);
-      QueueRefresh(false, true);
+      SetCursor(cursor_);
+      QueueRefresh(true, true);
       
       Area *_parent = GetParentObject();
       if (_parent == NULL)
@@ -226,7 +230,10 @@
         parent->SetFocusControl (false);
       }
     }
-
+    else
+    {
+      QueueRefresh(true, false); // needed to hide cursor
+    }
   }
 
   void TextEntry::GeometryChanged ()
@@ -684,10 +691,11 @@
         //gtk_im_context_focus_in(im_context_);
         //UpdateIMCursorLocation();
       }
+      cursor_visible_ = true; // show cursor when getting focus
       selection_changed_ = true;
       cursor_moved_ = true;
       // Don't adjust scroll.
-      QueueRefresh(false, false);
+      QueueRefresh(true, false);
     }
   }
 
@@ -701,10 +709,11 @@
         need_im_reset_ = true;
         //gtk_im_context_focus_out(im_context_);
       }
+      cursor_visible_ = false; // hide cursor when losing focus
       selection_changed_ = true;
       cursor_moved_ = true;
       // Don't adjust scroll.
-      QueueRefresh(false, false);
+      QueueRefresh(true, false);
     }
   }
 
@@ -795,7 +804,7 @@
       AdjustScroll();
 
     QueueTextDraw();
-    //todo: QueueCursorBlink();
+    QueueCursorBlink();
   }
 
   void TextEntry::ResetImContext()
@@ -888,6 +897,27 @@
       canvas->PopState();
     }
   }
+  
+  bool TextEntry::CursorBlinkCallback(TextEntry *self)
+  {
+    if (self->cursor_blink_status_)
+      self->ShowCursor();
+    else
+      self->HideCursor();
+  
+    if (--self->cursor_blink_status_ < 0)
+      self->cursor_blink_status_ = 2;
+
+    return true;
+  }
+  
+  void TextEntry::QueueCursorBlink()
+  {
+    if (!cursor_blink_timer_)
+      cursor_blink_timer_ = g_timeout_add(kCursorBlinkTimeout, 
+                                          (GSourceFunc)&CursorBlinkCallback, 
+                                          this);
+  }
 
   void TextEntry::ShowCursor()
   {
@@ -897,7 +927,7 @@
       if (focused_ && !readonly_)
       {
         cursor_moved_ = true;
-        QueueTextDraw();
+        QueueRefresh(true, false);
       }
     }
   }
@@ -910,7 +940,7 @@
       if (focused_ && !readonly_)
       {
         cursor_moved_ = true;
-        QueueTextDraw();
+        QueueRefresh(true, false);
       }
     }
   }

=== modified file 'Nux/TextEntry.h'
--- Nux/TextEntry.h	2011-04-28 22:28:39 +0000
+++ Nux/TextEntry.h	2011-06-03 16:02:27 +0000
@@ -222,12 +222,12 @@
 //     /** Set the visibility of the edit control */
 //     void SetVisibility(bool visible);
 //
-//     /** Check if the cursor should be blinking */
-//     bool IsCursorBlinking();
-//     /** Send out a request to blink the cursor if necessary */
-//     void QueueCursorBlink();
-//     /** Timer callback to blink the cursor */
-//     bool CursorBlinkCallback(int timer_id);
+//  /** Check if the cursor should be blinking */
+//  bool IsCursorBlinking();
+    /** Send out a request to blink the cursor if necessary */
+    void QueueCursorBlink();
+    static bool CursorBlinkCallback(TextEntry *data);
+    
     void ShowCursor();
     void HideCursor();