wxruby 1.9.7-x86-linux → 1.9.8-x86-linux

data/lib/wx.rb

@@ -25,6 +25,8 @@ 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
@@ -34,9 +36,18 @@ Dir.glob(class_files) do | class_file |
   require 'wx/classes/' + class_file[/\w+\.rb$/]
 end
 
-# Load in syntax sweetner
+# 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/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/controlwithitems.rb

@@ -5,6 +5,6 @@ class Wx::ControlWithItems
   include Enumerable
   # Passes each valid item index into the passed block
   def each
-    0.upto(count - 1) { | i | yield i }
+    0.upto(get_count - 1) { | i | yield i }
   end
 end

data/lib/wx/classes/evthandler.rb

@@ -126,10 +126,11 @@ class Wx::EvtHandler
         when Proc then meth
         when Method then meth.to_proc
       end
+      # Create an anonymous block to call the relevant method
       if h_meth.arity == 1
-        return lambda { | evt | h_meth.call(evt) }
+        return proc { | evt | h_meth.call(evt) }
       else
-        return lambda { h_meth.call }
+        return proc { h_meth.call }
       end
     else
       Kernel.raise ArgumentError,
@@ -177,12 +178,18 @@ class Wx::EvtHandler
     EventType['evt_auinotebook_begin_drag', 1,
               Wx::EVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, 
               Wx::AuiNotebookEvent],
+    EventType['evt_auinotebook_bg_dclick', 1,
+              Wx::EVT_COMMAND_AUINOTEBOOK_BG_DCLICK, 
+              Wx::AuiNotebookEvent],
     EventType['evt_auinotebook_button', 1,
               Wx::EVT_COMMAND_AUINOTEBOOK_BUTTON, 
               Wx::AuiNotebookEvent],
     EventType['evt_auinotebook_drag_motion', 1,
               Wx::EVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, 
               Wx::AuiNotebookEvent],
+    EventType['evt_auinotebook_drag_done', 1,
+              Wx::EVT_COMMAND_AUINOTEBOOK_DRAG_DONE, 
+              Wx::AuiNotebookEvent],
     EventType['evt_auinotebook_end_drag', 1,
               Wx::EVT_COMMAND_AUINOTEBOOK_END_DRAG, 
               Wx::AuiNotebookEvent],
@@ -195,6 +202,21 @@ class Wx::EvtHandler
     EventType['evt_auinotebook_page_close', 1,
               Wx::EVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE, 
               Wx::AuiNotebookEvent],
+    EventType['evt_auinotebook_page_closed', 1,
+              Wx::EVT_COMMAND_AUINOTEBOOK_PAGE_CLOSED, 
+              Wx::AuiNotebookEvent],
+    EventType['evt_auinotebook_tab_middle_down', 1,
+              Wx::EVT_COMMAND_AUINOTEBOOK_TAB_MIDDLE_DOWN, 
+              Wx::AuiNotebookEvent],
+    EventType['evt_auinotebook_tab_middle_up', 1,
+              Wx::EVT_COMMAND_AUINOTEBOOK_TAB_MIDDLE_UP, 
+              Wx::AuiNotebookEvent],
+    EventType['evt_auinotebook_tab_right_down', 1,
+              Wx::EVT_COMMAND_AUINOTEBOOK_TAB_RIGHT_DOWN, 
+              Wx::AuiNotebookEvent],
+    EventType['evt_auinotebook_tab_right_up', 1,
+              Wx::EVT_COMMAND_AUINOTEBOOK_TAB_RIGHT_UP, 
+              Wx::AuiNotebookEvent],
     EventType['evt_aui_find_manager', 0,
               Wx::EVT_AUI_FIND_MANAGER, 
               Wx::AuiManagerEvent],
@@ -294,6 +316,12 @@ class Wx::EvtHandler
     EventType['evt_drop_files', 0,
               Wx::EVT_DROP_FILES, 
               Wx::Event],
+    EventType['evt_detailed_help', 1,
+              Wx::EVT_DETAILED_HELP, 
+              Wx::HelpEvent],
+    EventType['evt_detailed_help_range', 2,
+              Wx::EVT_DETAILED_HELP, 
+              Wx::HelpEvent],
     EventType['evt_end_process', 1,
               Wx::EVT_END_PROCESS, 
               Wx::Event],
@@ -419,10 +447,13 @@ class Wx::EvtHandler
               Wx::GridEvent],
     EventType['evt_help', 1,
               Wx::EVT_HELP, 
-              Wx::Event],
+              Wx::HelpEvent],
     EventType['evt_help_range', 2,
               Wx::EVT_HELP, 
-              Wx::Event],
+              Wx::HelpEvent],
+    EventType['evt_hibernate', 2,
+              Wx::EVT_HIBERNATE, 
+              Wx::ActivateEvent],
     EventType['evt_html_cell_clicked', 1,
               Wx::EVT_COMMAND_HTML_CELL_CLICKED, 
               Wx::HtmlCellEvent],
@@ -762,12 +793,21 @@ class Wx::EvtHandler
     EventType['evt_text', 1,
               Wx::EVT_COMMAND_TEXT_UPDATED, 
               Wx::CommandEvent],
+    EventType['evt_text_copy', 1,
+              Wx::EVT_COMMAND_TEXT_COPY, 
+              Wx::ClipboardTextEvent],
+    EventType['evt_text_cut', 1,
+              Wx::EVT_COMMAND_TEXT_CUT, 
+              Wx::ClipboardTextEvent],
     EventType['evt_text_enter', 1,
               Wx::EVT_COMMAND_TEXT_ENTER, 
               Wx::CommandEvent],
     EventType['evt_text_maxlen', 1,
               Wx::EVT_COMMAND_TEXT_MAXLEN, 
               Wx::CommandEvent],
+    EventType['evt_text_paste', 1,
+              Wx::EVT_COMMAND_TEXT_PASTE, 
+              Wx::ClipboardTextEvent],
     EventType['evt_text_url', 1,
               Wx::EVT_COMMAND_TEXT_URL, 
               Wx::TextUrlEvent],
@@ -852,6 +892,9 @@ class Wx::EvtHandler
     EventType['evt_tree_set_info', 1,
               Wx::EVT_COMMAND_TREE_SET_INFO, 
               Wx::TreeEvent],
+    EventType['evt_tree_state_image_click', 1,
+              Wx::EVT_COMMAND_TREE_STATE_IMAGE_CLICK, 
+              Wx::TreeEvent],
     EventType['evt_update_ui', 1,
               Wx::EVT_UPDATE_UI, 
               Wx::UpdateUIEvent],

data/lib/wx/classes/helpcontrollerhelpprovider.rb

@@ -0,0 +1,23 @@
+# Pure-ruby implementation of the corresponding Wx class. Shows a
+# relevant section of help, if available, or a native popup
+require 'wx/classes/simplehelpprovider'
+class Wx::HelpControllerHelpProvider < Wx::SimpleHelpProvider
+  def initialize(help_controller)
+    super()
+    @hc = help_controller
+  end
+
+  # Show help for +win+; if the help text for +win+ is a string with a
+  # single integer only, treats that as a section id for help and shows
+  # that, otherwise shows a popup (native-style on Windows) of the text.
+  def show_help(win)
+    help_text = get_help(win)
+    return false if help_text.empty?
+    if help_text =~ /\A\d+\z/
+      @hc.display_context_popup(help_text.to_i)
+    else
+      @hc.display_text_popup(help_text, Wx::get_mouse_position)
+    end
+    true
+  end
+end

data/lib/wx/classes/helpprovider.rb

@@ -0,0 +1,15 @@
+# Base class for providing context-sensitive help. The main definition
+# is in SWIG/C++ 
+class Wx::HelpProvider
+  class << self
+    # We need to protect the currently set HelpProvider from GC as it is a
+    # SWIG Director; it can't be reaped and re-wrapped later. The
+    # easiest way is to make the currently set one an instance variable
+    # of this class
+    alias :__wx_set :set
+    define_method(:set) do | help_provider |
+      __wx_set(help_provider)
+      @__hp__ = help_provider
+    end
+  end
+end

data/lib/wx/classes/mediactrl.rb

@@ -9,14 +9,40 @@ if defined?(Wx::MediaCtrl)
     evt_type['evt_media_finished', 1,
               Wx::EVT_MEDIA_FINISHED,
               Wx::MediaEvent],
-    evt_type['evt_media_stop', 1,
-              Wx::EVT_MEDIA_STOP,
-              Wx::MediaEvent],
     evt_type['evt_media_loaded', 1,
               Wx::EVT_MEDIA_LOADED,
+              Wx::MediaEvent],
+    evt_type['evt_media_pause', 1,
+              Wx::EVT_MEDIA_PAUSE,
+              Wx::MediaEvent],
+    evt_type['evt_media_play', 1,
+              Wx::EVT_MEDIA_PLAY,
+              Wx::MediaEvent],
+    evt_type['evt_media_statechanged', 1,
+              Wx::EVT_MEDIA_STATECHANGED,
+              Wx::MediaEvent],
+    evt_type['evt_media_stop', 1,
+              Wx::EVT_MEDIA_STOP,
               Wx::MediaEvent]
   ]
   mediactrl_event_types.each do | ev_type | 
     Wx::EvtHandler.register_event_type(ev_type)
   end
+
+  # Extend with a nicer interface to get_state
+  class Wx::MediaCtrl
+    # Returns true if the media is currently paused, else false
+    def is_paused
+      get_state == Wx::MEDIASTATE_PAUSED
+    end
+    # Returns true if the media is currently playing, else false
+    def is_playing
+      get_state == Wx::MEDIASTATE_PLAYING
+    end
+    # Returns true if the media is currently stopped, else false
+    def is_stopped
+      get_state == Wx::MEDIASTATE_STOPPED
+    end
+  end
 end
+

data/lib/wx/classes/notebook.rb

@@ -0,0 +1,9 @@
+# Displays a set of pages in parallel using tabs
+class Wx::Notebook
+  # 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/object.rb

@@ -1,7 +1,14 @@
 # The root class for most (not all) WxRuby classes
 class Wx::Object
-  # massage the output of inspect to show the public module name (Wx)
+  # Massage the output of inspect to show the public module name (Wx),
+  # instead of the internal name (Wxruby2)
   def to_s
     super.sub('ruby2', '')
   end
+
+  # Returns a string containing the C++ pointer address of this
+  # object. Only useful for debugging.
+  def ptr_addr
+    Wx::ptr_addr(self)
+  end
 end

data/lib/wx/classes/simplehelpprovider.rb

@@ -0,0 +1,38 @@
+# Pure-ruby implementation of the corresponding Wx class. Simply shows
+# the Window's help text in a tooltip.
+class Wx::SimpleHelpProvider < Wx::HelpProvider
+  def initialize
+    super
+    # Store for mapping windows -> help strings
+    @help_wins = {} 
+    # Store for mapping ids -> help strings
+    @help_ids  = {}
+  end
+
+  # This is what is called by Wx::Window#set_help_text
+  def add_help(identifier, text)
+    if identifier.kind_of? Wx::Window
+      @help_wins[identifier.object_id] = text
+    else
+      @help_ids[identifier] = text
+    end
+  end
+
+  # Retrieve help text for the given window +win+
+  def get_help(win)
+    @help_wins[win.object_id] || @help_ids[win.wx_id] || ""
+  end
+
+  # Remove the help text for +win+
+  def remove_help(win)
+    @help_wins.delete(win.object_id)
+  end
+
+  # Show help for +win+
+  def show_help(win)
+    help_text = get_help(win)
+    return false if help_text.empty?
+    tip = Wx::TipWindow.new(win, help_text, 100)
+    true
+  end
+end

data/lib/wx/classes/sizer.rb

@@ -0,0 +1,22 @@
+# Class for automatically managing layouts
+class Wx::Sizer
+  # Generic method to add items, supporting positional and named
+  # arguments
+  ADD_ITEM_PARAMS = [ Wx::Parameter[ :index, -1 ], 
+                      Wx::Parameter[ :proportion, 0 ],
+                      Wx::Parameter[ :flag, 0 ],
+                      Wx::Parameter[ :border, 0 ],
+                      Wx::Parameter[ :user_data, nil ] ]
+  
+  def add_item(item, *mixed_args)
+    args = Wx::args_as_list(ADD_ITEM_PARAMS, *mixed_args)
+
+    # Call add to append if default position
+    idx = args.shift
+    if idx == -1
+      add(item, *args)
+    else
+      insert(idx, item, *args)
+    end
+  end
+end

data/lib/wx/classes/toolbar.rb

@@ -0,0 +1,29 @@
+# A set of buttons and controls attached to one edge of a Wx::Frame
+class Wx::ToolBar
+  # Generic method to add items, supporting positional and named
+  # arguments
+  ADD_ITEM_PARAMS = [ Wx::Parameter[ :position, -1 ], 
+                      Wx::Parameter[ :id, -1 ],
+                      Wx::Parameter[ :label, "" ], 
+                      Wx::Parameter[ :bitmap, Wx::NULL_BITMAP ],
+                      Wx::Parameter[ :bitmap2, Wx::NULL_BITMAP ],
+                      Wx::Parameter[ :kind, Wx::ITEM_NORMAL ], 
+                      Wx::Parameter[ :short_help, "" ], 
+                      Wx::Parameter[ :long_help, "" ], 
+                      Wx::Parameter[ :client_data, nil ] ]
+  
+  def add_item(*mixed_args)
+    args = Wx::args_as_list(ADD_ITEM_PARAMS, *mixed_args)
+    if args[3] == Wx::NULL_BITMAP
+      Kernel.raise ArgumentError, "Main button bitmap may not be NULL"
+    end
+
+    # Call add_tool to append if default position
+    pos = args.shift
+    if pos == -1
+      add_tool(*args)
+    else
+      insert_tool(pos, *args)
+    end
+  end
+end

data/lib/wx/helpers.rb

@@ -0,0 +1,30 @@
+# Various non-GUI helper functions
+module Wx
+  # A named parameter in a Wx named-arg parameter list
+  Parameter = Struct.new( :name, :default )
+
+  # Convert mixed positional / named args into a list to be passed to
+  # an underlying API method. +param_spec+ is an Array of Parameter
+  # structs containing the keyword name and default value for each
+  # possible argument. +mixed_args+ is an array which may optionally end
+  # with a set of named arguments
+
+  def self.args_as_list(param_spec, *mixed_args)
+    # get keyword arguments from mixed args if supplied, else empty
+    kwa = mixed_args.last.kind_of?(Hash) ? mixed_args.pop : {}
+    out_args = []
+    param_spec.each_with_index do | param, i |
+      if arg = mixed_args[i] # use the supplied list arg 
+        out_args << arg
+      elsif kwa.key?(param.name) # use the keyword arg
+        out_args << kwa[param.name]
+      else # use the default argument
+        out_args << param.default
+      end
+    end
+    out_args
+  rescue
+    Kernel.raise ArgumentError, 
+                 "Bad arg composition of #{mixed_args.inspect}"
+  end
+end

data/lib/wx/keyword_ctors.rb

@@ -106,10 +106,6 @@ module Wx
         :choices   => [] # for Choice, ComboBox etc
       }
 
-      
-      # A named parameter in a Wx constructor parameter list
-      Parameter = Struct.new( :name, :default )
-
       attr_writer :param_spec
       def param_spec
         @param_spec ||= []
@@ -132,22 +128,7 @@ module Wx
       end
 
       def args_as_list(*mixed_args)
-        # get keyword arguments from mixed args if supplied, else empty
-        kwa = mixed_args.last.kind_of?(Hash) ? mixed_args.pop : {}
-        out_args = []
-        param_spec.each_with_index do | param, i |
-          if arg = mixed_args[i] # use the supplied list arg 
-            out_args << arg
-          elsif kwa.key?(param.name) # use the keyword arg
-            out_args << kwa[param.name]
-          else # use the default argument
-            out_args << param.default
-          end
-        end
-        out_args
-      rescue
-        Kernel.raise ArgumentError, 
-                     "Bad arg composition of #{mixed_args.inspect}"
+        Wx::args_as_list(param_spec, *mixed_args)
       end
 
       def args_as_hash(*mixed_args)

data/lib/wx/keyword_defs.rb

@@ -141,6 +141,21 @@ Wx::define_keyword_ctors('ToolBar') do
   wx_ctor_params :name => 'toolBar' # not as documented in Wx 2.6.3
 end
 
+# ToolBarTool class
+Wx::define_keyword_ctors('ToolBarTool') do
+  # By default we want Wx to generate an id for us, thus it doesn't
+  # respect the wxWidgets default constructor value which is
+  # ID_SEPARATOR
+  wx_ctor_params :id => Wx::ID_ANY
+  wx_ctor_params :label => ''
+  wx_ctor_params :bitmap
+  wx_ctor_params :disabled_bitmap => Wx::NULL_BITMAP
+  wx_ctor_params :kind => Wx::ITEM_NORMAL
+  wx_ctor_params :data => nil
+  wx_ctor_params :short_help => ''
+  wx_ctor_params :long_help => ''
+end
+
 # Notebook class
 Wx::define_keyword_ctors('Notebook') do
   wx_ctor_params :id, :pos, :size, :style, :name => 'noteBook'