minigl 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d77deca3bb6d5d439cb293a9f4782abcba1b9f
-  data.tar.gz: 68bdd7b0fb6c06fb0041717e0895b4f054b67464
+  metadata.gz: 6519693f68d4a4961b9b21e9379f46d76aaf042f
+  data.tar.gz: 9e5058266fb5de59417e4dcf13b6691700da5829
 SHA512:
-  metadata.gz: 7c3b435fe29547b9f1ceb4507bb4fcbfc665cd058c0a22ba5a8843903f60df8908fe0348ca3af1e2aa2d85c7ad990a905ae9edfc5bf0d2fd1073823f822f6910
-  data.tar.gz: 12522cfd3056d20e4afed6f8d89d57dc7f930e47febec71175bae399bf1905da591008ab68b7b14e78479307f291526ecae30c36b4f6a832b6ccae6be4841b0e
+  metadata.gz: 33c31a6af23f16ee8222642845d45f170508fe714a4e79d61aa3e1fc0f53eddc63438935ab5deaea6629ceac7a9c416626afb4e01c99a3682fc3108e9129d20a
+  data.tar.gz: cfeea61e4d33ef190302c82314c346c3ea7d37309dc5db38c42984cc2b29ffdec3bedc27330d07cd361125bdb76ddada346659bb12e25c0c77512568e166b2c4

data/README.md

@@ -22,11 +22,12 @@ this [working game example](https://github.com/victords/aventura-do-saber).
   * An auxiliary, tutorial-like documentation is under construction
 [here](https://github.com/victords/minigl/wiki).
 
-**Version 1.3.1**
+**Version 1.3.2**
 
-  * Introduced the `enabled` and `visible` attributes for the form components.
-  * Fixed issue with right shift for selection in the `TextField`.
-  * Added missing keys to `KB`.
+  * Created documentation for the abstract class `Component`.
+  * Granted read and write access to the `params` attribute for all components.
+  * Fixed issue with `ToggleButton` instantiation with no width and height set.
+  * Added `checked` parameter to the constructor of `ToggleButton`.
 
 **WARNING**: this version can generate incompatibility, because of the parameter
-order in the constructors for `Button`, `ToggleButton` and `TextField`.
+order in the constructor for `ToggleButton`.

data/lib/minigl/forms.rb

@@ -1,9 +1,24 @@
 require_relative 'global'
 
 module AGL
-	class Component # :nodoc:
-		attr_accessor :enabled, :visible
+	# This class is an abstract ancestor for all form components (Button,
+	# ToggleButton and TextField).
+	class Component
+		# Determines whether the control is enabled, i.e., will process user input.
+		attr_accessor :enabled
 		
+		# Determines whether the control is visible, i.e., will be drawn in the
+		# screen and process user input, if enabled.
+		attr_accessor :visible
+		
+		# A container for any parameters to be passed to the code blocks called
+		# in response to events of the control (click of a button, change of the
+		# text in a text field, etc.). More detail can be found in the constructor
+		# for each specific component class.
+		attr_accessor :params
+		
+		# This constructor is for internal use of the subclasses only. Do not
+		# instantiate objects of this class.
 		def initialize x, y, font, text, text_color, disabled_text_color
 			@x = x
 			@y = y
@@ -66,8 +81,8 @@ module AGL
 				if img; @img[0].height
 				else; height; end
 			if center
-				@text_x = x + @w / 2
-				@text_y = y + @h / 2
+				@text_x = x + @w / 2 if @w
+				@text_y = y + @h / 2 if @h
 			else
 				@text_x = x + margin_x
 				@text_y = y + margin_y
@@ -188,9 +203,10 @@ module AGL
 		attr_reader :checked
 		
 		# Creates a ToggleButton. All parameters work the same as in Button,
-		# except the image, +img+, which now has to be composed of two columns
+		# except for the image, +img+, which now has to be composed of two columns
 		# and four rows, the first column with images for the unchecked state,
-		# and the second with images for the checked state.
+		# and the second with images for the checked state, and for +checked+,
+		# which defines the initial state of the ToggleButton.
 		# 
 		# The +action+ block now will always receive a first boolean parameter
 		# corresponding to the value of +checked+. So, if you want to pass
@@ -199,7 +215,7 @@ module AGL
 		#     puts "button was checked" if checked
 		#     # do something with params
 		#   }
-		def initialize x, y, font, text, img, text_color = 0, disabled_text_color = 0, center = true, margin_x = 0, margin_y = 0,
+		def initialize x, y, font, text, img, checked = false, text_color = 0, disabled_text_color = 0, center = true, margin_x = 0, margin_y = 0,
 		               width = nil, height = nil, params = nil, &action
 			super x, y, font, text, nil, text_color, disabled_text_color, center, margin_x, margin_y, width, height, params, &action
 			@img =
@@ -211,6 +227,11 @@ module AGL
 			@h =
 				if img; @img[0].height
 				else; height; end
+			if center
+				@text_x = x + @w / 2
+				@text_y = y + @h / 2
+			end
+			@checked = checked
 		end
 		
 		# Updates the button, checking the mouse movement and buttons to define

data/test/game.rb

@@ -13,7 +13,7 @@ class MyGame < Gosu::Window
     @writer = TextHelper.new @font, 5
     @btn = Button.new(10, 560, @font, "Test", :btn, 0x008000, 0x808080, 0, 0, 0, 0, 0, "friends") { |x| puts "hello #{x}" }
     @btn.enabled = false
-    @chk = ToggleButton.new(210, 560, @font, "Click me", :check, 0xffffff, 0x808080, false, 36, 5, 0, 0, "friends") { |c, x|
+    @chk = ToggleButton.new(210, 560, @font, "Click me", :check, false, 0xffffff, 0x808080, false, 36, 5, 0, 0, "friends") { |c, x|
              puts "hello #{x}, checked: #{c}"
            }
     @txt = TextField.new(10, 520, @font, :text, nil, nil, 15, 5, 16, false, "", nil, 0, 0, 0x0000ff, "test") { |t, x| puts "field #{x}, text: #{t}" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minigl
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Victor David Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-16 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu