wxruby3 0.9.0.pre.beta.8

data/samples/etc/scrollwin.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+# wxRuby2 Sample Code. Copyright (c) 2004-2008 wxRuby development team
+# Adapted for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require 'wx'
+
+# Example demonstrating the use of Wx::ScrolledWindow and the
+# ScrollWinEvents
+
+class ScrollFrame < Wx::Frame
+  def initialize(title)
+    super(nil, -1, 'Thumb Scrolling Test', 
+          Wx::DEFAULT_POSITION, Wx::Size.new(400, 300), 
+          Wx::SYSTEM_MENU|Wx::CAPTION|Wx::RESIZE_BORDER|
+                          Wx::MAXIMIZE_BOX|Wx::MINIMIZE_BOX|Wx::CLOSE_BOX)
+
+    @scroll_win = Wx::ScrolledWindow.new(self, -1)
+    # Set the interior size (pixels) of the scrolling window
+    @scroll_win.set_virtual_size(1000, 1500)
+    # Set the number of pixels moved per 'line' / click on the scrollbars
+    @scroll_win.set_scroll_rate(5, 5)
+
+    @button = Wx::Button.new(@scroll_win, -1, 'Press Me', 
+                             Wx::Point.new(200,200), 
+                             Wx::Size.new(125, 30))
+    
+    # NOTE that all ScrollWin event hooks do not take an id - i.e. they
+    # are only generated from the originating Window itself - in this
+    # case, the ScrollWindow. So, we need to do:
+    #  @scroll_win.evt_scrollwin_xxx { ...
+    # AND NOT
+    #  evt_scrollwin_xxx(@scroll_win.get_id) { ...
+    @scroll_win.evt_scrollwin_linedown { | e | on_line(e, 'down') }
+    @scroll_win.evt_scrollwin_lineup { | e | on_line(e,'up') }
+    
+    @scroll_win.evt_scrollwin_thumbtrack { | e | on_thumb(e, 'track') }
+    @scroll_win.evt_scrollwin_thumbrelease { | e | on_thumb(e, 'release') }
+
+    @scroll_win.evt_scrollwin_pagedown { | e | on_page(e, 'down') }
+    @scroll_win.evt_scrollwin_pageup { | e | on_page(e, 'up') }
+
+    # not sure how these are meant to be generated
+    @scroll_win.evt_scrollwin_top { | e | on_top(e) }
+    @scroll_win.evt_scrollwin_bottom { | e | on_bottom(e) }
+    #@scroll_win.evt_scrollwin { | e | p e }
+  end
+  
+  # Handle scrolling by page - typically done by clicking on the
+  # scrollbar itself, above or below the thumb position
+  # +direction+ is either 'up' (= left, if dealing with a horizontal
+  # scrollbar) or 'down' (= right) - WxRuby generates different events
+  # for these.
+  def on_page(event, direction)
+    pos = event.get_position
+    orient = event.get_orientation == Wx::VERTICAL ? 'VERTICAL' : 'HORIZONTAL'
+    puts "#{orient} scrollbar page #{direction} @ #{pos}"
+    event.skip # allow default scrolling action
+  end
+
+  
+  # Handle scrolling by line - typically done by clicking the up/down
+  # (or left/right) scroll buttons at the end of the scrollbar.
+  # +direction+ is either 'up' (= left, if dealing with a horizontal
+  # scrollbar) or 'down' (= right)
+  def on_line(event, direction)
+    orient = event.get_orientation == Wx::VERTICAL ? 'VERTICAL' : 'HORIZONTAL'
+    pos = event.get_position
+    puts "#{orient} scrollbar line #{direction} @ #{pos}"
+    event.skip # allow default action
+  end
+
+  # Handle scrolling done by click-dragging the 'thumb' within a scrollbar.
+  # +action+ contains either 'track' for thumbtrack drag events, or 'release'
+  # for thumb-release
+  def on_thumb(event, action)
+    pos = event.get_position
+    if event.get_orientation == Wx::VERTICAL
+      puts "VERTICAL thumb #{action} @ #{pos}"
+    else
+      puts "HORIZONTAL thumb #{action} @ #{pos}"
+    end
+    event.skip
+  end
+
+  # (Assuming this should be triggered when the End key is pressed)?
+  def on_bottom(event)
+    puts "bottom"
+  end
+  
+
+  #  (Assuming this should be triggered when the Home/Begin key is pressed)?
+  def on_top(event)
+    puts "top"
+  end
+
+end
+
+module ScrollwinSample
+
+  include WxRuby::Sample if defined? WxRuby::Sample
+
+  def self.describe
+    { file: __FILE__,
+      summary: 'wxRuby ScrolledWindow example.',
+      description: 'wxRuby example demonstrating the use of Wx::ScrolledWindow and the ScrollWinEvents.' }
+  end
+
+  def self.activate
+    frame = ScrollFrame.new('')
+    frame.show(true)
+    frame
+  end
+
+  if $0 == __FILE__
+    Wx::App.run { ScrollwinSample.activate }
+  end
+
+end

data/samples/etc/system_settings.rb

@@ -0,0 +1,263 @@
+#!/usr/bin/env ruby
+# wxRuby2 Sample Code. Copyright (c) 2004-2008 wxRuby development team
+# Adapted for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require 'wx'
+
+# This example lists the various system settings that WxRuby knows
+# about. To use it, run it and use the 'View' menu to list the different
+# groups of settings available.
+
+# A class to display system settings in a spreadsheet-like table.
+class SystemSettingsTable < Wx::Grid
+  def initialize(parent)
+    super(parent, -1)
+    max_length = [ COLOURS.length, FONTS.length, METRICS.length ].max
+    create_grid( max_length, 3)
+
+    set_row_label_size(0)
+    set_row_label_alignment(Wx::ALIGN_RIGHT, Wx::ALIGN_CENTRE)
+
+    set_col_label_value(0, 'Name')
+    set_col_size(0, 200)
+    set_col_label_value(1, 'Value')
+    set_col_size(1, 100)
+    set_col_label_value(2, 'Description')
+    set_col_size(2, 300)
+  end
+
+  # blank out all row labels from +from_row+ to the end of the grid.
+  def tidy_row_labels(from_row = 0)
+    from_row.upto( get_number_rows - 1 ) do | row |
+      set_row_label_value(row, '')
+    end
+  end
+
+  # display a settings constant name +const+, its value +value+ and a
+  # text description +desc+ of that setting in the row +row+
+  def list(row, const, val, desc)
+    set_cell_value(row, 0, const)
+    set_cell_value(row, 1, val.to_s )
+    set_cell_value(row, 2, desc)
+  end
+
+  # List the elements of the system's colour scheme, giving each one's
+  # Wx constant name, its RGB value in hex, and the description of how it
+  # is used.
+  def list_colours
+    clear_grid
+    COLOURS.each_with_index do | item, i |
+      constant_name, description = *item
+      const = Wx::const_get(constant_name)
+      # obtain a Wx::Colour object for the named constantb
+      colour  = Wx::SystemSettings.get_colour(const)
+      colour_hex = '#%02X%02X%02X' % 
+                [ colour.red, colour.green, colour.blue ]
+      list( i, constant_name, colour_hex, description )
+    end
+    tidy_row_labels(COLOURS.length)
+  end
+
+  # List the standard system fonts, giving each one's Wx contant name,
+  # the font's platform descriptor, and a description of its use.
+  def list_fonts
+    clear_grid
+    FONTS.each_with_index do | item, i |
+      constant_name, description = *item
+      const = Wx::const_get(constant_name)
+      # obtain a standard system font
+      font  = Wx::SystemSettings.get_font(const)
+      font_desc = "%s %ipt" % 
+                             [ font.get_face_name, font.get_point_size ]
+      list( i, constant_name, font_desc, description )
+    end
+    tidy_row_labels(FONTS.length)
+  end
+
+  # List various standard measurements of GUI elements and areas, such as
+  # the size of the screen, cursor, icons and window borders. For each
+  # one, the WxRuby constant name, the value (usually in pixels), and a
+  # short description of its use is given.
+  # 
+  # Not all metrics are implemented in Wx on all platforms; undefined
+  # values are shown as '-1'.
+  def list_metrics
+    clear_grid
+    METRICS.each_with_index do | item, i |
+      constant_name, description = *item
+      const = Wx::const_get(constant_name)
+      # obtain a standard system metric
+      metric = Wx::SystemSettings.get_metric(const)
+      list( i, constant_name, metric, description )
+    end
+    tidy_row_labels(METRICS.length)
+  end
+
+  # copied from WxWidgets 2.6.2 documentation
+  COLOURS = [
+    [ 'SYS_COLOUR_SCROLLBAR', 'The scrollbar grey area.' ],
+    [ 'SYS_COLOUR_BACKGROUND', 'The desktop colour.' ],
+    [ 'SYS_COLOUR_ACTIVECAPTION', 'Active window caption.' ],
+    [ 'SYS_COLOUR_INACTIVECAPTION', 'Inactive window caption.' ],
+    [ 'SYS_COLOUR_MENU', 'Menu background.' ],
+    [ 'SYS_COLOUR_WINDOW', 'Window background.' ],
+    [ 'SYS_COLOUR_WINDOWFRAME', 'Window frame.' ],
+    [ 'SYS_COLOUR_MENUTEXT', 'Menu text.' ],
+    [ 'SYS_COLOUR_WINDOWTEXT', 'Text in windows.' ],
+    [ 'SYS_COLOUR_CAPTIONTEXT', 'Text in caption, size box and scrollbar arrow box.' ],
+    [ 'SYS_COLOUR_ACTIVEBORDER', 'Active window border.' ],
+    [ 'SYS_COLOUR_INACTIVEBORDER', 'Inactive window border.' ],
+    [ 'SYS_COLOUR_APPWORKSPACE', 'Background colour MDI applications.' ],
+    [ 'SYS_COLOUR_HIGHLIGHT', 'Item(s) selected in a control.' ],
+    [ 'SYS_COLOUR_HIGHLIGHTTEXT', 'Text of item(s) selected in a control.' ],
+    [ 'SYS_COLOUR_BTNFACE', 'Face shading on push buttons.' ],
+    [ 'SYS_COLOUR_BTNSHADOW', 'Edge shading on push buttons.' ],
+    [ 'SYS_COLOUR_GRAYTEXT', 'Greyed (disabled) text.' ],
+    [ 'SYS_COLOUR_BTNTEXT', 'Text on push buttons.' ],
+    [ 'SYS_COLOUR_INACTIVECAPTIONTEXT', 'Colour of text in active captions.' ],
+    [ 'SYS_COLOUR_BTNHIGHLIGHT', 'Highlight colour for buttons (same as wxSYS_COLOUR_3DHILIGHT).' ],
+    [ 'SYS_COLOUR_3DDKSHADOW', 'Dark shadow for three-dimensional display elements.' ],
+    [ 'SYS_COLOUR_3DLIGHT', 'Light colour for three-dimensional display elements.' ],
+    [ 'SYS_COLOUR_INFOTEXT', 'Text colour for tooltip controls.' ],
+    [ 'SYS_COLOUR_INFOBK', 'Background colour for tooltip controls.' ],
+    [ 'SYS_COLOUR_DESKTOP', 'Same as wxSYS_COLOUR_BACKGROUND.' ],
+    [ 'SYS_COLOUR_3DFACE', 'Same as wxSYS_COLOUR_BTNFACE.' ],
+    [ 'SYS_COLOUR_3DSHADOW', 'Same as wxSYS_COLOUR_BTNSHADOW.' ],
+    [ 'SYS_COLOUR_3DHIGHLIGHT', 'Same as wxSYS_COLOUR_BTNHIGHLIGHT.' ],
+    [ 'SYS_COLOUR_3DHILIGHT', 'Same as wxSYS_COLOUR_BTNHIGHLIGHT.' ],
+    [ 'SYS_COLOUR_BTNHILIGHT', 'Same as wxSYS_COLOUR_BTNHIGHLIGHT.' ]
+  ]
+
+  # copied from WxWidgets 2.6.2 documentation
+  FONTS = [
+    [ 'SYS_OEM_FIXED_FONT', 'Original equipment manufacturer dependent fixed-pitch font.' ],
+    [ 'SYS_ANSI_FIXED_FONT', 'Windows fixed-pitch font.' ],
+    [ 'SYS_ANSI_VAR_FONT', 'Windows variable-pitch (proportional) font.' ],
+    [ 'SYS_SYSTEM_FONT', 'System font.' ],
+    [ 'SYS_DEVICE_DEFAULT_FONT', 'Device-dependent font (Windows NT only).' ],
+    [ 'SYS_DEFAULT_GUI_FONT', 'Default font for user interface objects such as menus and dialog boxes.' ]
+  ]
+
+  # copied from WxWidgets 2.6.2 documentation
+  METRICS = [
+    [ 'SYS_MOUSE_BUTTONS', 'Number of buttons on mouse, or zero if no mouse was installed.' ],
+    [ 'SYS_BORDER_X', 'Width of single border.' ],
+    [ 'SYS_BORDER_Y', 'Height of single border.' ],
+    [ 'SYS_CURSOR_X', 'Width of cursor.' ],
+    [ 'SYS_CURSOR_Y', 'Height of cursor.' ],
+    [ 'SYS_DCLICK_X', 'Width in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click.' ],
+    [ 'SYS_DCLICK_Y', 'Height in pixels of rectangle within which two successive mouse clicks must fall to generate a double-click.' ],
+    [ 'SYS_DRAG_X', 'Width in pixels of a rectangle centered on a drag point to allow for limited movement of the mouse pointer before a drag operation begins.' ],
+    [ 'SYS_DRAG_Y', 'Height in pixels of a rectangle centered on a drag point to allow for limited movement of the mouse pointer before a drag operation begins.' ],
+    [ 'SYS_EDGE_X', 'Width of a 3D border, in pixels.' ],
+    [ 'SYS_EDGE_Y', 'Height of a 3D border, in pixels.' ],
+    [ 'SYS_HSCROLL_ARROW_X', 'Width of arrow bitmap on horizontal scrollbar.' ],
+    [ 'SYS_HSCROLL_ARROW_Y', 'Height of arrow bitmap on horizontal scrollbar.' ],
+    [ 'SYS_HTHUMB_X', 'Width of horizontal scrollbar thumb.' ],
+    [ 'SYS_ICON_X', 'The default width of an icon.' ],
+    [ 'SYS_ICON_Y', 'The default height of an icon.' ],
+    [ 'SYS_ICONSPACING_X', 'Width of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged.' ],
+    [ 'SYS_ICONSPACING_Y', 'Height of a grid cell for items in large icon view, in pixels. Each item fits into a rectangle of this size when arranged.' ],
+    [ 'SYS_WINDOWMIN_X', 'Minimum width of a window.' ],
+    [ 'SYS_WINDOWMIN_Y', 'Minimum height of a window.' ],
+    [ 'SYS_SCREEN_X', 'Width of the screen in pixels.' ],
+    [ 'SYS_SCREEN_Y', 'Height of the screen in pixels.' ],
+    [ 'SYS_FRAMESIZE_X', 'Width of the window frame for a wxTHICK_FRAME window.' ],
+    [ 'SYS_FRAMESIZE_Y', 'Height of the window frame for a wxTHICK_FRAME window.' ],
+    [ 'SYS_SMALLICON_X', 'Recommended width of a small icon (in window captions, and small icon view).' ],
+    [ 'SYS_SMALLICON_Y', 'Recommended height of a small icon (in window captions, and small icon view).' ],
+    [ 'SYS_HSCROLL_Y', 'Height of horizontal scrollbar in pixels.' ],
+    [ 'SYS_VSCROLL_X', 'Width of vertical scrollbar in pixels.' ],
+    [ 'SYS_VSCROLL_ARROW_X', 'Width of arrow bitmap on a vertical scrollbar.' ],
+    [ 'SYS_VSCROLL_ARROW_Y', 'Height of arrow bitmap on a vertical scrollbar.' ],
+    [ 'SYS_VTHUMB_Y', 'Height of vertical scrollbar thumb.' ],
+    [ 'SYS_CAPTION_Y', 'Height of normal caption area.' ],
+    [ 'SYS_MENU_Y', 'Height of single-line menu bar.' ],
+    [ 'SYS_NETWORK_PRESENT', '1 if there is a network present, 0 otherwise.' ],
+    [ 'SYS_PENWINDOWS_PRESENT', '1 if PenWindows is installed, 0 otherwise.' ],
+    [ 'SYS_SHOW_SOUNDS', 'Non-zero if the user requires an application to present information visually in situations where it would otherwise present the information only in audible form; zero otherwise.' ],
+    [ 'SYS_SWAP_BUTTONS', 'Non-zero if the meanings of the left and right mouse buttons are swapped; zero otherwise.' ]
+  ]
+end
+
+
+# A simple frame that just shows a table with the System Settings in it.
+class SettingsFrame < Wx::Frame
+
+  def initialize(title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE)
+    super(nil, -1, title, pos, size)
+    sizer = Wx::BoxSizer.new(Wx::HORIZONTAL)
+    @table = SystemSettingsTable.new(self)
+    sizer.add(@table, 1, Wx::GROW|Wx::ALL, 2)
+    self.set_sizer(sizer)
+    construct_menus
+    @table.list_colours
+  end
+
+  ID_SHOW_COLOURS = 1
+  ID_SHOW_FONTS   = 2
+  ID_SHOW_METRICS = 3
+  def construct_menus
+    menu_bar = Wx::MenuBar.new
+
+    menu_file = Wx::Menu.new
+    menu_file.append(Wx::ID_EXIT, "E&xit\tAlt-X", "Quit this program")
+    menu_bar.append(menu_file, "&File")
+    evt_menu(Wx::ID_EXIT) { on_quit }
+
+    menu_view = Wx::Menu.new
+    menu_view.append(ID_SHOW_COLOURS, 
+                     "Show &Colours", "Show system colours")
+    evt_menu(ID_SHOW_COLOURS) { @table.list_colours }
+    menu_view.append(ID_SHOW_FONTS, 
+                     "Show &Fonts", "Show system fonts")
+    evt_menu(ID_SHOW_FONTS) { @table.list_fonts }
+    menu_view.append(ID_SHOW_METRICS, 
+                     "Show &Metrics", "Show system metrics")
+    evt_menu(ID_SHOW_METRICS) { @table.list_metrics }
+    menu_bar.append(menu_view, "&View")
+
+    menu_help = Wx::Menu.new
+    menu_help.append(Wx::ID_ABOUT, "&About...\tF1", "Show about dialog")
+    evt_menu(Wx::ID_ABOUT) { on_about }
+    menu_bar.append(menu_help, "&Help")
+
+    set_menu_bar(menu_bar)
+  end
+
+  def on_quit
+    close(true)
+  end
+
+  def on_about
+    msg =  sprintf("This is the About dialog of the minimal sample.\n" \
+                    "Welcome to %s", Wx::WXWIDGETS_VERSION)
+    Wx::message_box(msg, "About Minimal", Wx::OK|Wx::ICON_INFORMATION, self)
+  end
+end
+
+module SystemSettingsSample
+
+  include WxRuby::Sample if defined? WxRuby::Sample
+
+  def self.describe
+    { file: __FILE__,
+      summary: 'wxRuby SystemSettings example.',
+      description: 'wxRuby example demonstrating using SystemSettings and displaying various system settings in a grid.' }
+  end
+
+  def self.activate
+    frame = SettingsFrame.new("System Settings",
+                              Wx::DEFAULT_POSITION,
+                              Wx::Size.new(600, 400) )
+    frame.show(true)
+    frame
+  end
+
+  if $0 == __FILE__
+    Wx::App.run { SystemSettingsSample.activate }
+  end
+
+end

data/samples/event/activation.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+# wxRuby2 Sample Code. Copyright (c) 2004-2008 wxRuby development team
+# Adapted for wxRuby3
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require 'wx'
+
+# This sample demonstrates the use of Activate Events. These are
+# generated when a frame becomes active or inactive. This is typically
+# indicated by a frame's titlebar changing colour, and a widget within
+# the frame gainin focus. An event is also generated when a whole wxRuby
+# app starts or stops being the current focussed desktop application.
+
+class MinimalFrame < Wx::Frame
+  def initialize(title, pos, size, style = Wx::DEFAULT_FRAME_STYLE)
+    super(nil, -1, title, pos, size, style)
+
+
+    menuFile = Wx::Menu.new
+    helpMenu = Wx::Menu.new
+    helpMenu.append(Wx::ID_ABOUT, "&About...\tF1", "Show about dialog")
+    menuFile.append(Wx::ID_EXIT, "E&xit\tAlt-X", "Quit this program")
+    menuBar = Wx::MenuBar.new
+    menuBar.append(menuFile, "&File")
+    menuBar.append(helpMenu, "&Help")
+    set_menu_bar(menuBar)
+
+    create_status_bar(2)
+    set_status_text("Welcome to wxRuby!")
+
+    evt_close { on_quit }
+
+    evt_menu(Wx::ID_EXIT) { on_quit }
+    evt_menu(Wx::ID_ABOUT) { on_about }
+
+    evt_activate { | e | on_activate(e) }
+    evt_iconize  { | e | on_iconize(e) }
+  end
+
+
+  def on_iconize(event)
+    if event.iconized
+      puts "Frame '#{get_title}' was iconized"
+    else
+      puts "Frame '#{get_title}' was restored"
+    end
+  end
+
+  def on_activate(event)
+    return if Wx::get_app.destroying
+    if event.get_active
+      puts "Frame '#{get_title}' became activated"
+      set_status_text 'Active'
+    else
+      puts "Frame '#{get_title}' became deactivated"
+      set_status_text 'Inactive'
+    end
+    event.skip # important
+  end
+
+  def on_quit
+    Wx::get_app.close_all
+  end
+
+  def on_about
+    msg =  sprintf("This is the About dialog of the activate sample.\n" \
+                    "Welcome to wxRuby, version %s", Wx::WXRUBY_VERSION)
+    Wx::message_box(msg, "About Activate", Wx::OK|Wx::ICON_INFORMATION, self)
+  end
+end
+
+class RbApp < Wx::App
+  def on_init
+    @frame_1 = MinimalFrame.new("Tall window",
+                                Wx::Point.new(50, 50), 
+                                Wx::Size.new(150, 240))
+    @frame_2 = MinimalFrame.new("Wide window",
+                                Wx::Point.new(100, 100), 
+                                Wx::Size.new(300, 180))
+    evt_activate_app { | e | on_activate_app(e) }
+    @frame_1.show
+    @frame_2.show
+  end
+
+  attr_reader :destroying
+
+  def on_activate_app(event)
+    if event.get_active
+      puts "The app became active"
+    else
+      puts "The app became inactive"
+    end
+    event.skip # important
+  end
+
+  def close_all
+    @frame_1.destroy
+    @frame_2.destroy
+  end
+end
+
+module ActivationSample
+
+  include WxRuby::Sample if defined? WxRuby::Sample
+
+  def self.describe
+    { file: __FILE__,
+      summary: 'wxRuby Activate events example.',
+      description: <<~__TXT
+        wxRuby example demonstrating the use of Activate Events.
+        This sample demonstrates the use of Activate Events. These are
+        generated when a frame becomes active or inactive. This is typically
+        indicated by a frame's titlebar changing colour, and a widget within
+        the frame gainin focus. An event is also generated when a whole wxRuby
+        app starts or stops being the current focussed desktop application.
+        __TXT
+     }
+  end
+
+  def self.run
+    execute(__FILE__)
+  end
+
+  if $0 == __FILE__
+    RbApp.run
+  end
+
+end