fidgit 0.0.2alpha

data/Gemfile

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

data/README.textile

@@ -0,0 +1,138 @@
+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
+
+GPL v3 (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.
+    pack :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 #pack, 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).
+* _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

@@ -0,0 +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"
+end

data/config/default_schema.yml

@@ -0,0 +1,180 @@
+# Default schema for Fidgit
+---
+
+# Define all constant values here. For colours, use [R, G, B] or [R, G, B, A].
+# Reference constants with ?constant_name
+:constants:
+  # General constants (strings and numbers).
+  :scroll_bar_thickness: 12
+
+  # Gosu::Color constants
+  :none: [0, 0, 0, 0]
+
+  :black: [0, 0, 0]
+  :white: [255, 255, 255]
+
+  :very_dark_gray: [50, 50, 50]
+  :dark_gray: [100, 100, 100]
+  :gray: [150, 150, 150]
+  :light_gray: [200, 200, 200]
+
+  :red: [255, 0, 0]
+  :green: [0, 0, 255]
+  :blue: [0, 0, 255]
+
+  :dark_red: [100, 0, 0]
+  :dark_green: [0, 100, 0]
+  :dark_blue: [0, 0, 100]
+
+# Default element attributes.
+:elements:
+  :Button: # < Label
+    :background_color: ?dark_gray
+    :border_color: ?light_gray
+    :border_thickness: 2
+
+    :disabled:
+      :background_color: ?very_dark_gray
+      :border_color: ?gray
+
+    :hover:
+      :background_color: ?gray
+
+  :ColorPicker:
+    :indicator_height: 30
+
+  :ColorWell: # < RadioButton
+    :height: 32
+    :outline_color: ?gray
+    :width: 32
+
+    :checked:
+      :border_color: ?very_dark_gray
+
+  :ComboBox: # < Button
+    :background_color: ?dark_gray
+    :border_color: ?white
+
+  :Composite: # < Container
+    :padding_top: 0
+    :padding_right: 0
+    :padding_bottom: 0
+    :padding_left: 0
+
+  :Container: # < Element
+    :nothing: nil
+
+  :Element:
+    :align_h: :left
+    :align_v: :top
+    :background_color: ?none
+    :background_image: nil
+    :border_color: ?none
+    :border_thickness: 0
+    :color: ?white
+    :font_size: 30
+    :font_name: ''
+    :padding_top: 2
+    :padding_right: 4
+    :padding_bottom: 2
+    :padding_left: 4
+
+  :FileBrowser: # < Composite
+    :pattern: *.*
+    :show_extension: true
+
+  :GridPacker: # < Packer
+    :cell_background_color: ?none
+    :cell_border_color: ?none
+    :cell_border_thickness: 0
+
+  :Group: # < Packer
+    :padding_top: 0
+    :padding_right: 0
+    :padding_bottom: 0
+    :padding_left: 0
+
+  :HorizontalPacker: # < GridPacker
+    :nothing: nil
+
+  :HorizontalScrollBar: # < ScrollBar
+    :height: ?scroll_bar_thickness
+
+  :Label: # < Element
+    :disabled:
+      :color: ?light_gray
+
+  :List:
+    :background_color: ?light_gray
+    :border_color: ?white
+
+  :List::Item:
+    :border_thickness: 0
+
+  :MenuPane:
+    :background_color: ?very_dark_gray
+
+  :MenuPane::Item: # < Button
+    :border_color: ?none
+    :border_thickness: 0
+
+  :MenuPane::Separator: # < Label
+     :line_height: 2
+     :background_color: ?black
+
+  :Packer: # < Container
+    :spacing_h: 4
+    :spacing_v: 4
+
+  :RadioButton: # < Button
+    :checked:
+      :border_color: ?blue
+
+  :ScrollArea: # < Composite
+    :nothing: nil
+
+  :ScrollBar: # < Composite
+    :background_color: ?none
+    :border_color: ?none
+    :handle_color: ?dark_red
+    :rail_color: ?very_dark_gray
+    :rail_width: ?scroll_bar_thickness
+
+  :ScrollWindow: # < Composite
+    :scroll_bar_thickness: ?scroll_bar_thickness
+    :border_color: ?light_gray
+    :border_thickness: 1
+
+  :Slider: # < Element
+    :background_color: ?none
+    :border_color: ?dark_gray
+    :groove_color: ?light_gray
+    :handle_color: ?dark_green
+
+  :Slider::Handle: # < Element
+    :background_color: ?dark_blue
+
+  :TextArea: # < Composite
+    :background_color: ?very_dark_gray
+    :border_color: ?light_gray
+    :caret_color: ?red
+    :caret_period: 500 # In milliseconds
+    :line_spacing: 0
+    :selection_color: ?dark_gray
+
+    :focused:
+      :border_color: ?green
+
+  :ToggleButton: # < Button
+    :toggled:
+      :border_color: ?red
+
+  :ToolTip: # < Label
+    :background_color: ?very_dark_gray
+    :border_color: ?white
+
+  :VerticalPacker: # < GridPacker
+    :nothing: nil
+
+  :VerticalScrollBar: # < ScrollBar
+    :width: ?scroll_bar_thickness

data/examples/_all_examples.rb

@@ -0,0 +1,9 @@
+# Run all examples, one after the other
+require_relative 'helpers/example_window'
+
+
+examples = Dir.glob(File.join(File.dirname(__FILE__), "*.rb")) - [__FILE__]
+examples.each_with_index do |file_name, index|
+  ENV['FIDGIT_EXAMPLES_TEXT'] = "[#{index + 1} of #{examples.size + 1}]"
+  `ruby #{file_name}`
+end

data/examples/align_example.rb

@@ -0,0 +1,56 @@
+require_relative 'helpers/example_window'
+
+# Change font and labels in the schema.
+Fidgit::Element.schema.merge_elements!(Element: { font_size: 24 }, Label: { background_color: "?dark_blue" })
+
+class ExampleState < Fidgit::GuiState
+  ROW_BACKGROUND = Gosu::Color.rgb(0, 100, 0)
+  CELL_BACKGROUND = Gosu::Color.rgb(100, 0, 0)
+  OUTER_BACKGROUND = Gosu::Color.rgb(100, 0, 100)
+
+  def initialize
+    super
+
+    pack :vertical, align: :center, background_color: OUTER_BACKGROUND do
+      label "h => align_h, v => align_v", align_h: :center
+
+      pack :grid, num_columns: 4, align: :center, cell_background_color: CELL_BACKGROUND, background_color: ROW_BACKGROUND, align_h: :fill do
+        label "xxx"
+        label "h fill", align_h: :fill
+        label "h right", align_h: :right
+        label "h center", align_h: :center
+
+
+        pack :vertical do
+          label "xxx"
+          label "xxx"
+        end
+        label "v fill", align_v: :fill
+        label "v center", align_v: :center
+        label "v bottom", align_v: :bottom
+
+        pack :vertical, align_h: :center do
+          label "h center"
+          label "h center"
+        end
+        label "top right", align: [:top, :left]
+        label "bottom left", align_h: :left, align_v: :bottom
+        label "h/v fill", align: :fill
+
+        label ""
+        label "bottom right", align_h: :right, align_v: :bottom
+        label "bottom center", align_h: :center, align_v: :bottom
+        pack :vertical, align_h: :right do
+          label "h right"
+          label "h right"
+        end
+
+        label "Blah, bleh!"
+        label "Yada, yada, yada"
+        label "Bazingo by jingo!"
+      end
+    end
+  end
+end
+
+ExampleWindow.new.show

data/examples/button_and_toggle_button_example.rb

@@ -0,0 +1,27 @@
+require_relative 'helpers/example_window'
+
+# Example for Button and ToggleButton
+class ExampleState < Fidgit::GuiState
+  def initialize
+    super
+
+    pack :vertical do
+      my_label = label "Label", tip: "I'm a label"
+
+      my_button = button("Button", tip: "I'm a button; press me!") do
+        my_label.text = "Pressed the button!"
+      end
+
+      my_toggle_button = toggle_button("ToggleButton", tip: "I'm a button that toggles") do |sender, value|
+        my_label.text = "Turned the toggle button #{value ? "on" : "off"}!"
+      end
+
+      toggle_button("Enable other two buttons", value: true) do |sender, value|
+        my_button.enabled = value
+        my_toggle_button.enabled = value
+      end
+    end
+  end
+end
+
+ExampleWindow.new.show