wx_sugar 0.1.13 → 0.1.14

data/lib/wx_sugar/all.rb

@@ -1,71 +1,3 @@
-# = WxSugar
-# 
-# WxSugar is a set of additions to the WxRuby API, written in pure
-# ruby. They're intended to:
-#  
-# * Make some tricky WxWidgets things easier and more consistent
-# * Reduce repetitiveness and redundancy for common tasks
-# * Make code more expressive
-# * Make code more idiomatically Rubyish
-#
-# Not everyone will like all the extensions to WxRuby here. So the
-# Sugar modules:
-#
-# * Can generally be used separately, without depending on each other
-# * Supplement rather than replace the underlying 'raw' API
-# 
-# == Using WxSugar
-# 
-# The extensions can currently be used with WxRuby2 or the old WxRuby
-# (0.6.0). WxRuby2 is strongly recommended, and support for the old
-# series may be dropped in the future.
-# 
-# The simplest way to use WxSugar is to load all the behaviours. You
-# should load the wx library first:
-#
-#  require 'wx'
-#   # OR ... old non-SWIG beta veresion
-#  require 'wxruby'
-# 
-#  require 'wx_sugar/all'
-#  ... 
-# 
-# If you only want to load specific WxSugar behaviours, just +require+
-# the desired extensions only
-#  
-#  require 'wx_sugar/keyword_constructors'
-#  require 'wx_sugar/acccessors'
-#
-# == Overview of extensions
-# 
-# The following are the WxSugar behaviours that are available. In
-# general you require one of these extensions, it modifies the behaviour
-# of all relevant Wx classes, and affects all new instances.
-#
-# [accessors] 
-#  Provide ruby-style getters, setters and question-mark methods
-# [delayed_constructors] 
-#  Required by +layout+, of limited independent interest
-# [event_connector] 
-#  Neater syntax for connecting event listeners
-# [keyword_constructors] 
-#  Use keyword-style hash arguments to construct widgets
-# [layout] 
-#  Easy interface to using WxWidgets Sizers to arrange controls
-# [menu] 
-#  Create and update menus without a mess of system ids
-# [wx_classes]
-#  Useful ruby methods added to individual Wx classes.
-#
-# === Deprecated extensions
-#
-# This module is deprecated and will soon be removed.
-#
-# [itemdata.rb] 
-#  Linking ruby objects with wx controls; use the
-#  get/set_item_data methods in core wxruby2 instead.
-
-
 %w[ accessors delayed_constructors event_connector 
     keyword_constructors layout menu wx_classes ].each do | ext_feature |
   require 'wx_sugar/' + ext_feature    

data/lib/wx_sugar/keyword_classes.rb

@@ -5,13 +5,6 @@
 # and is no use on its own - except if you are looking for a bug or want
 # to add a  missing class.
 
-# This is a dummy, this variable is not loaded until Wx init
-# hush warnings if it has already been loaded when we get here
-v = $VERBOSE
-$VERBOSE = nil
-Wx::NULL_BITMAP = nil
-$VERBOSE = v
-
 module WxSugar
   @defined_classes = {}
 
@@ -85,6 +78,18 @@ WxSugar.define_keyword_ctors('MiniFrame') do
 end
 
 # wxSplashScreen 	Splash screen class
+# FIXME - this probably won't work at present because the 'parent' arg
+# comes in a funny place in this class's ctor
+# 
+# WxSugar.define_keyword_ctors('SplashScreen') do
+#   wx_ctor_params :bitmap => Wx::NULL_BITMAP
+#   wx_ctor_params :splashstyle, :milliseconds, :id => 1
+#   wx_ctor_params :parent => nil
+#   wx_ctor_params :title => ''
+#   wx_ctor_params :pos, :size
+#   wx_ctor_params :style => Wx::SIMPLE_BORDER|Wx::FRAME_NO_TASKBAR|Wx::STAY_ON_TOP
+# end
+
 # wxPropertySheetDialog 	Property sheet dialog
 # wxTipWindow 	Shows text in a small window
 
@@ -262,18 +267,19 @@ end
 WxSugar.define_keyword_ctors('Button') do
   wx_ctor_params :label => ''
   wx_ctor_params :pos, :size, :style
-#  wx_ctor_params :validator, :name => 'button'
+  wx_ctor_params :validator, :name => 'button'
 end
 
 # Push button control, displaying a bitmap
 WxSugar.define_keyword_ctors('BitmapButton') do
   wx_ctor_params :bitmap, :pos, :size, :style => Wx::BU_AUTODRAW
+  wx_ctor_params :validator, :name => 'button'
 end
 
 # A button which stays pressed when clicked by user.
 WxSugar.define_keyword_ctors('ToggleButton') do
   wx_ctor_params :label, :pos, :size, :style
-  # wx_ctor_params :validator, :name => 'checkBox'
+  wx_ctor_params :validator, :name => 'checkBox'
 end
 
 # Control showing an entire calendar month
@@ -287,27 +293,27 @@ end
 WxSugar.define_keyword_ctors('CheckBox') do
   wx_ctor_params :label => ''
   wx_ctor_params :pos, :size, :style
-  # wx_ctor_params :validator, :name => 'checkBox'
+  wx_ctor_params :validator, :name => 'checkBox'
 end
 
 # A listbox with a checkbox to the left of each item
 WxSugar.define_keyword_ctors('CheckListBox') do 	
   wx_ctor_params :pos, :size, :choices, :style
-  # wx_ctor_params :validator, :name => 'listBox'
+  wx_ctor_params :validator, :name => 'listBox'
 end
 
 # wxChoice 	Choice control (a combobox without the editable area)
 WxSugar.define_keyword_ctors('Choice') do
   wx_ctor_params :pos, :size, :choices, :style
-#  wx_ctor_params :validator, :name => 'choice'
+  wx_ctor_params :validator, :name => 'choice'
 end
 
 # wxComboBox 	A choice with an editable area
 WxSugar.define_keyword_ctors('ComboBox') do
   wx_ctor_params :value => ''
   wx_ctor_params :pos, :size, :choices => []
-  wx_ctor_params :style
-#  wx_ctor_params :validator, :name => 'comboBox'
+  wx_ctor_params :style 
+  wx_ctor_params :validator, :name => 'comboBox'
 end
 
 # wxDatePickerCtrl 	Small date picker control
@@ -316,7 +322,7 @@ end
 # remaining
 WxSugar.define_keyword_ctors('Gauge') do
   wx_ctor_params :range, :pos, :size, :style => Wx::GA_HORIZONTAL
-  # wx_ctor_params :validator, :name
+  wx_ctor_params :validator, :name
 end
 
 # wxGenericDirCtrl 	A control for displaying a directory tree
@@ -336,12 +342,13 @@ end
 WxSugar.define_keyword_ctors('ListBox') do
   wx_ctor_params :pos, :size, :choices => []
   wx_ctor_params :style
+  wx_ctor_params :validator, :name => 'listBox'
 end
 
 # wxListCtrl 	A control for displaying lists of strings and/or icons, plus a multicolumn report view
 WxSugar.define_keyword_ctors('ListCtrl') do
   wx_ctor_params :pos, :size, :style => Wx::LC_ICON
-#  wx_ctor_params :validator, :name => 'listCtrlNameStr'
+  wx_ctor_params :validator, :name => 'listCtrl'
 end
 
 # wxListView 	A simpler interface (facade for wxListCtrl in report mode
@@ -349,7 +356,7 @@ end
 # wxTreeCtrl 	Tree (hierarchy) control
 WxSugar.define_keyword_ctors('TreeCtrl') do
   wx_ctor_params :pos, :size, :style => Wx::TR_HAS_BUTTONS
-#  wx_ctor_params :validator, :name => 'treeCtrl'
+  wx_ctor_params :validator, :name => 'treeCtrl'
 end
 
 # wxSpinCtrl 	A spin control - i.e. spin button and text control
@@ -388,14 +395,14 @@ WxSugar.define_keyword_ctors('RadioBox') do
   wx_ctor_params :pos, :size, :choices => []
   wx_ctor_params :major_dimension => 0
   wx_ctor_params :style => Wx::RA_SPECIFY_COLS
-  #  wx_ctor_params :validator, :name => 'radioBox'
+  wx_ctor_params :validator, :name => 'radioBox'
 end
 
-# wxRadioButton 	A round button to be used with others in a mutually exclusive way
+# wxRadioButton: A round button used with others in a mutually exclusive way
 WxSugar.define_keyword_ctors('RadioButton') do
   wx_ctor_params :label => ''
   wx_ctor_params :pos, :size, :style => 0
-  #  wx_ctor_params :validator, :name => 'radioButton'
+  wx_ctor_params :validator, :name => 'radioButton'
 end
 
 # wxSlider 	A slider that can be dragged by the user
@@ -403,10 +410,9 @@ WxSugar.define_keyword_ctors('Slider') do
   wx_ctor_params :value => 0
   wx_ctor_params :min_value, :max_value
   wx_ctor_params :pos, :size, :style => Wx::SL_HORIZONTAL
-  #  wx_ctor_params :validator, :name => 'radioButton'
+  wx_ctor_params :validator, :name => 'slider'
 end
 
-
 # wxSpinButton - Has two small up and down (or left and right) arrow buttons
 WxSugar.define_keyword_ctors('SpinButton') do
    wx_ctor_params :pos, :size, :style => Wx::SP_HORIZONTAL
@@ -419,7 +425,7 @@ end
 WxSugar.define_keyword_ctors('TextCtrl') do
   wx_ctor_params :value => ''
   wx_ctor_params :pos, :size, :style
-  # wx_ctor_params validator, :name => 'textCtrl'
+  wx_ctor_params :validator, :name => 'textCtrl'
 end
 
 # wxHtmlWindow - Control for displaying HTML

data/lib/wx_sugar/keyword_constructors.rb

@@ -106,7 +106,7 @@ module KeywordConstructor
       :size      => Wx::DEFAULT_SIZE,
       :pos       => Wx::DEFAULT_POSITION,
       :style     => 0,
-      :validator => nil, # Should be Wx::DefaultValidator
+      :validator => Wx::DEFAULT_VALIDATOR,
       :choices   => [] # for Choice, ComboBox etc
     }
 

data/lib/wx_sugar/layout.rb

@@ -67,7 +67,9 @@ module Arranger
     elsif sizer = self.get_sizer
       return sizer
     else
-      return @current_sizer = Wx::BoxSizer.new(Wx::VERTICAL)
+      @current_sizer = Wx::BoxSizer.new(Wx::VERTICAL)
+      self.set_sizer(@current_sizer)
+      @current_sizer
     end
   end
   
@@ -93,7 +95,7 @@ module Arranger
       end
 
       superior_sizer, @current_sizer = @current_sizer, a_sizer
-      yield(self)
+      yield(a_sizer)
       @current_sizer = superior_sizer
       proportion = layout[:proportion] || 0
       this_padding = padding || 0
@@ -106,9 +108,12 @@ module Arranger
       end
     # set as main sizer            
     else
+      if @current_sizer
+        warn "Sizer already specified, redefining layout for #{self}"
+      end        
       @padding = layout[:padding] if layout[:padding]
       @current_sizer = a_sizer
-      yield(self) if block_given?
+      yield(a_sizer) if block_given?
       self.set_sizer(a_sizer)
     end
   end
@@ -123,7 +128,7 @@ module Arranger
     child  = build_child(child)
     layout = hints_to_constants(layout_hints)
     proportion = layout_hints[:proportion] || 0
-    siz = self.current_sizer()
+    siz = self.current_sizer
     padding = layout_hints[:padding] || @padding
     siz.add(child, proportion, layout, padding || 0)
     siz.layout()
@@ -205,11 +210,17 @@ module Arranger
     end
   end
 
-
   # Convert a hash of layout hints to WxWidgets Sizer constants
+  
   def hints_to_constants(layout_hints)
-    layout = Wx::ALL
-    
+    if layout_hints[:pad]
+      layout = layout_hints[:pad].split(',').inject(0) do | l, edge |
+        l | Wx::const_get(edge.upcase)
+      end
+    else
+      layout = Wx::ALL
+    end
+
     if layout_hints[:minsize]
       layout = layout | Wx::ADJUST_MINSIZE|Wx::EXPAND
     end
@@ -218,9 +229,9 @@ module Arranger
     end
 
     
-    if layout_hints[:align]
+    if align = layout_hints[:align]
       begin
-        align_const = Wx::const_get('ALIGN_' << layout_hints[:align].to_s.upcase)
+        align_const = Wx::const_get('ALIGN_' << align.to_s.upcase)
         layout = layout | align_const
       rescue NameError
         Kernel.raise ArgumentError,

data/lib/wx_sugar/version.rb

@@ -1,3 +1,3 @@
 module WxSugar
-  VERSION = '0.1.13'
+  VERSION = '0.1.14'
 end

data/lib/wx_sugar/wx_classes/position.rb

@@ -0,0 +1,7 @@
+class Wx::Position
+  # Checks if this equal to Wx::DEFAULT_POSITION (i.e. no explicit
+  # co-ordinates set)
+  def default?
+    x == -1 and y == -1
+  end
+end

data/lib/wx_sugar/wx_classes/size.rb

@@ -0,0 +1,7 @@
+class Wx::Size
+  # Checks if this equal to Wx::DEFAULT_SIZE (i.e. no explicit
+  # dimensions set)
+  def default?
+    get_width == -1 and get_height == -1
+  end
+end

data/lib/wx_sugar/wx_classes/treectrl.rb

@@ -0,0 +1,19 @@
+class Wx::TreeCtrl
+  # Recurses over the tree item +start_item+ and its descendants,
+  # yielding each Wx::TreeItemId in turn into the passed block. This
+  # TreeItemId can be used as an argument to many other methods within
+  # TreeCtrl (for example, get_item_text).
+  #
+  # If +start_item+ is not specified, this method will recurse over
+  # every item within the tree, starting with the root item.
+  def traverse(start_item = self.get_root_item, &block)
+    block.call(start_item)
+    if has_children(start_item)
+      child, cookie = get_first_child(start_item)
+      while child.nonzero?
+        traverse(child, &block)
+        child = get_next_sibling(child)
+      end
+    end
+  end
+end

data/lib/wx_sugar/wx_classes/window.rb

@@ -1,5 +1,26 @@
 # extensions to Wx::Window
 class Wx::Window
+  # Returns an array containing this window and all windows descended
+  # from it.
+  def get_descendants
+    get_children.inject([ self ]) do | desc, child |
+      desc + child.get_descendants
+    end
+  end
+
+  # Passed a block, returns the first window within self's window
+  # hierarchy for which the block evaluates to true. A class name may
+  # optionally be passed to restrict the search to windows of that class
+  # (or its subclasses) only - this can be useful if the search
+  # specification calls methods that are only defined for certain
+  # classes.
+  #
+  #  # Example - find a StaticText with a label matching /foo/
+  #  a_frame.find_window(Wx::StaticText) { | tx | tx.label =~ /foo/ }
+  def find_window(a_class = Wx::Window, &block)
+    descendants.grep(a_class).detect(&block)
+  end
+
   # Returns the window's current size as a two element array
   def get_size_xy
     size = get_size

data/lib/wx_sugar.rb

@@ -1 +1,66 @@
+# = WxSugar
+# 
+# WxSugar is a set of additions to the WxRuby API, written in pure
+# ruby. They're intended to:
+#  
+# * Make some tricky WxWidgets things easier and more consistent
+# * Reduce repetitiveness and redundancy for common tasks
+# * Make code more expressive
+# * Make code more idiomatically Rubyish
+#
+# Not everyone will like all the extensions to WxRuby here. So the
+# Sugar modules:
+#
+# * Can generally be used separately, without depending on each other
+# * Supplement rather than replace the underlying 'raw' API
+# 
+# == Using WxSugar
+# 
+# As of version 0.1.14, the WxSugar extensions require the latest
+# version of WxRuby2, preview 0.0.39. Support for the old series of
+# WxRuby (version 0.6.0) has now been dropped. 
+# 
+# The simplest way to use WxSugar is to load all the behaviours. You
+# should load the wx library first:
+#
+#  require 'wx'
+#  require 'wx_sugar'
+#  ... 
+#
+# If you only want to load specific WxSugar behaviours, just +require+
+# the desired extensions only
+#  
+#  require 'wx_sugar/keyword_constructors'
+#  require 'wx_sugar/acccessors'
+#
+# == Overview of extensions
+# 
+# The following are the WxSugar behaviours that are available. In
+# general you require one of these extensions, it modifies the behaviour
+# of all relevant Wx classes, and affects all new instances.
+#
+# [accessors] 
+#  Provide ruby-style getters, setters and question-mark methods
+# [delayed_constructors] 
+#  Required by +layout+, of limited independent interest
+# [event_connector] 
+#  Neater syntax for connecting event listeners
+# [keyword_constructors] 
+#  Use keyword-style hash arguments to construct widgets
+# [layout] 
+#  Easy interface to using WxWidgets Sizers to arrange controls
+# [menu] 
+#  Create and update menus without a mess of system ids
+# [wx_classes]
+#  Useful ruby methods added to individual Wx classes.
+#
+# === Deprecated extensions
+#
+# This module is deprecated and will soon be removed.
+#
+# [itemdata.rb] 
+#  Linking ruby objects with wx controls; use the
+#  get/set_item_data methods in core wxruby2 instead.
+
+
 require 'wx_sugar/all'

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.9.0
 specification_version: 1
 name: wx_sugar
 version: !ruby/object:Gem::Version 
-  version: 0.1.13
-date: 2006-12-03
+  version: 0.1.14
+date: 2007-03-22 00:00:00 +00:00
 summary: Syntax extensions for WxRuby.
 require_paths: 
   - lib
@@ -24,6 +24,9 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
         version: 1.8.1
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
 authors: 
   - Alex Fenton
 files: 
@@ -43,6 +46,9 @@ files:
   - lib/wx_sugar/wx_classes
   - lib/wx_sugar/wx_classes.rb
   - lib/wx_sugar/wx_classes/colour.rb
+  - lib/wx_sugar/wx_classes/position.rb
+  - lib/wx_sugar/wx_classes/size.rb
+  - lib/wx_sugar/wx_classes/treectrl.rb
   - lib/wx_sugar/wx_classes/window.rb
   - samples/sugar-sample.rb
   - LICENCE