auto_click 0.1.12 → 0.1.15

data/CHANGELOG

@@ -1,4 +1,10 @@
-0.1.11
+0.1.15
+Add more general mouse control methods: mouse_down(keyname), mouse_up(keyname)
+
+0.1.14   
+Add middle_click and double_click
+
+0.1.12
 super ugly implementation of that method type (need refactoring or even rewite later)
 
 0.1.10

data/README.rdoc

@@ -1,6 +1,5 @@
 = AutoClick
 
-
 Smulating mouse click, cursor movement and keystrokes
 
 == Install
@@ -9,45 +8,21 @@ To install auto_click:
 
   gem install auto_click
 
-== Method List
-
-- left_click
-
-- right_click
-
-- cursor_position
-
-- mouse_move(x,y)
-
-- mouse_scroll(step)
-
-- left_drag(sx,sy,ex,ey)
-
-- right_drag(sx,sy,ex,ey)
-
-- type(string)
-
-- key_stroke(key_name)
-
-- key_down(key_name)
-
-- key_up(key_name)
-
-== Usage
+== Basic Usage
 
-To use the methods provided by auto_click. You need to require it.
+Using auto_click is easy. To use the methods provided by auto_click. You need to require it.
 
   require 'auto_click'
 
 To move the mouse cursor to 50,50 ( the top left corner is 0,0) and perform a double left click:
 
   mouse_move(50,50)
-  left_click
-  left_click
-  
-To show the current cursor position:
+  double_click
 
-  puts cursor_position
+To move the mouse cursor to 300,300 and perform a right click:
+
+  mouse_move(50,50)
+  right_click
   
 To scroll up (forward) 10 wheel steps:
   
@@ -67,7 +42,7 @@ Suppose the notepad window on the top left corner of the screen, to type "Auto C
   leftclick
   type('Auto Click')                
   
-The type method will Send keystroke for every characters of the strings. It will ensure that the capslock is off and hold shift when it is typing a capital character. 
+The type method will Send keystroke for every characters of the string. It will ensure that the capslock is off and hold shift when it is typing a capital character. 
 Notice that you need to escape the character \ and ' in single quote string, and you need to escape \  " and # in double quote string.
 For example, to type #''\ , you can either do:
 
@@ -75,8 +50,24 @@ For example, to type #''\ , you can either do:
   
 or
     
-  type("\#''\\)
+  type("\#''\\")
+
+== Advanced Usage
+
+The methods shown in Basic Usage is convenient, but sometimes you may need more control on your mouse action and key strokes.
+
+To show the current cursor position:
+
+  puts cursor_position
+  
+If you wish to left click and hold:
+  
+  mouse_down(:left)
   
+And remember to release the button later:
+
+  mouse_up(:left)
+    
 To get more refine control of key stroke simulation, you can use the method key_stroke, key_up and key_down methods
 
 To send keystroke 'a':
@@ -87,7 +78,7 @@ To send keystroke tab:
 
   key_stroke('tab')
 
-Therefore, to type "Auto Click" , you can either use the type method stated before, or you can do:
+Therefore, to type "Auto Click" , you can either use the simple type method stated basic usage section, or you can do:
 
   key_down('shift')        
   key_stroke('a')  
@@ -96,12 +87,15 @@ Therefore, to type "Auto Click" , you can either use the type method stated befo
   key_stroke('t')
   key_stroke('o')
   key_stroke('space')
+  key_down('shift')
   key_stroke('c')
+  key_up('shift')
   key_stroke('l')
   key_stroke('i')
   key_stroke('c')
   key_stroke('k')
   
+And you can have detail adjustments to the keyboard behaviour that you need.
 
 Notice that 'a' means the key 'a' instead of the letter 'a'. Therefore key_stroke('a') and key_stroke('A') are basically the same. If the capslock is off but you want to type the capitalized A, you need to:
 
@@ -119,13 +113,60 @@ is the same as
 
   key_stroke('a')
   
+To perform a double_click, instead of using
+
+  double_click
+
+You can use two click calls
+
+  left_click
+  left_click
   
- 
- 
+And of course if for some reasons you need double middle mouse click, you can:
+
+  middle_click
+  middle_click
+
+There are some methods which is not discussed here. Please see the following Method List for all the available methods.
+
+== Method List
+
+- left_click
+
+- right_click
+
+- middle_click
+
+- double_click
+
+- mouse_down(button_name)
+
+- cursor_position
+
+- mouse_move(x,y)
+
+- mouse_scroll(step)
+
+- left_drag(x_start,y_start,x_end,y_end)
+
+- right_drag(x_start,y_start,x_end,y_end)
+
+- type(string)
+
+- key_stroke(key_name)
+
+- key_down(key_name)
+
+- key_up(key_name)
+
 == Change log 
 (for full change log please refer to the CHANGELOG file in the repository)
 
-- 0.1.11 Super ugly implementation of that method type (need refactoring or even rewite later)
+- 0.1.15 Add more general mouse control methods: mouse_down(keyname), mouse_up(keyname)
+
+- 0.1.14 Add middle_click and double_click
+
+- 0.1.12 Super ugly implementation of that method type (need refactoring or even rewite later)
 
 - 0.1.10 Implement get_key_state method. Refine the key_stroke, key_down and key_up method
 
@@ -136,7 +177,6 @@ is the same as
 - 0.1.7 Primitive implementation of key_stroke. Need good api before putting it into method list
 
 - 0.1.4 Implement left_drag and right_drag
-
  
 == Tested with
 

data/auto_click.gemspec

@@ -12,14 +12,12 @@ Gem::Specification.new do |s|
   s.summary     = %q{Smulating mouse click, cursor movement and keystrokes}
   s.description = %q{Provide several Ruby methods for simulating mouse click, cursor movement and keystrokes in Windows. 
                      This gem use DL library and SendInput method so there is no dependency on FFI, AutoIt or Win32-api. 
-                     Methods include mouse_move(x,y), left_click, right_click, mouse_scroll, type, key_up, key_down...etc.
+                     Methods include mouse_move(x,y), left_click, right_click, type(string), mouse_scroll(steps), key_up, key_down...etc.
                      See https://github.com/erinata/auto_click for more details about instalation and usage.
                      (More control over mouse movement such as speed or locus will be implemented in future releases)}
   
   s.required_ruby_version = '>= 1.9.0'
   
-  s.executables << 'testing'
-  
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/auto_click.rb

@@ -9,6 +9,8 @@ module AutoClick
   @@rightup = InputStructure.mouse_input(0,0,0,0x0010)  
   @@leftdown = InputStructure.mouse_input(0,0,0,0x0002)
   @@leftup = InputStructure.mouse_input(0,0,0,0x0004)
+  @@middledown = InputStructure.mouse_input(0,0,0,0x0020)
+  @@middleup = InputStructure.mouse_input(0,0,0,0x0040)
     
   def send_input(inputs)
     n = inputs.size
@@ -52,6 +54,37 @@ module AutoClick
     send_input( [@@leftdown, @@leftup] )
   end
   
+  def middle_click
+    send_input( [@@middledown, @@middleup] )
+  end
+  
+  def mouse_down(button_name)
+    case button_name
+    when :right
+      send_input( [@@rightdown] )
+    when :middle
+      send_input( [@@middledown] )  
+    else
+      send_input( [@@leftdown] )
+    end
+  end
+  
+  def mouse_up(button_name)
+    case button_name
+    when :right
+      send_input( [@@rightup] )
+    when :middle
+      send_input( [@@middleup] )  
+    else
+      send_input( [@@leftup] )
+    end
+  end  
+  
+  def double_click
+    left_click
+    left_click
+  end
+  
   def cursor_position
     point = " " * 8
     User32.GetCursorPos(point)

data/lib/auto_click/input_structure.rb

@@ -10,7 +10,6 @@ module InputStructure
     mi.pack('LLLLLLL')
   end
   
-  
   def self.keyboard_input(wVk,dw_flags)
     ki = Array.new(7, 0)
     ki[0] = 1
@@ -18,7 +17,6 @@ module InputStructure
     ki[2] = dw_flags
     ki.pack('LLLLLLL')
   end
-
   
   
 end

data/lib/auto_click/version.rb

@@ -1,3 +1,3 @@
 module AutoClick
-  VERSION = "0.1.12"
+  VERSION = "0.1.15"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 12
-  version: 0.1.12
+  - 15
+  version: 0.1.15
 platform: ruby
 authors: 
 - erinata
@@ -14,14 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-04 00:00:00 -06:00
+date: 2011-01-13 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
 description: |-
   Provide several Ruby methods for simulating mouse click, cursor movement and keystrokes in Windows. 
                        This gem use DL library and SendInput method so there is no dependency on FFI, AutoIt or Win32-api. 
-                       Methods include mouse_move(x,y), left_click, right_click, mouse_scroll, type, key_up, key_down...etc.
+                       Methods include mouse_move(x,y), left_click, right_click, type(string), mouse_scroll(steps), key_up, key_down...etc.
                        See https://github.com/erinata/auto_click for more details about instalation and usage.
                        (More control over mouse movement such as speed or locus will be implemented in future releases)
 email: