AXElements 1.0.0.alpha3 → 1.0.0.alpha4

data/ext/accessibility/core/core.c

@@ -0,0 +1,26 @@
+/*
+ *  key_coder.c
+ *  KeyCoder
+ *
+ *  Created by Mark Rada on 11-07-27.
+ *  Copyright 2011-2012 Marketcircle Incorporated. All rights reserved.
+ */
+
+
+#import <Cocoa/Cocoa.h>
+#import <Carbon/Carbon.h>
+#import <ApplicationServices/ApplicationServices.h>
+
+#include "ruby.h"
+
+
+void
+ax_callback()
+{
+}
+
+
+void
+Init_core()
+{
+}

data/ext/accessibility/key_coder/key_coder.c

@@ -26,7 +26,8 @@
  *  @return [Hash{String=>Number}]
  */
 
-static VALUE
+static
+VALUE
 keycoder_dynamic_mapping()
 {
 
@@ -91,7 +92,8 @@ keycoder_dynamic_mapping()
  *  @return [true]
  */
 
-static VALUE
+static
+VALUE
 keycoder_post_event(VALUE self, VALUE event)
 {
   VALUE code  = rb_ary_entry(event, 0);

data/lib/accessibility/dsl.rb

@@ -581,6 +581,19 @@ module Accessibility::DSL
     sleep wait
   end
 
+  ##
+  # Perform a triple click action
+  #
+  # If an argument is provided then the mouse will move to that point
+  # first; the argument must respond to `#to_point`.
+  #
+  # @param obj [#to_point]
+  def triple_click obj = nil, wait = 0.2
+    move_mouse_to obj, wait: 0 if obj
+    Mouse.triple_click
+    sleep wait
+  end
+
 
   # @!group Debug Helpers
 

data/lib/accessibility/version.rb

@@ -4,7 +4,7 @@
 # The main AXElements namespace.
 module Accessibility
   # @return [String]
-  VERSION   = '1.0.0.alpha3'
+  VERSION   = '1.0.0.alpha4'
 
   # @return [String]
   CODE_NAME = 'ルナトーン'

data/lib/mouse.rb

@@ -15,7 +15,7 @@ module Mouse
   extend self
 
   ##
-  # Number of animation steps per second.
+  # Number of animation steps per second
   #
   # @return [Number]
   FPS     = 120
@@ -24,13 +24,13 @@ module Mouse
   # @note We keep the number as a rational to try and avoid rounding
   #       error introduced by the floats, especially MacRuby floats.
   #
-  # Smallest unit of time allowed for an animation step.
+  # Smallest unit of time allowed for an animation step
   #
   # @return [Number]
   QUANTUM = Rational(1, FPS)
 
   ##
-  # Available constants for the type of units to use when scrolling.
+  # Available constants for the type of units to use when scrolling
   #
   # @return [Hash{Symbol=>Fixnum}]
   UNIT = {
@@ -40,7 +40,9 @@ module Mouse
 
   ##
   # The coordinates of the mouse using the flipped coordinate system
-  # (origin in top left).
+  #
+  # Flipped coordinates have the origin in top left corner of the
+  # primary screen.
   #
   # @return [CGPoint]
   def current_position
@@ -48,7 +50,7 @@ module Mouse
   end
 
   ##
-  # Move the mouse from the current position to the given point.
+  # Move the mouse from the current position to the given point
   #
   # @param point [CGPoint]
   # @param duration [Float] animation duration, in seconds
@@ -57,7 +59,7 @@ module Mouse
   end
 
   ##
-  # Click and drag from the current position to the given point.
+  # Click and drag from the current position to the given point
   #
   # @param point [CGPoint]
   # @param duration [Float] animation duration, in seconds
@@ -72,15 +74,17 @@ module Mouse
   ##
   # @todo Need to double check to see if I introduce any inaccuracies.
   #
-  # Scroll at the current position the given amount of units.
+  # Scroll at the current position the given amount of units
   #
   # Scrolling too much or too little in a period of time will cause the
   # animation to look weird, possibly causing the app to mess things up.
   #
-  # @param amount [Fixnum] number of units to scroll; positive to scroll
-  #   up or negative to scroll down
-  # @param duration [Float] animation duration, in seconds
-  # @param units [Symbol] `:line` scrolls by line, `:pixel` scrolls by pixel
+  # A positive `amonut` to scroll will scroll up and a negative `amount`
+  # will scroll down.
+  #
+  # @param amount [Fixnum] number of units to scroll
+  # @param duration [Float] in seconds
+  # @param units [Symbol] must be either `:line` or `:pixel`
   def scroll amount, duration = 0.2, units = :line
     units   = UNIT[units] || raise(ArgumentError, "#{units} is not a valid unit")
     steps   = (FPS * duration).round
@@ -95,8 +99,11 @@ module Mouse
   end
 
   ##
-  # Perform a down click. You should follow this up with a call to
-  # {#click_up} to finish the click.
+  # @api semipublic
+  #
+  # Perform a down click
+  #
+  # You should follow this up with a call to {#click_up} to finish the click.
   #
   # @param point [CGPoint]
   # @param duration [Number]
@@ -107,8 +114,12 @@ module Mouse
   end
 
   ##
-  # Perform an up click. This should only be called after a call to
-  # {#click_down} to finish the click event.
+  # @api semipublic
+  #
+  # Perform an up click
+  #
+  # This should only be called after a call to {#click_down} to finish
+  # the click event.
   #
   # @param point [CGPoint]
   def click_up point = current_position
@@ -117,10 +128,12 @@ module Mouse
   end
 
   ##
-  # Standard secondary click. Default position is the current position.
+  # Standard secondary click, sometimes called a "right click"
+  #
+  # Default position is the current position.
   #
   # @param point [CGPoint]
-  # @param duration [Number]
+  # @param duration [Number] in seconds
   def secondary_click point = current_position, duration = 12
     event = new_event KCGEventRightMouseDown, point, KCGMouseButtonRight
     post event
@@ -131,16 +144,21 @@ module Mouse
   alias_method :right_click, :secondary_click
 
   ##
-  # A standard double click. Defaults to clicking at the current position.
+  # @api semipublic
+  #
+  # Generate a multi click event at the given position
+  #
+  # `num_clicks` is the number of clicks for the event, where a value of `2'
+  # corresponds to a double click, `3` corresponds to a triple click, etc.
+  #
+  # However, I've only tested with a double and triple click, for which you
+  # can just call {#double_click} and {#triple_click} instead.
   #
+  # @param num_clicks [Fixnum]
   # @param point [CGPoint]
-  def double_click point = current_position
+  def multi_click num_clicks, point = current_position
     event = new_event KCGEventLeftMouseDown, point, KCGMouseButtonLeft
-    post event
-    set_type  event, KCGEventLeftMouseUp
-    post event
-
-    CGEventSetIntegerValueField(event, KCGMouseEventClickState, 2)
+    CGEventSetIntegerValueField(event, KCGMouseEventClickState, num_clicks)
     set_type  event, KCGEventLeftMouseDown
     post event
     set_type  event, KCGEventLeftMouseUp
@@ -148,8 +166,30 @@ module Mouse
   end
 
   ##
-  # Click with an arbitrary mouse button, using numbers to represent
-  # the mouse button. At the time of writing, the documented values are:
+  # A standard double click
+  #
+  # Defaults to clicking at the current position.
+  #
+  # @param point [CGPoint]
+  def double_click point = current_position
+    multi_click 2, point
+  end
+
+  ##
+  # A standard triple click
+  #
+  # Defaults to clicking at the current position.
+  #
+  # @param point [CGPoint]
+  def triple_click point = current_position
+    multi_click 3, point
+  end
+
+  ##
+  # Click with an arbitrary mouse button
+  #
+  # Numbers are used to map the mouse buttons. At the time of writing,
+  # the documented values are:
   #
   #  - KCGMouseButtonLeft   = 0
   #  - KCGMouseButtonRight  = 1

metadata

@@ -2,14 +2,14 @@
 name: AXElements
 version: !ruby/object:Gem::Version
   prerelease: 6
-  version: 1.0.0.alpha3
+  version: 1.0.0.alpha4
 platform: ruby
 authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00 Z
+date: 2012-11-27 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: "4.2"
+        version: 4.3.1
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: "4.2"
+        version: 4.3.1
 - !ruby/object:Gem::Dependency
   name: yard
   prerelease: false
@@ -110,6 +110,7 @@ files:
 - lib/mouse.rb
 - lib/rspec/expectations/ax_elements.rb
 - ext/accessibility/key_coder/extconf.rb
+- ext/accessibility/core/core.c
 - ext/accessibility/key_coder/key_coder.c
 - rakelib/doc.rake
 - rakelib/ext.rake