auto_click 0.1.15 → 0.2.0

data/CHANGELOG

@@ -1,11 +1,11 @@
 0.1.15
-Add more general mouse control methods: mouse_down(keyname), mouse_up(keyname)
+Add more general mouse control methods: mouse_down(button_name), mouse_up(button_name)
 
 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)
+super ugly implementation of the method type (need refactoring or even rewite later)
 
 0.1.10
 implement get_key_state method

data/README.rdoc

@@ -40,9 +40,9 @@ Suppose the notepad window on the top left corner of the screen, to type "Auto C
 
   mouse_move(100,100)
   leftclick
-  type('Auto Click')                
+  type('Auto Click!')                
   
-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. 
+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 or a character that need shift down (e.g. '!').
 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:
 
@@ -54,12 +54,19 @@ or
 
 == Advanced Usage
 
-The methods shown in Basic Usage is convenient, but sometimes you may need more control on your mouse action and key strokes.
+The methods shown in Basic Usage are convenient, but sometimes you may need more control on your mouse actions and key strokes.
 
-To show the current cursor position:
+To show the current cursor x and y position in pixels:
 
-  puts cursor_position
+  puts cursor_position[0]
+  puts cursor_position[1]
+ 
+To move the mouse cursor downward 300 pixels
   
+  mouse_move(cursor_position[0]+300,cursor_position[1])  
+
+Yes this is not very efficient but mouse_move_relative methods will be implemented in later releases.
+ 
 If you wish to left click and hold:
   
   mouse_down(:left)
@@ -67,8 +74,22 @@ If you wish to left click and hold:
 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 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
+
+For get more refined control to key strokes simulation, you can use the method key_stroke, key_up and key_down methods
 
 To send keystroke 'a':
 
@@ -78,7 +99,7 @@ To send keystroke tab:
 
   key_stroke('tab')
 
-Therefore, to type "Auto Click" , you can either use the simple type method stated basic usage section, 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')  
@@ -94,6 +115,9 @@ Therefore, to type "Auto Click" , you can either use the simple type method stat
   key_stroke('i')
   key_stroke('c')
   key_stroke('k')
+  key_down('shift')
+  key_stroke('num1')
+  key_up('shift')
   
 And you can have detail adjustments to the keyboard behaviour that you need.
 
@@ -104,6 +128,13 @@ Notice that 'a' means the key 'a' instead of the letter 'a'. Therefore key_strok
   key_up('shift')
   
 A list of key stroke names will be included in the readme later. 'a' to 'z', 'num0' to 'num9', 'f1' to 'f12', 'shift' 'ctrl' 'alt' 'win' 'tab' 'del' 'ins' 'return' 'esc' 'pageup' 'pagedown' 'left' 'right' 'up' 'down' 'equal' 'hyphen'......etc are all acceptable key names.
+I am trying to cater a certain number of name variations, for example:
+
+  key_stroke('left') 
+  key_stroke('leftarrow')
+  key_stroke('leftkey')
+  
+will do the same thing. 
   
 If you know the virtual key code you can directly enter the key code, for example:
 
@@ -113,21 +144,9 @@ 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
+The list of virtual key codes can be found at http://msdn.microsoft.com/en-us/library/dd375731(v=vs.85).aspx
   
-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.
+There are some methods which are not discussed here. Please see the following Method List for all the available methods.
 
 == Method List
 
@@ -141,6 +160,8 @@ There are some methods which is not discussed here. Please see the following Met
 
 - mouse_down(button_name)
 
+- mouse_up(button_name)
+
 - cursor_position
 
 - mouse_move(x,y)
@@ -159,14 +180,24 @@ There are some methods which is not discussed here. Please see the following Met
 
 - key_up(key_name)
 
+== To Do List
+
+- Add options of movement speed of mouse so the cursor is actually "moving" instead of just show up at the destination instantly
+
+- GetWindow and GetWindowFocus Method
+
+- Refactor the ugly type(string) method
+
+- More effective way to move mouse relative to current position
+
 == Change log 
 (for full change log please refer to the CHANGELOG file in the repository)
 
-- 0.1.15 Add more general mouse control methods: mouse_down(keyname), mouse_up(keyname)
+- 0.1.15 Add more general mouse control methods: mouse_down(button_name), mouse_up(button_name)
 
 - 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.12 Super ugly implementation of the 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
 
@@ -190,7 +221,7 @@ There are some methods which is not discussed here. Please see the following Met
 
 MIT license
 
-Copyright (C) 2010 by Tom Lam
+Copyright (C) 2010-2011 by Tom Lam
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/auto_click.rb

@@ -2,7 +2,7 @@ require 'dl/import'
 require 'auto_click/input_structure'
 require 'auto_click/virtual_key'
 require 'auto_click/user32'
-
+ 
 module AutoClick
   
   @@rightdown = InputStructure.mouse_input(0,0,0,0x0008)
@@ -15,7 +15,7 @@ module AutoClick
   def send_input(inputs)
     n = inputs.size
     ptr = inputs.collect {|i| i.to_s}.join
-    User32.SendInput(n, ptr, inputs[0].size)
+    User32.SendInput(n, ptr, inputs[0].size)    
   end
 
   def mouse_move(x,y)

data/lib/auto_click/version.rb

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

metadata

@@ -1,38 +1,30 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: auto_click
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 15
-  version: 0.1.15
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: !!null 
 platform: ruby
-authors: 
+authors:
 - erinata
-autorequire: 
+autorequire: !!null 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-13 00:00:00 -06:00
-default_executable: 
+date: 2011-02-05 00:00:00.000000000 -06:00
+default_executable: !!null 
 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, 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: 
+description: ! "Provide several Ruby methods for simulating mouse click, cursor movement
+  and keystrokes in Windows. \n                     This gem use DL library and SendInput
+  method so there is no dependency on FFI, AutoIt or Win32-api. \n                     Methods
+  include mouse_move(x,y), left_click, right_click, type(string), mouse_scroll(steps),
+  key_up, key_down...etc.\n                     See https://github.com/erinata/auto_click
+  for more details about instalation and usage.\n                     (More control
+  over mouse movement such as speed or locus will be implemented in future releases)"
+email:
 - erinata@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG
 - Gemfile
@@ -48,36 +40,26 @@ files:
 has_rdoc: true
 homepage: https://github.com/erinata/auto_click
 licenses: []
-
-post_install_message: 
+post_install_message: !!null 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
-      - 0
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.0
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
-signing_key: 
+rubyforge_project: !!null 
+rubygems_version: 1.5.0
+signing_key: !!null 
 specification_version: 3
 summary: Smulating mouse click, cursor movement and keystrokes
 test_files: []
-