win 0.3.5 → 0.3.6

data/HISTORY

@@ -14,3 +14,7 @@
 == 0.3.5 / 2010-05-28
 
 * GetParent
+
+== 0.3.6 / 2010-05-31
+
+* Complex convenience methods (dialog

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

data/lib/win/gui/dialog.rb

@@ -6,6 +6,17 @@ module Win
     # Contains constants and Win32API functions related to dialog manipulation
     #
     module Dialog
+
+      # IDs of standard dialog controls and items
+      IDOK = 1
+      IDCANCEL = 2
+      IDABORT = 3
+      IDRETRY = 4
+      IDIGNORE = 5
+      IDYES = 6
+      IDNO = 7
+      ErrorIcon = 0x0014
+
       include Win::Library
       include Win::Gui::Window
 
@@ -31,18 +42,6 @@ module Win
       #
       function :GetDlgItem, [:ulong, :int], :ulong
 
-      # Convenience methods:
-
-      # finds top-level dialog window by title and yields found dialog window to block if given
-#      def dialog(title, seconds=3)
-#        d = begin
-#          win = Window::Window.top_level(title, seconds)
-#          yield(win) ? win : nil
-#        rescue TimeoutError
-#        end
-#        d.wait_for_close if d
-#        return d
-#      end
     end
   end
 end

data/lib/win/gui/input.rb

@@ -7,12 +7,7 @@ module Win
     module Input
       include Win::Library
 
-      # Internal constants:
-
-      # Key event delay
-      KEY_DELAY  = 0.00001
-
-      # Windows keyboard-related Constants:
+      # Windows defined constants:
 
       # Key down keyboard event (the key is being depressed)
       KEYEVENTF_KEYDOWN = 0
@@ -295,26 +290,6 @@ module Win
 
 
       # Convenience methods
-
-      ##
-      # Emulates combinations of (any amount of) keys pressed one after another (Ctrl+Alt+P) and then released
-      # *keys should be a sequence of a virtual-key codes. The codes must be a value in the range 1 to 254.
-      # For a complete list, see msdn:Virtual Key Codes.
-      def keystroke(*keys)
-        return if keys.empty?
-        keybd_event keys.first, 0, KEYEVENTF_KEYDOWN, 0
-        sleep KEY_DELAY
-        keystroke *keys[1..-1]
-        sleep KEY_DELAY
-        keybd_event keys.first, 0, KEYEVENTF_KEYUP, 0
-      end
-
-      # types text message into window holding the focus
-      def type_in(message)
-        message.scan(/./m) do |char|
-          keystroke(*char.to_vkeys)
-        end
-      end
     end
   end
 end

data/lib/win/gui/message.rb

@@ -7,36 +7,37 @@ module Win
     #  Below is a table of system-defined message prefixes:
     #
     #  *Prefix*:: *Message* *category* 
-    #  ABM::    Application desktop toolbar
-    #  BM::     Button control
-    #  CB::     Combo box control
-    #  CBEM::   Extended combo box control
-    #  CDM::    Common dialog box
-    #  DBT::    Device
-    #  DL::     Drag list box
-    #  DM::     Default push button control
-    #  DTM::    Date and time picker control
-    #  EM::     Edit control
-    #  HDM::    Header control
-    #  HKM::    Hot key control
-    #  IPM::    IP address control
-    #  LB::     List box control
-    #  LVM::    List view control
-    #  MCM::    Month calendar control
-    #  PBM::    Progress bar
-    #  PGM::    Pager control
-    #  PSM::    Property sheet
-    #  RB::     Rebar control
-    #  SB::     Status bar window
-    #  SBM::    Scroll bar control
-    #  STM::    Static control
-    #  TB::     Toolbar
-    #  TBM::    Trackbar
-    #  TCM::    Tab control
-    #  TTM::    Tooltip control
-    #  TVM::    Tree-view control
-    #  UDM::    Up-down control
-    #  WM::     General window
+    #  ABM:: Application desktop toolbar
+    #  BM:: Button control
+    #  CB:: Combo box control
+    #  CBEM:: Extended combo box control
+    #  CDM:: Common dialog box
+    #  DBT:: Device
+    #  DL::  Drag list box
+    #  DM::  Default push button control
+    #  DTM:: Date and time picker control
+    #  EM::  Edit control
+    #  HDM:: Header control
+    #  HKM:: Hot key control
+    #  IPM:: IP address control
+    #  LB::  List box control
+    #  LVM:: List view control
+    #  MCM:: Month calendar control
+    #  PBM:: Progress bar
+    #  PGM:: Pager control
+    #  PSM:: Property sheet
+    #  RB::  Rebar control
+    #  SB::  Status bar window
+    #  SBM:: Scroll bar control
+    #  STM:: Static control
+    #  TB::  Toolbar
+    #  TBM:: Trackbar
+    #  TCM:: Tab control
+    #  TTM:: Tooltip control
+    #  TVM:: Tree-view control
+    #  UDM:: Up-down control
+    #  WM::  General window
+
     module Message
       include Win::Library
 
@@ -334,6 +335,33 @@ module Win
       # PM_QS_SENDMESSAGE - Windows 98/Me, Windows 2000/XP: Process all sent messages.
       PM_QS_SENDMESSAGE= (QS_SENDMESSAGE << 16)
 
+      # The MSG structure contains message information from a thread's message queue.
+      #
+      #  typedef struct {
+      #     HWND hwnd;
+      #     UINT message;
+      #     WPARAM wParam;
+      #     LPARAM lParam;
+      #     DWORD time;
+      #     POINT pt;
+      #  } MSG, *PMSG;
+      #
+      #  hwnd:: Handle to the window whose window procedure receives the message. NULL when the message is a thread message.
+      #  message:: Message identifier. Applications can only use the low word; the high word is reserved by the system.
+      #  wParam:: Additional info about the message. Exact meaning depends on the value of the message member.
+      #  lParam:: Additional info about the message. Exact meaning depends on the value of the message member.
+      #  time:: Specifies the time at which the message was posted.
+      #  pt:: POINT structure - the cursor position, in screen coordinates, when the message was posted.
+      #       (in my definition, it is changed to two longs: x, y - has the same effect, just avoid nested structs)
+      class Msg < FFI::Struct
+        layout :hwnd, :ulong,
+               :message, :uint,
+               :w_param, :long,
+               :l_param, :pointer,
+               :time, :uint32,
+               :x, :long,
+               :y, :long
+      end
 
       ##
       # The SendAsyncProc function is an application-defined callback function used with the SendMessageCallback
@@ -477,34 +505,6 @@ module Win
       #
       function :SendMessage, [:ulong, :uint, :uint, :pointer], :int   # LPARAM different from PostMessage!
 
-      # The MSG structure contains message information from a thread's message queue.
-      #
-      #  typedef struct {
-      #     HWND hwnd;
-      #     UINT message;
-      #     WPARAM wParam;
-      #     LPARAM lParam;
-      #     DWORD time;
-      #     POINT pt;
-      #  } MSG, *PMSG;
-      #
-      #  hwnd:: Handle to the window whose window procedure receives the message. NULL when the message is a thread message.
-      #  message:: Message identifier. Applications can only use the low word; the high word is reserved by the system.
-      #  wParam:: Additional info about the message. Exact meaning depends on the value of the message member.
-      #  lParam:: Additional info about the message. Exact meaning depends on the value of the message member.
-      #  time:: Specifies the time at which the message was posted.
-      #  pt:: POINT structure - the cursor position, in screen coordinates, when the message was posted.
-      #       (in my definition, it is changed to two longs: x, y - has the same effect, just avoid nested structs) 
-      class Msg < FFI::Struct
-        layout :hwnd, :ulong,
-               :message, :uint,
-               :w_param, :long,
-               :l_param, :pointer,
-               :time, :uint32,
-               :x, :long,
-               :y, :long
-      end
-
       ##
       # The GetMessage function retrieves a message from the calling thread's message queue. The function
       # dispatches incoming sent messages until a posted message is available for retrieval.

data/lib/win/gui/window.rb

@@ -788,8 +788,8 @@ module Win
       # ---
       # *Remarks*: It is *different* from GetWindowText that returns only window title
       #
-      def text( win_handle )
-        buffer = FFI::MemoryPointer.new :char, 1024
+      def text( win_handle, buffer_size=1024 )
+        buffer = FFI::MemoryPointer.new :char, buffer_size
         num_chars = send_message win_handle, Win::Gui::Message::WM_GETTEXT, buffer.size, buffer
         num_chars == 0 ?  nil : buffer.get_bytes(0, num_chars)
       end

data/lib/win/library.rb

@@ -343,7 +343,8 @@ module Win
         # Create API object that holds information about function names, params, etc
         api = API.new(namespace, name, effective_name, params, returns, libs)
 
-        # Only define enhanced API if snake_name is different from original name (e.g. keybd_event)
+        # Only define enhanced API if snake_name is different from original name (e.g. keybd_event),
+        # If names are the same, this function is already "attached", not possible to enhance its API 
         unless snake_name.to_s == name.to_s
           method_body = if def_block
             if zeronil

data/spec/win/gui/dialog_spec.rb

@@ -15,29 +15,6 @@ module WinWindowTest
       it 'returns handle to correctly specified control'
 
     end
-
-    describe Win::Gui::Dialog, ' defines convenience/service methods on top of Windows API' do
-#      describe 'dialog' do
-#        spec{ use{ dialog( title ='Dialog Title', timeout_sec = 0.001, &any_block)  }}
-#
-#        it 'finds top-level dialog window by title' do
-#          pending 'Some problems (?with timeouts?) leave window open ~half of the runs'
-#          test_app do |app|
-#            keystroke(VK_ALT, 'F'.ord, 'A'.ord)
-#            @found = false
-#            dialog('Save As', 0.5) do |dialog_window|
-#              @found = true
-#              keystroke(VK_ESCAPE)
-#              dialog_window
-#            end
-#            @found.should == true
-#          end
-#        end
-#
-#        it 'yields found dialog window to a given block'
-#
-#      end
-    end
   end
 end
 

data/spec/win/gui/input_spec.rb

@@ -11,24 +11,35 @@ module WinWindowTest
 
     describe '#keydb_event' do
       spec{ use{ keybd_event(vkey = 0, bscan = 0, flags = 0, extra_info = 0) }}
+      before(:each){ (@app=launch_test_app)}
+      after(:each) do
+        3.times do  # rolling back changes to allow window closing without dialog!
+          keybd_event(VK_CONTROL, 0, KEYEVENTF_KEYDOWN, 0)
+          sleep KEY_DELAY
+          keybd_event('Z'.ord, 0, KEYEVENTF_KEYDOWN, 0)
+          sleep KEY_DELAY
+          keybd_event('Z'.ord, 0, KEYEVENTF_KEYUP, 0)
+          sleep KEY_DELAY
+          keybd_event(VK_CONTROL, 0, KEYEVENTF_KEYUP, 0)
+          sleep KEY_DELAY
+        end
+        close_test_app
+      end
 
       it 'synthesizes a numeric keystrokes, emulating keyboard driver' do
-        test_app do |app|
-          text = '12 34'
-          text.upcase.each_byte do |b| # upcase needed since user32 keybd_event expects upper case chars
-            keybd_event(b.ord, 0, KEYEVENTF_KEYDOWN, 0)
-            sleep KEY_DELAY
-            keybd_event(b.ord, 0, KEYEVENTF_KEYUP, 0)
-            sleep KEY_DELAY
-          end
-          text(app.textarea).should =~ Regexp.new(text)
-          5.times {keystroke(VK_CONTROL, 'Z'.ord)} # rolling back changes to allow window closing without dialog!
+        text = '123'
+        text.upcase.each_byte do |b| # upcase needed since user32 keybd_event expects upper case chars
+          keybd_event(b.ord, 0, KEYEVENTF_KEYDOWN, 0)
+          sleep KEY_DELAY
+          keybd_event(b.ord, 0, KEYEVENTF_KEYUP, 0)
+          sleep KEY_DELAY
         end
+        text(@app.textarea).should =~ Regexp.new(text)
       end
     end # describe '#keydb_event'
-    
+
     describe '#mouse_event' do
-      spec { use {mouse_event( flags = MOUSEEVENTF_ABSOLUTE , dx = 0, dy = 0, data=0, extra_info=0 )}}
+      spec { use {mouse_event( flags = MOUSEEVENTF_ABSOLUTE, dx = 0, dy = 0, data=0, extra_info=0 )}}
       it 'Emulates Mouse clicks'
     end # describe '#mouse_event'
 
@@ -61,41 +72,13 @@ module WinWindowTest
 
       it 'sets cursor`s position, in screen coordinates' do
         SetCursorPos(x=600, y=600).should be_true
-        get_cursor_pos().should == [600,600]
+        get_cursor_pos().should == [600, 600]
         set_cursor_pos(x=0, y=0).should be_true
-        get_cursor_pos().should == [0,0]
+        get_cursor_pos().should == [0, 0]
       end
     end # describe '#set_cursor_pos'
 
   end # Win::Gui::Input, ' defines a set of API functions related to user input'
 
-  describe Win::Gui::Input, ' defines convenience/service methods on top of Windows API' do
-    describe '#keystroke' do
-      spec{ use{ keystroke( vkey = 30, vkey = 30) }}
-
-      it 'emulates combinations of keys pressed (Ctrl+Alt+P+M, etc)' do
-        test_app do |app|
-          keystroke(VK_CONTROL, 'A'.ord)
-          keystroke(VK_SPACE)
-          text(app.textarea).should.should == ' '
-          2.times {keystroke(VK_CONTROL, 'Z'.ord)} # rolling back changes to allow window closing without dialog!
-        end
-      end
-    end # describe '#keystroke'
-
-    describe '#type_in' do
-      spec{ use{ type_in(message = '') }}
-
-      it 'types text message into the window holding the focus' do
-        test_app do |app|
-          text = '12 34'
-          type_in(text)
-          text(app.textarea).should =~ Regexp.new(text)
-          5.times {keystroke(VK_CONTROL, 'Z'.ord)} # rolling back changes to allow window closing without dialog!
-        end
-      end
-    end # describe '#type_in'
-
-  end # Win::Gui::Input, ' defines convenience/service methods on top of Windows API'
 end
 

data/spec/win/gui/window_spec.rb

@@ -651,7 +651,7 @@ module WinWindowTest
     end
 
     describe '#text' do
-      spec{ use{ text = text(any_handle) }}
+      spec{ use{ text = text(any_handle, buffer_size=1024) }}
 
       it 'returns text associated with window by sending WM_GETTEXT message to it' do
         test_app do |app|

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - arvicco
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-28 00:00:00 +04:00
+date: 2010-05-31 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency