wet-winobj 0.1-mswin32

data/src/wet/winobjects/AppWindow.rb

@@ -0,0 +1,144 @@
+=begin license
+Copyright (c) 2005, Qantom Software
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
+Neither the name of Qantom Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(based on BSD Open Source License)
+=end
+
+
+require 'wet/winobjects/Window.rb'
+require 'wet/winobjects/WinDialog.rb'
+
+module Wet
+    module Winobjects
+    
+=begin rdoc
+    The AppWindow is a top level application window like a browser
+    window. 
+=end
+        class AppWindow < Window
+        
+=begin rdoc
+        Constructor to create a new instance of the app window
+        You usually dont have to do it directly. However using it 
+        directly can come in handy. For example in WET / Watir you 
+        could create a new AppWindow object by passing the browser's
+        hwnd. 
+=end
+        def initialize(wnd_hwnd)
+            super
+            if @hwnd != -1
+                @title = window_caption(@hwnd) 
+                @parent = parent_window(@hwnd)
+                @class_name = class_name(@hwnd)
+            end
+        end  
+        
+=begin rdoc
+        Helper utilitiy to find an AppWindow using the passed properties. 
+        
+        Most of the times you dont have to call this method directly. From 
+        the main wet-winobjects module, if you say app_window(name => value) , then the required AppWindow instance is generated. 
+=end
+        def AppWindow.find(props)
+            CompileUtils.assert_argument_types(Hash, props.class) 
+            arg_length = props.length 
+            found_wnd = -1
+            new_wnd = nil
+            if props.length == 1 && props['title'] != nil
+                title = props['title']
+                found_wnd = find_window(title) 
+            else                
+                raise UnsupportedOperationException.new("Can only search windows using title")
+            end     
+            new_wnd = AppWindow.new(found_wnd) 
+            return new_wnd
+        end
+        
+=begin rdoc
+        Acivate this window and bring it to top
+=end
+        def activate()
+            assert_object_exists
+            old_active = set_active_window(@hwnd) 
+        end
+        
+=begin rdoc
+        Set the current windows state to 'maximized' 
+=end
+        def maximize()
+            assert_object_exists
+            mx = do_maximize(@hwnd) 
+        end
+
+=begin rdoc
+        Set the current windows state to 'minimized' 
+=end
+        def minimize()
+            assert_object_exists
+            mn = do_minimize(@hwnd) 
+        end        
+                
+        def title()
+            assert_object_exists
+            return @title
+        end
+        
+=begin rdoc
+        Close the current application window
+=end        
+        def close()
+            assert_object_exists
+            return do_destroy_window(@hwnd) 
+        end
+        
+
+            
+=begin rdoc
+        Return a text that is an aggregate of all 'displayed' text elements. 
+=end
+        def content_text()        
+            ret_text=""             
+            child_objects.each do |c|                    
+                    ret_text=ret_text+c.display_text()            
+            end            
+            return ret_text
+        end        
+
+=begin rdoc
+        Get a 'Dialog' that is owned by this AppWindow. 
+        
+        The props parameter is a hashtable of expected properties' name / value. 
+        
+        In the current version the following properties can be used:
+        1) 'text' -  The title of the WinDialog that is associated with this
+        control. 
+        eg:- 
+        If you say myWindow.win_dialog("text" => "Expected"), then the method
+        will return the Dialog whose title is 'Expected'. Returns an 
+        empty WinEdit otherwise
+=end
+        def dialog(props = nil)
+            assert_object_exists
+            return WinDialog::find(@hwnd, props)
+        end
+            
+
+
+        def to_s()
+            str = "AppWindow(title:="
+            str = str + text()
+            str = str + ")" 
+            return str 
+        end
+            
+        end
+    end
+end

data/src/wet/winobjects/WinButton.rb

@@ -0,0 +1,101 @@
+=begin license
+Copyright (c) 2005, Qantom Software
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
+Neither the name of Qantom Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(based on BSD Open Source License)
+=end
+
+module Wet
+    module Winobjects
+=begin
+    Class to represent a win32 button
+=end
+        class WinButton < Window
+    
+            @@known_class_names = ["Button"]
+            
+=begin rdoc
+        Constructor. Typically not invoked directly
+=end
+            def initialize(hwnd)
+                super
+                if @hwnd != -1
+                    find_button_styles()
+                end
+            end
+            
+=begin rdoc
+        Is the Window object a possible candidate for this class?
+        Return true if yes. False otherwise. 
+=end
+#Note : - in the interest of reusable design, I had first put it this as a method
+#in Window. But then I realized that each class may have to make complex 
+#calculations - eg. A label could be a static or an edit field set to read-only
+            def WinButton.candidate_match?(win_element)
+                is_match = false
+                @@known_class_names.each do |e|                    
+                    if TextUtils.compare_text(win_element.win_class,e) 
+                        is_match = true 
+                        break 
+                    end
+                end
+                return is_match            
+            end 
+            
+=begin rdoc
+            Is this button a radio button ? 
+            Return true if it is, false otherwise
+=end
+            def is_radio()
+                assert_object_exists
+                return @is_radio
+            end
+            
+=begin rdoc
+        Is this button a checkbox?
+        Return true if it is, false otherwise. 
+=end
+            def is_checkbox()
+                assert_object_exists                
+                return @is_checkbox
+            end 
+            
+=begin rdoc
+            Perform a click operation on this button
+=end
+            def click()
+                assert_object_exists
+                do_button_click(@hwnd)
+            end
+            
+            def to_s()
+                str = "WinButton(text:="
+                str = str + text()
+                str = str + ")" 
+                return str 
+            end
+            
+            protected
+            def button_state()
+                assert_object_exists
+                do_get_button_state(@hwnd)
+            end            
+            
+            protected
+            def find_button_styles()
+                @control_style = get_win_style()
+                @is_radio = @control_style & BS_AUTORADIOBUTTON == BS_AUTORADIOBUTTON
+                @is_checkbox = @control_style & BS_AUTOCHECKBOX ==BS_AUTOCHECKBOX
+            end
+
+        end
+    end
+    
+end

data/src/wet/winobjects/WinCheckbox.rb

@@ -0,0 +1,84 @@
+=begin license
+Copyright (c) 2005, Qantom Software
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
+Neither the name of Qantom Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(based on BSD Open Source License)
+=end
+
+module Wet
+    module Winobjects
+=begin
+    Class to represent a win32 button
+=end
+        class WinCheckbox < WinButton
+    
+            @@known_class_names = ["Button"]
+            
+
+            
+=begin rdoc
+        Is the Window object a possible candidate for this class?
+        Return true if yes. False otherwise. 
+=end
+#Note : - in the interest of reusable design, I had first put it this as a method
+#in Window. But then I realized that each class may have to make complex 
+#calculations - eg. A label could be a static or an edit field set to read-only
+            def WinCheckbox.candidate_match?(win_element)
+                is_match = false
+                @@known_class_names.each do |e|                    
+                    if TextUtils.compare_text(win_element.win_class,e) 
+                        tmp_button = WinButton.new(win_element.hwnd) 
+                        if tmp_button.is_checkbox()                        
+                            is_match = true 
+                            break 
+                        end
+                    end
+                end
+                return is_match            
+            end 
+            
+=begin rdoc
+            Is the radio button 'checked'?
+            Return true if yes. False otherwise
+=end            
+            def is_checked()
+                assert_object_exists
+                return button_state()== BST_CHECKED
+            end
+            
+            
+=begin rdoc
+        Set this checkbox to 'Checked' state
+=end
+            def set_on()
+                assert_object_exists
+                do_set_check_on(@hwnd) 
+            end
+
+=begin rdoc
+        Clear this checkbox if already checked 
+=end
+            def set_off()
+                assert_object_exists
+                do_set_check_off(@hwnd) 
+            end
+            
+            def to_s()
+                str = "WinCheckbox(text:="
+                str = str + text()
+                str = str + ")" 
+                return str 
+            end
+
+            
+        end
+    end
+    
+end

data/src/wet/winobjects/WinComboBox.rb

@@ -0,0 +1,70 @@
+=begin license
+Copyright (c) 2005, Qantom Software
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
+Neither the name of Qantom Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(based on BSD Open Source License)
+=end
+
+module Wet
+    module Winobjects
+=begin rdoc
+    Class to represent a Win32 Combobox. 
+=end
+        class WinComboBox < Window            
+    
+            @@known_class_names = [/ComboBox/]
+            
+=begin rdoc
+        Is the Window object a possible candidate for this class?
+        Return true if yes. False otherwise. 
+=end
+#Note : - in the interest of reusable design, I had first put it this as a method
+#in Window. But then I realized that each class may have to make complex 
+#calculations - eg. A label could be a static or an edit field set to read-only
+            def WinComboBox.candidate_match?(win_element)
+                is_match = false
+                @@known_class_names.each do |e|                    
+                    if TextUtils.compare_text(win_element.win_class,e) 
+                        is_match = true 
+                        break 
+                    end
+                end
+                return is_match            
+            end 
+            
+=begin 
+    Set the text in a combo box
+=end
+            def set(text)
+                assert_object_exists
+                return do_set_text(@hwnd, text) 
+            end
+            
+=begin
+    We dont want to return the child objects of a combobox
+    The edit control / second combo are a part of the combobox
+=end
+            def child_objects()
+                assert_object_exists
+                return []
+            end
+            
+            def to_s()
+                str = "WinComboBox(label:="
+                if label != nil
+                    str = str + label()
+                end
+                str = str + ")" 
+                return str 
+            end
+            
+        end
+    end
+end

data/src/wet/winobjects/WinDialog.rb

@@ -0,0 +1,112 @@
+=begin license
+Copyright (c) 2005, Qantom Software
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
+Neither the name of Qantom Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(based on BSD Open Source License)
+=end
+
+
+require 'wet/winobjects/Window.rb'
+
+module Wet
+    module Winobjects
+    
+=begin rdoc
+    Class representing any Win32 window.  This class
+    has elements to access all of the known (actually currently 
+    used in the context of Web Testing) types of objects like
+    Button, Edit and ComboBox
+=end
+        class WinDialog < Window      
+
+        def initialize(parent, hwnd)
+            super(hwnd) 
+            @owner = AppWindow.new(parent) 
+        end
+        
+=begin rdoc
+        Find a Dialog whose parent is parent_hwnd and 
+        properties matches 'props'. If props is nill, then 
+        the active popup dialog is returned. 
+        
+        The allowed properties are:
+        1) text - The title of this dialog box. 
+        
+        You typically dont have to call this directly. The wrapper
+        method in the AppWindow will do it for you.
+        myAppWindow.Dialog("text" => "Microsoft internet")
+=end
+        # if props is nil, then the dialog that is owned by the 
+        # parent is returned. 
+        def WinDialog.find(parent_hwnd, props=nil)
+            if props == nil
+                props = {"title" => /.*/}
+            end
+            CompileUtils.assert_argument_types(Hash, props.class)            
+            tmp_hwnd = -1 
+            timeout(Object_timeout) do 
+                while tmp_hwnd == -1
+                    tmp_hwnd = enabled_popup(parent_hwnd) 
+                    if tmp_hwnd == -1
+                        sleep 1 
+                    end
+                end
+            end
+            
+            # This is not the right way to do it. If a popup is found, but title
+            # doesn't match, actual approach would be to go back to the start
+            # of the timeout loop and try again waiting for another active popup.
+            #But right now just return nil if the title doesn't match
+            if props.length == 1 && props['title'] != nil
+                title = props['title']
+                act=window_caption(tmp_hwnd)
+                if !TextUtils.compare_text(act, title) 
+                    tmp_hwnd = -1 
+                end                
+            else
+                raise UnsupportedOperationException.new("Can only search windows using title")
+            end
+            
+            dlg = WinDialog.new(parent_hwnd, tmp_hwnd) 
+            
+            return dlg
+        end
+        
+=begin rdoc
+        Return the owner of this dialog box. Popup dialog boxes
+        are usually owned by some other windows. 
+=end
+        def owner()
+            assert_object_exists
+            return @owner
+        end
+        
+            
+=begin rdoc
+        Return a text that is an aggregate of all 'displayed' text elements. 
+=end        
+        def content_text()        
+            ret_text=""             
+            child_objects.each do |c|                    
+                    ret_text=ret_text+c.display_text()            
+            end            
+            return ret_text
+        end
+            
+        def to_s()
+            str = "Dialog(title:="
+            str = str + text()
+            str = str + ")" 
+            return str 
+        end
+            
+        end
+    end
+end