fidgit 0.2.4 → 0.2.5

data/.gitignore

@@ -1,8 +1,8 @@
-pkg/*
-*.gem
-.bundle
-Gemfile.lock
-doc/
-.yardoc
-README.html
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+doc/
+.yardoc
+README.html
 .idea/

data/.rspec

@@ -1,2 +1,2 @@
---colour
---format documentation
+--colour
+--format documentation

data/CHANGELOG.md

@@ -1,31 +1,31 @@
-Fidgit changelog
-================
-
-v0.2.3
-------
-
-* Exposed #handle accessor for Slider.
-* Made Slider accept being disabled.
-* Made Slider handle show tip.
-
-v0.2.2
-------
-
-* Prevented ToggleButton border colour changing.
-* More careful about stripping out html tags in TextArea.
-
-v0.2.1
-------
-
-* Added: Click in ScrollBar gutter to scroll window by height/width of view window.
-* Added: Click and drag to select text in enabled TextArea.
-* Fixed: Color changes on disabling buttons.
-
-v0.2.0
-------
-
-* Added editable attribute to TextArea (Allows selection, but not alteration).
-* Added Element#font= and :font option.
-* Added Gosu::Color#colorize to use when using in-line text styling.
-* Managed layout of entities and XML tags (Used by Gosu) in TextArea text better (tags still don't like newlines inside them).
+Fidgit changelog
+================
+
+v0.2.3
+------
+
+* Exposed #handle accessor for Slider.
+* Made Slider accept being disabled.
+* Made Slider handle show tip.
+
+v0.2.2
+------
+
+* Prevented ToggleButton border colour changing.
+* More careful about stripping out html tags in TextArea.
+
+v0.2.1
+------
+
+* Added: Click in ScrollBar gutter to scroll window by height/width of view window.
+* Added: Click and drag to select text in enabled TextArea.
+* Fixed: Color changes on disabling buttons.
+
+v0.2.0
+------
+
+* Added editable attribute to TextArea (Allows selection, but not alteration).
+* Added Element#font= and :font option.
+* Added Gosu::Color#colorize to use when using in-line text styling.
+* Managed layout of entities and XML tags (Used by Gosu) in TextArea text better (tags still don't like newlines inside them).
 * Changed license from LGPL to MIT.

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in fidgit.gemspec
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fidgit.gemspec
 gemspec

data/LICENSE.txt

@@ -1,20 +1,20 @@
-Copyright (c) 2012 Bil Bas (Spooner)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+Copyright (c) 2012 Bil Bas (Spooner)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -1,139 +1,139 @@
-h1. Fidgit
-
-Fidgit is a GUI framework built on "Gosu":http://libgosu.org/ and "Chingu":http://ippa.se/chingu
-
-
-h2. Description
-
-The API is inspired by "Shoes":http://shoesrb.com/, but since Shoes is very simplistic, the level of functionality is
-based around "FXRuby":http://www.fxruby.org/ and other GUI APIs.
-Fidgit was originally developed as a part of the Sidney game, but as it got more complex, it was obvious it would be
-useful to separate them.
-
-_WARNING: THIS PROJECT IS IN EARLY ALPHA DEVELOPMENT AND THE API IS LIABLE TO CONTINUOUS CHANGE AND IT IS QUITE UNSTABLE!_
-
-Read the Yard documentation at "rubydoc.info":http://rubydoc.info/github/Spooner/fidgit/master
-
-h2. Aim
-
-Fidgit aims to be a toolkit which will provide the building blocks to quickly create a GUI either for a GUI-based game
-or for options screens and menus within a regular Gosu game.
-
-h2. License
-
-MIT (see COPYING.txt)
-
-h2. Requirements
-
-* Ruby 1.9.2 (sorry, I'm lazy!).
-* Gosu gem 0.7.27.1 ("gem install gosu")
-** "Installing Gosu dependencies on Linux":http://code.google.com/p/gosu/wiki/GettingStartedOnLinux (On Win32 and OS X there are binary gems available)
-* Chingu gem 0.9rc4 ("gem install chingu --pre").
-
-h2. Example
-
-<pre># examples/readme_example.rb
-require 'fidgit'
-
-class MyGame < Chingu::Window
-  def initialize
-    super(640, 480, false)
-
-    # To use the Fidgit features, a Fidgit::GuiState must be active.
-    push_game_state MyGuiState
-  end
-end
-
-class MyGuiState < Fidgit::GuiState
-  def initialize
-    super
-
-    # Create a vertically packed section, centred in the window.
-    vertical align: :center do
-      # Create a label with a dark green background.
-      my_label = label "Hello world!", background_color: Gosu::Color.rgb(0, 100, 0)
-
-      # Create a button that, when clicked, changes the label.
-      button("Goodbye", align_h: :center, tip: "Press me and be done with it!") do
-        my_label.text = "Goodbye cruel world!"
-      end
-    end
-  end
-end
-
-MyGame.new.show
-</pre>
-
-
-h2. API
-
-As well as a cursor and tool-tips that are managed by the GuiState for you, there are several elements you can use inside your GuiState.
-
-Elements are best added by using simple methods (listed below). Most of these method accept a block, some offering access to public methods of the element and others being default event handlers.
-
-The GuiState itself only accepts #vertical/#horizontal/#grid, but any packer or group accepts any other element method.
-
-h3. GuiState methods
-
-* _pack([:vertical|:horizontal|:grid], ...)_ - Add a packer to the state (Block has access to public methods).
-* _clear()_ - remove any packers added to the state.
-* _menu(...)_ - Show a context menu (Block has access to public methods).
-** _item(text, value, ...)_ - Item in a menu (Block handles :clicked_left_mouse_button event).
-** _separator(...)_ - A horizontal separator between menu items.
-* _message(text, ...)_ - Show a message box with button(s) (Block subscribes to a button getting clicked).
-* _file_dialog([:open, :save], ...)_ - Open a file dialog to load or save a file (Block is passed the button pressed and the file path set).
-
-h3. Container methods
-
-h4. Arrangement managers
-
-Fidgit uses automatic packers to manage layout.
-
-* _pack([:vertical|:horizontal|:grid], ...)_ - Packer that packs its component elements (Block has access to public methods).
-* _group(...)_ - Manages any groupable elements put inside it, such as radio-buttons (Block has access to public methods). Best to subscribe to :changed event handler.
-* _scroll_window(...)_ - A window having content larger than what is shown, scrolled with scroll-bars (Block has access to public methods of the contents packer)
-
-h4. Elements
-
-Elements can be placed inside a packer or group.
-
-* _button(text, ...)_ - Button with text and/or icon (Block handles :clicked_left_mouse_button event).
-* _color_picker(...)_ - Red, green and blue sliders and colour indicator (Block handles :changed event).
-* _image_frame(image, ...)_ - Wrapper around a Gosu::Image to embed it in the GUI.
-* _label(text, ...)_ - Label with text and, optionally, an icon (No block accepted).
-* _slider(...)_ - Horizontal slider with handle (Block handles :changed event).
-* _text_area(...)_ - An multi-line element, containing editable text (Block handles :changed event).
-* _toggle_button(text, ...)_ - Button that can be toggled on/off (Block handles :changed event).
-
-h5. Groupable elements
-
-These should be placed within a group (directly or indirectly) and only one of them will be selected. The group manages which one is selected.
-
-* _color_well(color, ...)_ - A radio-button used to pick a colour (Block handles :clicked_left_mouse_button event).
-* _radio_button(text, value, ...)_ - Button that is part of a group (Block handles :clicked_left_mouse_button event).
-
-h5. Compound elements
-
-These elements contain items, which can easily be added from within a block passed to them. One can subscribe to the :changed event, which is usually easier than managing each item separately.
-
-* _combo_box(...)_ - Button that has a drop-down menu attached (Block has access to public methods).
-** _item(text, value, ...)_ - Add an item to a combo box (Block handles :clicked_left_mouse_button event).
-* _list(...)_ - A vertical list of items to select from (Block has access to public methods).
-** _item(text, value, ...)_ - Add an item to a combo box (Block handles :clicked_left_mouse_button event).
-
-
-h2. Alternative GUI frameworks
-
-There are two other GUI tool-kits that work with Gosu:
-
-* "Rubygoo":http://code.google.com/p/rubygoo/
-** Additionally supports "Rubygame":http://rubygame.org/ (as well as Gosu).
-** Only simple widgets are implemented.
-** No longer supported.
-
-* "GGLib":http://code.google.com/p/gglib/ (Gosu GUI Library)
-** Pretty graphical themes.
-** Only simple widgets are implemented.
-** No longer supported (though author has commented that they would like to pick it up again).
-
-Remember that if you primarily want a GUI for your GUI application, not just a GUI in your Gosu game, consider using a dedicated GUI tool-kit, such as "Shoes":http://shoesrb.com/, "FXRuby":http://www.fxruby.org/ or "wxRuby":http://wxruby.rubyforge.org/
+h1. Fidgit
+
+Fidgit is a GUI framework built on "Gosu":http://libgosu.org/ and "Chingu":http://ippa.se/chingu
+
+
+h2. Description
+
+The API is inspired by "Shoes":http://shoesrb.com/, but since Shoes is very simplistic, the level of functionality is
+based around "FXRuby":http://www.fxruby.org/ and other GUI APIs.
+Fidgit was originally developed as a part of the Sidney game, but as it got more complex, it was obvious it would be
+useful to separate them.
+
+_WARNING: THIS PROJECT IS IN EARLY ALPHA DEVELOPMENT AND THE API IS LIABLE TO CONTINUOUS CHANGE AND IT IS QUITE UNSTABLE!_
+
+Read the Yard documentation at "rubydoc.info":http://rubydoc.info/github/Spooner/fidgit/master
+
+h2. Aim
+
+Fidgit aims to be a toolkit which will provide the building blocks to quickly create a GUI either for a GUI-based game
+or for options screens and menus within a regular Gosu game.
+
+h2. License
+
+MIT (see COPYING.txt)
+
+h2. Requirements
+
+* Ruby 1.9.2 (sorry, I'm lazy!).
+* Gosu gem 0.7.27.1 ("gem install gosu")
+** "Installing Gosu dependencies on Linux":http://code.google.com/p/gosu/wiki/GettingStartedOnLinux (On Win32 and OS X there are binary gems available)
+* Chingu gem 0.9rc4 ("gem install chingu --pre").
+
+h2. Example
+
+<pre># examples/readme_example.rb
+require 'fidgit'
+
+class MyGame < Chingu::Window
+  def initialize
+    super(640, 480, false)
+
+    # To use the Fidgit features, a Fidgit::GuiState must be active.
+    push_game_state MyGuiState
+  end
+end
+
+class MyGuiState < Fidgit::GuiState
+  def initialize
+    super
+
+    # Create a vertically packed section, centred in the window.
+    vertical align: :center do
+      # Create a label with a dark green background.
+      my_label = label "Hello world!", background_color: Gosu::Color.rgb(0, 100, 0)
+
+      # Create a button that, when clicked, changes the label.
+      button("Goodbye", align_h: :center, tip: "Press me and be done with it!") do
+        my_label.text = "Goodbye cruel world!"
+      end
+    end
+  end
+end
+
+MyGame.new.show
+</pre>
+
+
+h2. API
+
+As well as a cursor and tool-tips that are managed by the GuiState for you, there are several elements you can use inside your GuiState.
+
+Elements are best added by using simple methods (listed below). Most of these method accept a block, some offering access to public methods of the element and others being default event handlers.
+
+The GuiState itself only accepts #vertical/#horizontal/#grid, but any packer or group accepts any other element method.
+
+h3. GuiState methods
+
+* _pack([:vertical|:horizontal|:grid], ...)_ - Add a packer to the state (Block has access to public methods).
+* _clear()_ - remove any packers added to the state.
+* _menu(...)_ - Show a context menu (Block has access to public methods).
+** _item(text, value, ...)_ - Item in a menu (Block handles :clicked_left_mouse_button event).
+** _separator(...)_ - A horizontal separator between menu items.
+* _message(text, ...)_ - Show a message box with button(s) (Block subscribes to a button getting clicked).
+* _file_dialog([:open, :save], ...)_ - Open a file dialog to load or save a file (Block is passed the button pressed and the file path set).
+
+h3. Container methods
+
+h4. Arrangement managers
+
+Fidgit uses automatic packers to manage layout.
+
+* _pack([:vertical|:horizontal|:grid], ...)_ - Packer that packs its component elements (Block has access to public methods).
+* _group(...)_ - Manages any groupable elements put inside it, such as radio-buttons (Block has access to public methods). Best to subscribe to :changed event handler.
+* _scroll_window(...)_ - A window having content larger than what is shown, scrolled with scroll-bars (Block has access to public methods of the contents packer)
+
+h4. Elements
+
+Elements can be placed inside a packer or group.
+
+* _button(text, ...)_ - Button with text and/or icon (Block handles :clicked_left_mouse_button event).
+* _color_picker(...)_ - Red, green and blue sliders and colour indicator (Block handles :changed event).
+* _image_frame(image, ...)_ - Wrapper around a Gosu::Image to embed it in the GUI.
+* _label(text, ...)_ - Label with text and, optionally, an icon (No block accepted).
+* _slider(...)_ - Horizontal slider with handle (Block handles :changed event).
+* _text_area(...)_ - An multi-line element, containing editable text (Block handles :changed event).
+* _toggle_button(text, ...)_ - Button that can be toggled on/off (Block handles :changed event).
+
+h5. Groupable elements
+
+These should be placed within a group (directly or indirectly) and only one of them will be selected. The group manages which one is selected.
+
+* _color_well(color, ...)_ - A radio-button used to pick a colour (Block handles :clicked_left_mouse_button event).
+* _radio_button(text, value, ...)_ - Button that is part of a group (Block handles :clicked_left_mouse_button event).
+
+h5. Compound elements
+
+These elements contain items, which can easily be added from within a block passed to them. One can subscribe to the :changed event, which is usually easier than managing each item separately.
+
+* _combo_box(...)_ - Button that has a drop-down menu attached (Block has access to public methods).
+** _item(text, value, ...)_ - Add an item to a combo box (Block handles :clicked_left_mouse_button event).
+* _list(...)_ - A vertical list of items to select from (Block has access to public methods).
+** _item(text, value, ...)_ - Add an item to a combo box (Block handles :clicked_left_mouse_button event).
+
+
+h2. Alternative GUI frameworks
+
+There are two other GUI tool-kits that work with Gosu:
+
+* "Rubygoo":http://code.google.com/p/rubygoo/
+** Additionally supports "Rubygame":http://rubygame.org/ (as well as Gosu).
+** Only simple widgets are implemented.
+** No longer supported.
+
+* "GGLib":http://code.google.com/p/gglib/ (Gosu GUI Library)
+** Pretty graphical themes.
+** Only simple widgets are implemented.
+** No longer supported (though author has commented that they would like to pick it up again).
+
+Remember that if you primarily want a GUI for your GUI application, not just a GUI in your Gosu game, consider using a dedicated GUI tool-kit, such as "Shoes":http://shoesrb.com/, "FXRuby":http://www.fxruby.org/ or "wxRuby":http://wxruby.rubyforge.org/

data/Rakefile

@@ -1,38 +1,38 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'yard'
-require 'redcloth'
-
-README_HTML = "README.html"
-README_TEXTILE = "README.textile"
-
-class EventHandlesHandler < YARD::Handlers::Ruby::Base
-  handles method_call(:handles)
-
-  def process
-    klass = statement.parent.parent.jump(:const)[0]
-    name = statement.method_name(true)
-    params = statement.parameters(false).dup
-    puts "Processing Event method: #{klass}.#{name} :#{params[0].jump(:ident)[0]}"
-  end
-end
-
-
-YARD::Rake::YardocTask.new
-task :yard => README_HTML
-
-desc "Convert readme to HTML"
-file README_HTML => :readme
-task :readme => README_TEXTILE do
-  puts "Converting readme to HTML"
-  File.open(README_HTML, "w") do |file|
-    file.write RedCloth.new(File.read(README_TEXTILE)).to_html
-  end
-end
-
-# Specs
-desc "Run rspec 2.0"
-task :rspec do
-  system "rspec spec"
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'yard'
+require 'redcloth'
+
+README_HTML = "README.html"
+README_TEXTILE = "README.textile"
+
+class EventHandlesHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:handles)
+
+  def process
+    klass = statement.parent.parent.jump(:const)[0]
+    name = statement.method_name(true)
+    params = statement.parameters(false).dup
+    puts "Processing Event method: #{klass}.#{name} :#{params[0].jump(:ident)[0]}"
+  end
+end
+
+
+YARD::Rake::YardocTask.new
+task :yard => README_HTML
+
+desc "Convert readme to HTML"
+file README_HTML => :readme
+task :readme => README_TEXTILE do
+  puts "Converting readme to HTML"
+  File.open(README_HTML, "w") do |file|
+    file.write RedCloth.new(File.read(README_TEXTILE)).to_html
+  end
+end
+
+# Specs
+desc "Run rspec 2.0"
+task :rspec do
+  system "rspec spec"
 end