wxruby-ruby19 1.9.8-x86-darwin-9

data/lib/wx.rb

@@ -0,0 +1,53 @@
+# Copyright 2004-2006 by Kevin Smith
+# released under the MIT-style wxruby2 license
+
+# This wrapper serves three functions:
+# 1. It loads the binary library 'wxruby2.so' or 'wxruby.dll', while
+#    still allowing applications to just require 'wx'.
+# 2. It sets up the version information
+# 3. It loads in ruby extensions to the core Wx classes.
+
+
+# load the binary library
+require 'wxruby2'
+
+# alias the module
+Wx = Wxruby2
+
+# Load the version information (should be bundled with all released versions)
+begin
+  require 'wx/version'
+rescue LoadError
+  Wx::WXRUBY_VERSION = '0.0.0'
+end
+# Convenience string for WxWidgets version info
+Wx::WXWIDGETS_VERSION = '%i.%i.%i' % [ Wx::WXWIDGETS_MAJOR_VERSION,
+                                       Wx::WXWIDGETS_MINOR_VERSION,
+                                       Wx::WXWIDGETS_RELEASE_NUMBER ]
+
+# Helper functions
+require 'wx/helpers'
+
+# Load in all the class extension methods written in ruby
+# evthandler must be required first b/c it sets up methods modified elsewhere
+require 'wx/classes/evthandler.rb'
+class_files = File.join( File.dirname(__FILE__), 'wx', 'classes', '*.rb')
+Dir.glob(class_files) do | class_file | 
+  require 'wx/classes/' + class_file[/\w+\.rb$/]
+end
+
+# Load in syntax sweeteners
+require 'wx/accessors'
+require 'wx/keyword_ctors'
+require 'wx/keyword_defs'
+
+# If a program is ended by ruby's exit, it can bypass doing the proper
+# Wx clean-up routines called by Wx::App#on_exit. This can under some
+# circumstances cause crashes as the application ends.
+Kernel::at_exit do
+  # This is set in wxRubyApp.OnExit (see swig/classes/App.i)
+  if not $__wx_app_ended__
+    Wx::THE_APP.on_exit
+  end
+end
+

data/lib/wx/accessors.rb

@@ -0,0 +1,52 @@
+# = WxSugar - Accessors
+#
+# The default WxRuby interface has lots and lots of methods like
+#
+#  * get_position()
+#  * set_size(a_size)
+#  * is_checked()
+# 
+# and so on. Methods that retrieve set, or query attributes of an object
+# are more normally in Ruby called simply by the attribute name:
+#
+#  * position()
+#  * size = a_size
+#  * checked?
+#
+# This extension creates an alias for every WxRuby instance method that
+# begins with +get_+, +set_+ or +is_+. Note that if you are calling a
+# 'setter' method on self, you must explicitly send the message to self:
+# 
+#  # set's self size to be 100px by 100px
+#  self.size = Wx::Size.new(100, 100)
+#  # only sets the value of a local variable 'size'
+#  size = Wx::Size.new
+
+module WxRubyStyleAccessors
+  def method_missing(sym, *args)
+    case sym.to_s
+    when /^(.*)\=$/
+      meth = "set_#{$1}"
+    when /^(.*)\?$/
+      meth = "is_#{$1}"
+    else
+      meth = "get_#{sym}"
+    end
+    if respond_to?(meth)
+      send(meth, *args)
+    else
+      e = NoMethodError.new("undefined method '#{sym}' for #{self.inspect}")
+      e.set_backtrace(caller)
+      Kernel.raise e
+    end
+  end
+end
+
+all_classes = Wx::constants.collect { | c | Wx::const_get(c) }.grep(Class)
+
+all_classes.each do | klass |
+  klass.class_eval do
+    include WxRubyStyleAccessors
+    extend WxRubyStyleAccessors
+  end
+end

data/lib/wx/classes/acceleratortable.rb

@@ -0,0 +1,28 @@
+class Wx::AcceleratorTable
+  # Allow new to be called as []
+  class << self
+    alias :[] :new
+  end
+
+  # Allow initialize to be called with a splat-like list of arguments,
+  # and allow entries to be specified in terser form [mod, key, id]
+  # rather than full AcceleratorEntry.new call.
+  wx_init = self.instance_method(:initialize)
+  define_method(:initialize) do | *args |
+    # Test for old-style arg passing in a single array
+    if args.length == 1 and args.first.kind_of?(Array) and
+       args.first.all? { | e | e.kind_of?(Wx::AcceleratorEntry) }
+      args = args[0]
+    end
+    # Convert to array of AccEntries, to pass in as single array
+    args = args.map do | entry |
+      case entry 
+      when Wx::AcceleratorEntry then entry
+      when Array then Wx::AcceleratorEntry.new(*entry)
+      else Kernel.raise ArgumentError,
+                        "#{entry.inspect} is not a valid AcceleratorTable entry"
+      end
+    end
+    wx_init.bind(self).call(args)
+  end
+end

data/lib/wx/classes/animation.rb

@@ -0,0 +1,18 @@
+class Wx::Animation < Wx::GDIObject
+  # Redefine the initialize method so it raises an exception if a
+  # non-existent file is given to the constructor; otherwise, wx Widgets
+  # just carries on with an empty bitmap, which may cause faults later
+  wx_init = self.instance_method(:initialize)
+  define_method(:initialize) do | *args |
+    if args[0].kind_of? String
+      if not File.exist?( File.expand_path(args[0]) )
+        Kernel.raise( ArgumentError, 
+                      "Animation file does not exist: #{args[0]}" )
+      end
+      res = wx_init.bind(self).call()
+      res.load_file(args[0], args[1] || Wx::ANIMATION_TYPE_ANY)
+    else
+      wx_init.bind(self).call(*args)
+    end
+  end
+end

data/lib/wx/classes/app.rb

@@ -0,0 +1,45 @@
+# Copyright 2004-2006 by Kevin Smith
+# released under the MIT-style wxruby2 license
+
+# Controller class which creates and manages all windows.
+class Wx::App
+  # Convenience class method to create simple apps. Starts an
+  # application main_loop, setting up initial windows etc as specified
+  # in the passed block.
+  # block 
+  def self.run(&block)
+    app_klass = Class.new(self)
+    app_klass.class_eval do
+      define_method(:on_init, &block)
+    end
+    the_app = app_klass.new
+    the_app.main_loop
+  end
+
+  # This is a class method in Wx, but permit it to be an instance method
+  # in wxRuby
+  def is_main_loop_running
+    Wx::App.is_main_loop_running
+  end
+
+  # This method handles failed assertions from within the WxWidgets C++
+  # code. These messages are only generated by a DEBUG build of
+  # WxRuby. Such messages usually indicate that the API is being used
+  # incorrectly; the file/line reference points to the place in the
+  # WxWidgets source code where the assertion was made.
+  define_method(:on_assert_failure) do | file, line, condition, message |
+    warn "Wx WARNING: #{message} (#{file}:#{line})"
+  end
+
+  # For use in development only, of no practical use in production code.
+  # This method causes Ruby's garbage collection to run (roughly) at
+  # interval +interval+ (seconds) - the default is 1, i.e. every
+  # second. This should help ferret out bugs in memory management more
+  # quickly.
+  def gc_stress(interval = 1)
+    t = Wx::Timer.new(self, 9999)
+    evt_timer(9999) { Thread.pass }
+    Thread.new { loop { sleep interval; GC.start } }
+    t.start(100)
+  end
+end

data/lib/wx/classes/artprovider.rb

@@ -0,0 +1,31 @@
+# Class which can supply icons and bitmaps
+class Wx::ArtProvider
+  # Keep a note of supplied ArtProviders to prevent them being GC'd
+  @__art_provs = []
+
+  class << self 
+    wx_insert = instance_method(:insert)
+    define_method(:insert) do | art_prov |
+      wx_insert.bind(self).call(art_prov)
+      @__art_provs.unshift(art_prov)
+    end
+
+    wx_pop = instance_method(:pop)
+    define_method(:pop) do
+      wx_pop.bind(self).call
+      @__art_provs.pop
+    end
+
+    wx_push = instance_method(:push)
+    define_method(:push) do | art_prov |
+      wx_push.bind(self).call(art_prov)
+      @__art_provs.push(art_prov)
+    end
+
+    wx_remove = instance_method(:remove)
+    define_method(:remove) do | art_prov |
+      wx_push.bind(self).call(art_prov)
+      @__art_provs.delete(art_prov)
+    end
+  end
+end

data/lib/wx/classes/auinotebook.rb

@@ -0,0 +1,9 @@
+# Advanced User Interface Notebook - draggable panes etc
+class Wx::AuiNotebook
+  # Convenience method for iterating pages
+  def each_page
+    0.upto(get_page_count - 1) do | i |
+      yield get_page(i)
+    end
+  end
+end

data/lib/wx/classes/bitmap.rb

@@ -0,0 +1,28 @@
+class Wx::Bitmap
+  # Constructor copying data from an image
+  def self.from_image(img, depth = -1)
+    new(img, depth)
+  end
+
+  # Redefine the initialize method so it raises an exception if a
+  # non-existent file is given to the constructor; otherwise, wx Widgets
+  # just carries on with an empty bitmap, which may cause faults later
+  wx_init = self.instance_method(:initialize)
+  define_method(:initialize) do | *args |
+    if args[0].kind_of? String
+      if not File.exist?( File.expand_path(args[0]) )
+        Kernel.raise(ArgumentError, "Bitmap file does not exist: #{args[0]}")
+      end
+    end
+    wx_init.bind(self).call(*args)
+  end
+
+  # Accepts a block, which will be passed a device context which can be
+  # used to draw upon the Bitmap
+  def draw
+    dc = Wx::MemoryDC.new
+    dc.select_object(self)
+    yield dc
+    dc.select_object( Wx::NULL_BITMAP )
+  end
+end

data/lib/wx/classes/busycursor.rb

@@ -0,0 +1,12 @@
+# Emulates the wxWidgets BusyCursor class, by providing a scope within
+# which a busy cursor will be shown
+class Wx::BusyCursor
+  # Only one class method, optionally accepting a cursor that should be
+  # shown, defaulting to an hour glass cursor.
+  def self.busy(cursor = Wx::HOURGLASS_CURSOR)
+    Wx::begin_busy_cursor(cursor)
+    yield
+  ensure
+    Wx::end_busy_cursor
+  end
+end

data/lib/wx/classes/checklistbox.rb

@@ -0,0 +1,45 @@
+# A ListBox, where each item has a checkbox next to it
+class Wx::CheckListBox
+  # wxRuby redefinitions of core methods to add item data support (not
+  # available in wxWidgets). Use a private method to initialize and
+  # access the data, rather than in initialize(), b/c can't guarantee
+  # that initialize will be called (eg when loaded from XRC)
+  def __wx_item_data
+    @__wx_item_data ||= []
+  end
+  private :__wx_item_data
+
+  # Call method in ControlWithItems, then sync item data
+  def append(item, data = nil)
+    super(item)
+    __wx_item_data[count - 1] = data
+  end
+
+  # Call method in ControlWithItems, then sync item data
+  def clear
+    super
+    __wx_item_data.clear
+  end
+
+  # delete is defined in Wx::CheckListBox, so must be called in this class
+  wx_delete = self.instance_method(:delete)
+  define_method(:delete) do | n |
+    wx_delete.bind(self).call(n)
+    __wx_item_data.delete_at(n)
+  end
+
+  # Returns an array of indices of items that are currently checked.
+  def get_checked_items
+    find_all { | i | checked?(i) }    
+  end
+  
+  # Wholly redefined here
+  def get_item_data(n)
+    __wx_item_data[n]
+  end
+
+  # Wholly redefined here
+  def set_item_data(n, data)
+    __wx_item_data[n] = data
+  end
+end

data/lib/wx/classes/choice.rb

@@ -0,0 +1,4 @@
+class Wx::Choice
+  alias :get_item_data :get_client_data
+  alias :set_item_data :set_client_data
+end

data/lib/wx/classes/clientdc.rb

@@ -0,0 +1,13 @@
+# Device Context to paint on a window outside an on_paint handler. It is
+# recommended that PaintDC is used in preference to this class.
+class Wx::ClientDC
+  # This class should not be instantiated directly in wxRuby; it should
+  # always be used via Window#paint, which takes a block receiving the
+  # DC. This ensures that the DC is cleaned up at the correct time,
+  # avoiding errors and segfaults on exit.
+  define_method(:initialize) do | *args |
+    Kernel.raise RuntimeError,
+                 "Do not instantiate ClientDC directly; use Window#paint",
+                 caller[1..-1]
+  end
+end

data/lib/wx/classes/clipboard.rb

@@ -0,0 +1,16 @@
+class Wx::Clipboard
+  class << self
+    # Class method to provide access to the clipboard within a ruby
+    # block. Tests that the clipboard could be accessed, and ensures
+    # that it is closed when the block is finished.
+    def open
+      clip = Wx::Clipboard.new
+      unless clip.open
+        Kernel.raise "Could not open clipboard"
+      end
+      yield clip
+    ensure
+      clip.close
+    end
+  end
+end

data/lib/wx/classes/colour.rb

@@ -0,0 +1,47 @@
+class Wx::Colour
+  # Redefine the initialize method so it raises an exception if an
+  # invalid colour value is given. This might be an unknown colour
+  # string (eg 'dark blue') or out-of-bounds integer values (<0 or >255)
+  wx_init = self.instance_method(:initialize)
+  define_method(:initialize) do | *args |
+    begin
+      wx_init.bind(self).call(*args)
+    # Invalid integer values raise SWIG 'no matching func'
+    rescue ArgumentError 
+      Kernel.raise ArgumentError, "Invalid colour values #{args.inspect}"
+    end
+
+    if not is_ok
+      Kernel.raise ArgumentError, "Invalid colour values #{args.inspect}"
+    end
+  end
+
+  # Standard colours, corresponding to WxWidgets stock colours.
+  Wx::WHITE = new(255, 255, 255)
+  Wx::BLACK = new(0, 0, 0)
+
+  Wx::RED   = new(255, 0, 0)
+  Wx::GREEN = new(0, 255, 0)
+  Wx::BLUE  = new(0, 0, 255)
+
+  Wx::YELLOW  = new(255, 255, 0)
+  Wx::MAGENTA = new(255, 0, 255)
+  Wx::CYAN    = new(0, 255, 255)
+
+  Wx::LIGHT_GREY = new(192, 192, 192)
+
+  # Colours are equal to one another if they have the same red, green
+  # and blue intensity, and the same alpha
+  def ==(other)
+    if not other.is_a?(self.class)
+      raise ArgumentError, "No comparison of #{self} to #{other}"
+    end
+    [ red, green, blue, alpha ] == 
+      [ other.red, other.green, other.blue, other.alpha ]
+  end
+
+  # More informative output for inspect etc
+  def to_s
+    "#<Wx::Colour: (#{red}, #{green}, #{blue} *#{alpha})>"
+  end
+end

data/lib/wx/classes/combobox.rb

@@ -0,0 +1,4 @@
+class Wx::ComboBox
+  alias :get_item_data :get_client_data
+  alias :set_item_data :set_client_data
+end

data/lib/wx/classes/commandevent.rb

@@ -0,0 +1,7 @@
+# Class representing interactions with controls such as ListBox
+class Wx::CommandEvent
+  # get_int and get_selection are already synonyms, but neither name
+  # accurately describes what the method does as the event may be a
+  # (de)selection or a check in a CheckListBox
+  alias :get_index :get_int
+end

data/lib/wx/classes/controlwithitems.rb

@@ -0,0 +1,10 @@
+# Superclass of a variety of controls that display lists of items (eg
+# Choice, ListBox, CheckListBox)
+class Wx::ControlWithItems
+  # Make these ruby enumerables so find, find_all, map etc are available 
+  include Enumerable
+  # Passes each valid item index into the passed block
+  def each
+    0.upto(get_count - 1) { | i | yield i }
+  end
+end