wx_sugar 0.1.2 → 0.1.13

data/lib/wx_sugar/all.rb

@@ -16,10 +16,13 @@
 # 
 # == Using WxSugar
 # 
-# The extensions can currently be used with either WxRuby (0.6.0) or
-# WxRuby2 (the SWIG version). To use all of the extensions, simple write
+# 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:
 #
-#   # EITHER ... New development
 #  require 'wx'
 #   # OR ... old non-SWIG beta veresion
 #  require 'wxruby'
@@ -27,31 +30,43 @@
 #  require 'wx_sugar/all'
 #  ... 
 # 
-# If you only want to load specific behaviours, just +require+ the
-# desired extensions only
+# 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.rb] 
+# [accessors] 
 #  Provide ruby-style getters, setters and question-mark methods
-# [delayed_constructors.rb] 
-#  For use with +layout+, limited independent interest
-# [event_connector.rb] 
+# [delayed_constructors] 
+#  Required by +layout+, of limited independent interest
+# [event_connector] 
 #  Neater syntax for connecting event listeners
-# [itemdata.rb] 
-#  Associate ruby objects with items in controls *NEEDS UPDATE*
-# [keyword_constructors.rb] 
+# [keyword_constructors] 
 #  Use keyword-style hash arguments to construct widgets
-# [layout.rb] 
-#  Easy interface to using WxWidgets Sizers
-# [menu.rb] 
+# [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 itemdata 
+%w[ accessors delayed_constructors event_connector 
     keyword_constructors layout menu wx_classes ].each do | ext_feature |
   require 'wx_sugar/' + ext_feature    
 end 

data/lib/wx_sugar/class_definitions.rb

@@ -52,7 +52,8 @@ WxSugar.define_class_group('MISC_WINDOW_CLASSES',
   'SashLayoutWindow',
   'VScrolledWindow',
   'WizardPage',
-  'WizardPageSimple'
+  'WizardPageSimple',
+  'HtmlWindow'
 )
 
 WxSugar.define_class_group('CONTROL_CLASSES',

data/lib/wx_sugar/keyword_classes.rb

@@ -13,12 +13,21 @@ Wx::NULL_BITMAP = nil
 $VERBOSE = v
 
 module WxSugar
+  @defined_classes = {}
+
   # accepts a string unadorned name of a WxWidgets class, and block, which 
   # defines the constructor parameters and style flags for that class.
   # If the named class exists in the available WxRuby, the block is run and 
   # the class may use keyword constructors. If the class is not available, the
   # block is ignored.
   def self.define_keyword_ctors(klass_name, &block)
+    # check this class hasn't already been defined
+    if @defined_classes[klass_name]
+      raise ArgumentError, "Keyword ctor for #{klass_name} already defined"
+    else
+      @defined_classes[klass_name] = true
+    end
+
     begin     
       klass =  Wx::const_get(klass_name)
     rescue NameError
@@ -34,8 +43,14 @@ module WxSugar
   end
 end
 
+# Window : base class for all widgets and frames
+WxSugar.define_keyword_ctors('Window') do
+   wx_ctor_params :pos, :size, :style
+   wx_ctor_params :name => 'window'
+end
+
+
 ### FRAMES
-# Normal frame
 
 # wxTopLevelWindow 	ABSTRACT: Any top level window, dialog or frame
 
@@ -146,7 +161,7 @@ end
 
 # wxSashLayoutWindow: Window that can be involved in an IDE-like layout
 # arrangement
-WxSugar.define_keyword_ctors('SashWindow') do
+WxSugar.define_keyword_ctors('SashLayoutWindow') do
   wx_ctor_params :pos, :size
   wx_ctor_params :style =>  Wx::CLIP_CHILDREN|Wx::SW_3D
   wx_ctor_params :name => 'layoutWindow'
@@ -223,7 +238,15 @@ end
 
 # wxFontDialog 	Font chooser dialog
 # wxPageSetupDialog 	Standard page setup dialog
+WxSugar.define_keyword_ctors('PageSetupDialog') do
+  wx_ctor_params :data
+end
+
 # wxPrintDialog 	Standard print dialog
+WxSugar.define_keyword_ctors('PrintDialog') do
+  wx_ctor_params :data
+end
+
 
 # Simple message box dialog
 WxSugar.define_keyword_ctors('MessageDialog') do
@@ -297,6 +320,17 @@ WxSugar.define_keyword_ctors('Gauge') do
 end
 
 # wxGenericDirCtrl 	A control for displaying a directory tree
+WxSugar.define_keyword_ctors('GenericDirCtrl') do
+  # TODO :dir => Wx::DIR_DIALOG_DEFAULT_FOLDER_STR
+  wx_ctor_params :dir => '' 
+  wx_ctor_params :pos, :size, 
+                 :style => Wx::DIRCTRL_3D_INTERNAL|Wx::SUNKEN_BORDER
+  wx_ctor_params :filter => ''
+  wx_ctor_params :default_filter => 0
+  wx_ctor_params :name => 'genericDirCtrl'
+end
+
+
 # wxHtmlListBox 	A listbox showing HTML content
 # wxListBox 	A list of strings for single or multiple selection
 WxSugar.define_keyword_ctors('ListBox') do
@@ -318,20 +352,14 @@ WxSugar.define_keyword_ctors('TreeCtrl') do
 #  wx_ctor_params :validator, :name => 'treeCtrl'
 end
 
-# wxScrollBar 	Scrollbar control
-# wxSpinButton 	A spin or 'up-down' control
-WxSugar.define_keyword_ctors('SpinCtrl') do
-  wx_ctor_params :pos, :size, :style => Wx::SP_HORIZONTAL
-#  wx_ctor_params :validator, :name => 'treeCtrl'
-end
-
 # wxSpinCtrl 	A spin control - i.e. spin button and text control
 WxSugar.define_keyword_ctors('SpinCtrl') do
+  wx_ctor_params :value => ''
   wx_ctor_params :pos, :size, :style => Wx::SP_ARROW_KEYS
   wx_ctor_params :min => 0
   wx_ctor_params :max => 100
   wx_ctor_params :initial => 0
-#  wx_ctor_params :validator, :name => 'treeCtrl'
+  wx_ctor_params :name => 'spinCtrl'
 end
 
 # One or more lines of non-editable text
@@ -360,13 +388,11 @@ 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
-WxSugar.define_keyword_ctors('RadioBox') do
+WxSugar.define_keyword_ctors('RadioButton') do
   wx_ctor_params :label => ''
   wx_ctor_params :pos, :size, :style => 0
   #  wx_ctor_params :validator, :name => 'radioButton'
@@ -374,16 +400,30 @@ end
 
 # wxSlider 	A slider that can be dragged by the user
 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'
 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
+   wx_ctor_params :name => 'spinButton'
+end
+
 # wxVListBox 	A listbox supporting variable height rows
 
 # wxTextCtrl 	Single or multiline text editing control
 WxSugar.define_keyword_ctors('TextCtrl') do
   wx_ctor_params :value => ''
   wx_ctor_params :pos, :size, :style
+  # wx_ctor_params validator, :name => 'textCtrl'
 end
 
+# wxHtmlWindow - Control for displaying HTML
+WxSugar.define_keyword_ctors('HtmlWindow') do
+  wx_ctor_params :pos, :size, :style => Wx::HW_DEFAULT_STYLE
+  wx_ctor_params :name => 'htmlWindow'
+end

data/lib/wx_sugar/keyword_constructors.rb

@@ -244,7 +244,7 @@ module KeywordConstructor
           pre_wx_kwctor_init(*real_args)
         rescue
           Kernel.raise ArgumentError, "Error initializing #{self.inspect} \n" +
-                                      "Sent paramters: #{real_args.inspect}\n" +
+                                      "Sent parameters: #{real_args.inspect}\n" +
                                       "correct parameters are:\n" + 
                                       self.class.describe_constructor()
         end

data/lib/wx_sugar/version.rb

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

data/lib/wx_sugar.rb

@@ -0,0 +1 @@
+require 'wx_sugar/all'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: wx_sugar
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2006-10-19
+  version: 0.1.13
+date: 2006-12-03
 summary: Syntax extensions for WxRuby.
 require_paths: 
   - lib
@@ -28,6 +28,7 @@ authors:
   - Alex Fenton
 files: 
   - lib/wx_sugar
+  - lib/wx_sugar.rb
   - lib/wx_sugar/accessors.rb
   - lib/wx_sugar/all.rb
   - lib/wx_sugar/class_definitions.rb