uia 0.0.8 → 0.0.9

data/ChangeLog

@@ -1,3 +1,12 @@
+===	Version 0.0.9 / 2014-02-06
+*	Enhancements
+	*	Element#focused? and Element#focus
+	*	Element#bounding_rectangle
+	*	Selection#selected_items for multi-select
+	*	#focus will try multiple times to focus an element before it gives up
+	*	#click will attempt to use the bounding_rectangle if there is no
+	"clickable point"
+
 === Version 0.0.8 / 2013-12-02
 *	Enhancements
 	*	Uia#find_element and Element#find can locate by :title

data/ext/UiaDll/UIA.Helper/Clicker.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Runtime.InteropServices;
+using System.Windows;
 using System.Windows.Automation;
 using System.Windows.Forms;
 
@@ -25,10 +26,22 @@ namespace UIA.Helper
             element.ScrollToIfPossible();
             element.TryToFocus();
 
-            var clickablePoint = element.GetClickablePoint();
+            var clickablePoint = ClickablePoint(element);
             Cursor.Position = new System.Drawing.Point((int)clickablePoint.X, (int)clickablePoint.Y);
             mouse_event(MOUSEEVENTLF_LEFTDOWN, 0, 0, 0, 0);
             mouse_event(MOUSEEVENTLF_LEFTUP, 0, 0, 0, 0);
         }
+
+        private static Point ClickablePoint(AutomationElement element)
+        {
+            try
+            {
+                return element.GetClickablePoint();
+            }
+            catch (Exception)
+            {
+                return element.Current.BoundingRectangle.Center();
+            }
+        }
     }
 }

data/ext/UiaDll/UIA.Helper/Element.cs

@@ -19,7 +19,7 @@ namespace UIA.Helper
 
         public TPattern As<TPattern>(AutomationPattern pattern)
         {
-            return (TPattern) _element.GetCurrentPattern(pattern);
+            return (TPattern)_element.GetCurrentPattern(pattern);
         }
 
         public void SendKeys(string keysToSend)
@@ -28,11 +28,25 @@ namespace UIA.Helper
             System.Windows.Forms.SendKeys.SendWait(keysToSend);
         }
 
+        public void SetFocus()
+        {
+            _element.SetFocus();
+        }
+
         public virtual int[] RuntimeId
         {
             get { return _element.GetRuntimeId(); }
         }
 
+        public virtual long[] BoundingRectangle
+        {
+            get
+            {
+                var r = _element.Current.BoundingRectangle;
+                return new[] { (long)r.Left, (long)r.Top, (long)(r.Right - r.Left), (long)(r.Bottom - r.Top) };
+            }
+        }
+
         public virtual string Name
         {
             get { return _element.Current.Name; }
@@ -58,6 +72,11 @@ namespace UIA.Helper
             get { return _element.Current.IsOffscreen == false; }
         }
 
+        public virtual bool HasKeyboardFocus
+        {
+            get { return _element.Current.HasKeyboardFocus; }
+        }
+
         public virtual int NativeWindowHandle
         {
             get { return _element.Current.NativeWindowHandle; }
@@ -135,7 +154,7 @@ namespace UIA.Helper
 
         public static Element ByHandle(IntPtr windowHandle)
         {
-           return NullOr(AutomationElement.FromHandle(windowHandle));
+            return NullOr(AutomationElement.FromHandle(windowHandle));
         }
 
         public static Element ByRuntimeId(int[] runtimeId)

data/ext/UiaDll/UIA.Helper/Extensions.cs

@@ -13,6 +13,14 @@ namespace UIA.Helper
         {
             return string.Join(separator, items.Select(x => x.ToString()));
         }
+
+        public static Point Center(this Rect rectangle)
+        {
+            if( rectangle == Rect.Empty )
+                throw new Exception("No point could be found");
+
+            return new Point(rectangle.Left + rectangle.Width / 2, rectangle.Top + rectangle.Height / 2);
+        }
     }
 
     public static class PropertyExtensions
@@ -34,8 +42,13 @@ namespace UIA.Helper
         {
             try
             {
-                automationElement.SetFocus();
-                return true;
+                var timesTried = 0;
+                while (timesTried++ < 5 && !automationElement.Current.HasKeyboardFocus)
+                {
+                    automationElement.SetFocus();
+                    Thread.Sleep(100);
+                }
+                return automationElement.Current.HasKeyboardFocus;
             } catch { return false; }
         }
 

data/ext/UiaDll/UiaDll.Test/ElementInformationTest.cpp

@@ -90,6 +90,14 @@ TEST_F(ElementInformationTest, ItKnowIfItIsEnabled)
   ASSERT_EQ(true, ElementInformation(element).isEnabled);
 }
 
+TEST_F(ElementInformationTest, ItKnowsIfItHasFocus)
+{
+  auto element = gcnew ElementStub("");
+  element->HasKeyboardFocus = true;
+
+  ASSERT_EQ(true, ElementInformation(element).hasKeyboardFocus);
+}
+
 TEST_F(ElementInformationTest, ItCanBeRefreshed)
 {
   auto elementInformation = ElementInformation(gcnew ElementStub("Initial", 0));

data/ext/UiaDll/UiaDll.Test/ElementStub.h

@@ -40,11 +40,22 @@ public:
     void set(bool value) { _isVisible = value; }
   }
 
+  virtual property bool HasKeyboardFocus
+  {
+    bool get() override { return _hasKeyboardFocus; }
+    void set(bool value) { _hasKeyboardFocus = value; }
+  }
+
   virtual property array<int>^ RuntimeId
   {
     array<int>^ get() override { return _runtimeIds; }
   }
 
+  virtual property array<long long>^ BoundingRectangle
+  {
+    array<long long>^ get() override { return gcnew array<long long> {0, 0, 0, 0}; }
+  }
+
   virtual property int NativeWindowHandle
   {
     int get() override { return _nativeWindowHandle; }
@@ -77,4 +88,5 @@ private:
   int _controlTypeId;
   bool _isEnabled;
   bool _isVisible;
+  bool _hasKeyboardFocus;
 };

data/ext/UiaDll/UiaDll/ElementMethods.cpp

@@ -143,4 +143,13 @@ extern "C" {
       StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
     }
   }
+
+  __declspec(dllexport) void Element_Focus(ElementInformationPtr element, char* errorInfo, const int errorLength) {
+    try {
+      Find(element)->SetFocus();
+    } catch(Exception^ error) {
+      StringHelper::CopyToUnmanagedString(error->Message, errorInfo, errorLength);
+    }
+  }
+
 }

data/ext/UiaDll/UiaDll/ElementStructures.h

@@ -15,6 +15,8 @@ typedef struct _ElementInformation {
 
   bool isEnabled;
   bool isVisible;
+  bool hasKeyboardFocus;
+  long boundingRectangle[4];
 
   _ElementInformation() : name(NULL), nativeWindowHandle(0), runtimeId(NULL), patterns(NULL), id(NULL), className(NULL) {}
 
@@ -52,6 +54,12 @@ typedef struct _ElementInformation {
 
     isEnabled = element->IsEnabled;
     isVisible = element->IsVisible;
+    hasKeyboardFocus = element->HasKeyboardFocus;
+
+    auto r = element->BoundingRectangle;
+    for(auto coord = 0; coord < 4; coord++) {
+      boundingRectangle[coord] = r[coord];
+    }
   }
 
   ~_ElementInformation() {

data/ext/UiaDll/UiaDll/SelectionMethods.cpp

@@ -13,4 +13,15 @@ extern "C" {
       return NULL;
     }
   }
+
+  __declspec(dllexport) int Selection_Selections(ElementInformationPtr element, ElementInformation** selections, char* errorInfo, const int errorInfoLength) {
+    try {
+      auto selectedElements = Element::From(Find(element)->As<SelectionPattern^>(SelectionPattern::Pattern)->Current.GetSelection());
+      *selections = ElementInformation::From(selectedElements);
+      return selectedElements->Length;
+    } catch(Exception^ e) {
+      StringHelper::CopyToUnmanagedString(e->Message, errorInfo, errorInfoLength);
+      return 0;
+    }
+  }
 }

data/lib/uia/element.rb

@@ -20,7 +20,7 @@ module Uia
 
     element_attr :id, :name, :handle, :runtime_id,
                  :class_name, :children, :descendants
-    refreshed_element_attr :enabled?, :visible?
+    refreshed_element_attr :enabled?, :visible?, :focused?, :bounding_rectangle
 
     def control_type
       Library::Constants::ControlTypes.find(@default) { |_, v| v == @element.control_type_id }.first
@@ -67,5 +67,9 @@ module Uia
       Library.click(@element)
       true
     end
+
+    def focus
+      Library.focus(@element)
+    end
   end
 end

data/lib/uia/library.rb

@@ -71,6 +71,7 @@ module Uia
     elements_from :children, :Element_Children, [:pointer]
     elements_from :descendants, :Element_Descendants, [:pointer]
     attach_throwable_function :click, :Element_Click, [:pointer], :void
+    attach_throwable_function :focus, :Element_Focus, [:pointer], :void
     attach_throwable_function :refresh, :Element_Refresh, [:pointer], :void
 
     # WindowPattern methods
@@ -96,6 +97,7 @@ module Uia
 
     # SelectionPattern methods
     attach_throwable_function :selection_info, :Selection_Information, [:pointer], SelectionInformation.by_ref
+    elements_from :selected_items, :Selection_Selections, [:pointer]
 
     # SelectionItemPattern methods
     attach_throwable_function :selection_item_info, :SelectionItem_Information, [:pointer], SelectionItemInformation.by_ref

data/lib/uia/library/element_structs.rb

@@ -19,15 +19,21 @@ module Uia
                  :patterns_length, :int,
                  :id, :string,
                  :is_enabled, :bool,
-                 :is_visible, :bool
+                 :is_visible, :bool,
+                 :has_focus, :bool,
+                 :bounding_rectangle, [:long, 4]
 
           struct_attr :id, :name, :handle, :control_type_id, :class_name,
-                      [:enabled?, :is_enabled], [:visible?, :is_visible]
+                      [:enabled?, :is_enabled], [:visible?, :is_visible], [:focused?, :has_focus]
 
           def runtime_id
             self[:runtime_id].read_array_of_int(number_of_ids)
           end
 
+          def bounding_rectangle
+            self[:bounding_rectangle].to_a
+          end
+
           def pattern_ids
             self[:patterns].read_array_of_int(self[:patterns_length])
           end

data/lib/uia/patterns/selection.rb

@@ -5,6 +5,10 @@ module Uia
         filter(pattern: :selection_item).map {|e| e.as :selection_item }
       end
 
+      def selected_items
+        Library.selected_items(@element).map {|e| e.as :selection_item }
+      end
+
       def multi_select?
         Library.selection_info(@element).multi_select?
       end

data/lib/uia/version.rb

@@ -1,3 +1,3 @@
 module Uia
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/spec/spec_helper.rb

@@ -22,7 +22,7 @@ end
 RSpec.configure do |config|
   config.before(:all) do
     @app = ChildProcess.build('spec/app/WindowsForms.exe').start
-    sleep 0.5
+    wait_until { Uia.find_element title: /MainFormWindow/ }
   end
 
   config.after(:all) do

data/spec/uia/element_spec.rb

@@ -12,12 +12,29 @@ describe Uia::Element do
     Then { element.id == 'MainFormWindow' }
     Then { element.class_name =~ /Forms.*app/i }
     Then { expect(element.find(id: 'textField')).to be_enabled }
+    Then do
+      expect(element.bounding_rectangle.count).to eq(4)
+      expect(element.bounding_rectangle).to be_all {|e| e.instance_of? Fixnum }
+    end
 
     context 'visibility' do
       When { element.as(:window).visual_state = :minimized }
       Then { element.visible? == false }
     end
 
+    context 'focus' do
+      Given(:text_field) { element.find(id: 'textField').as :value }
+
+      context 'initially' do
+        Then { text_field.focused? == false }
+      end
+
+      context 'explicitly' do
+        When { text_field.focus }
+        Then { text_field.focused? == true }
+      end
+    end
+
     context '#control_type' do
       Then { element.control_type == :window }
 

data/spec/uia/patterns/selection_spec.rb

@@ -27,5 +27,13 @@ describe Uia::Patterns::Selection do
         Then { tree_view.selection_items.map(&:name) == ['Parent One', 'Child 1', 'Child 2', 'Parent Two'] }
       end
     end
+
+    context '#selected_items' do
+      When do
+        main.find(name: 'Toggle Multi-Select').click
+        select_list.selection_items.each &:add_to_selection
+      end
+      Then { expect(select_list.selected_items.map(&:name)).to eq ['Apple', 'Orange', 'Mango'] }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uia
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -249,7 +249,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 720468909
+      hash: -154468511
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -258,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 720468909
+      hash: -154468511
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24