fxruby 1.2.2

data/rdoc-sources/FXWizard.rb

@@ -0,0 +1,63 @@
+module Fox
+  #
+  # An FXWizard widget guides the user through a number of panels
+  # in a predefined sequence; each step must be completed before
+  # moving on to the next step.
+  # For example, an FXWizard may be used to install software components,
+  # and ask various questions at each step in the installation.
+  #
+  # === Message identifiers
+  #
+  # +ID_NEXT+::		Move to the next panel in the wizard
+  # +ID_BACK+::		Move to the previous panel in the wizard
+  #
+  class FXWizard < FXDialogBox
+  
+    # The button frame [FXHorizontalFrame]
+    attr_reader :buttonFrame
+    
+    # The "Advance" button [FXButton]
+    attr_reader :advanceButton
+    
+    # The "Retreat" button [FXButton]
+    attr_reader :retreatButton
+    
+    # The "Finish" button [FXButton]
+    attr_reader :finishButton
+    
+    # The "Cancel" button [FXButton]
+    attr_reader :cancelButton
+    
+    # The container used as parent for the sub-panels [FXSwitcher]
+    attr_reader :container
+    
+    # The image being displayed [FXImage]
+    attr_accessor :image
+    
+    #
+    # Return an initialized, free-floating FXWizard instance.
+    #
+    def initialize(a, name, image, opts=DECOR_TITLE|DECOR_BORDER|DECOR_RESIZE, x=0, y=0, w=0, h=0, pl=10, pr=10, pt=10, pb=10, hs=10, vs=10) # :yields: theWizard
+    end
+
+    #
+    # Return an initialized, window-owned FXWizard instance.
+    #
+    def initialize(owner, name, image, opts=DECOR_TITLE|DECOR_BORDER|DECOR_RESIZE, x=0, y=0, w=0, h=0, pl=10, pr=10, pt=10, pb=10, hs=10, vs=10) # :yields: theWizard
+    end
+
+    # Return the number of panels.
+    def numPanels; end
+
+    #
+    # Bring the child window at _index_ to the top.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def currentPanel=(index); end
+
+    #
+    # Return the index of the child window currently on top.
+    #
+    def currentPanel; end
+  end
+end

data/rdoc-sources/FXXBMIcon.rb

@@ -0,0 +1,22 @@
+module Fox
+  #
+  # X Bitmap (XBM) Icon
+  #
+  class FXXBMIcon < FXIcon
+    #
+    # Return an initialized FXXBMIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::		an application instance [FXApp]
+    # +pixels+::	a memory buffer formatted in XBM file format [String]
+    # +mask+::		a memory buffer formatted in XBM file format [String]
+    # +clr+::		transparency color [FXColor]
+    # +opts+::		options [Integer]
+    # +w+::		width [Integer]
+    # +h+::		height [Integer]
+    #
+    def initialize(a, pixels=nil, mask=nil, clr=0, opts=0, w=1, h=1) # :yields: theXBMIcon
+    end
+  end
+end

data/rdoc-sources/FXXBMImage.rb

@@ -0,0 +1,22 @@
+module Fox
+  #
+  # X Bitmap (XBM) image
+  #
+  class FXXBMImage < FXImage
+    #
+    # Return an initialized FXXBMImage instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::		an application instance [FXApp]
+    # +pixels+::	a memory buffer formatted in XBM file format [String]
+    # +mask+::		a memory buffer formatted in XBM file format [String]
+    # +opts+::		options [Integer]
+    # +w+::		width [Integer]
+    # +h+::		height [Integer]
+    #
+    def initialize(a, pixels=nil, mask=nil, opts=0, w=1, h=1) # :yields: theXBMImage
+    end
+  end
+end
+

data/rdoc-sources/FXXPMIcon.rb

@@ -0,0 +1,50 @@
+module Fox
+  #
+  # X Pixmap (XPM) Icon
+  #
+  class FXXPMIcon < FXIcon
+    #
+    # Return an initialized FXXPMIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in XPM file format [String]
+    # +clr+::	transparency color [FXColor]
+    # +opts+::	options [Integer]
+    # +w+::	width [Integer]
+    # +h+::	height [Integer]
+    #
+    def initialize(a, pix=nil, clr=0, opts=0, w=1, h=1) # :yields: theXPMIcon
+    end
+  end
+  
+  #
+  # Load a XPM file from a stream.
+  # If successful, returns an array containing the image pixel data (as an
+  # array of FXColor values), the transparency color (another FXColor) and the
+  # image width and the image height.
+  # If it fails, the function returns +nil+.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream from which to read the file data [FXStream]
+  #
+  def fxloadXPM(store); end
+
+  #
+  # Save an XPM image to _store_ (an FXStream instance).
+  # Returns +true+ on success, +false+ on failure.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream to which to write the file data [FXStream]
+  # +data+::	the image pixel data, an array of FXColor values
+  # +transp+::	transparency color [FXColor]
+  # +width+::	width [Integer]
+  # +height+::	height [Integer]
+  # +fast+::	if +true+, use fast something
+  #
+  def fxsaveXPM(store, data, transp, width, height, fast=true); end
+end
+

data/rdoc-sources/FXXPMImage.rb

@@ -0,0 +1,21 @@
+module Fox
+  #
+  # X Pixmap (XPM) Image
+  #
+  class FXXPMImage < FXImage
+    #
+    # Return an initialized FXXPMImage instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in XPM file format [String]
+    # +opts+::	options [Integer]
+    # +w+::	width [Integer]
+    # +h+::	height [Integer]
+    #
+    def initialize(a, pix=nil, opts=0, w=1, h=1) # :yields: theXPMImage
+    end
+  end
+end
+

data/rdoc-sources/README.rdoc

@@ -0,0 +1,53 @@
+= Introduction
+
+<b>This is the RDoc-generated API documentation for FXRuby version 1.2.</b>
+If you have some constructive comments about the content, format or
+presentation, please do send those to me (at mailto:lyle@rubyforge.org).
+
+= Page layout
+
+The page layout is roughly the same for every class. The page begins
+with a brief description of the class and is then followed by one or
+more of the following sections:
+
+[*Attributes*]
+  This section lists the names of all the attributes for this widget.
+  As with all Ruby object "attributes", these are actually just the names
+  of instance methods for the class, but it is nevertheless natural to think
+  of these as attributes (or _properties_) of the widget. Most attributes
+  are both readable and writeable, but some are only read-only, so be sure
+  to check the attributes listing within the main class documentation section
+  to be sure.
+[*Events*]
+  This section lists the types for all of the messages that this widget
+  might send to its message target, and the circumstances under which those
+  messages are sent. When it's important, the message data associated with
+  that event is also described.
+[*Options*]
+  Most widgets have one or more options that affect their appearance or
+  behavior. These options can be passed into the class's _new_
+  method when the object is first instantiated. They can usually also be
+  changed after the object exists via some object-specific accessor method.
+  For example, the options for an FXButton can be get or set via the
+  FXButton#buttonStyle accessor methods.
+
+= Where's the code?
+
+One difference you may notice from documentation generated for other
+Ruby extensions is that there's no source code attached to the instance
+methods when you click on them (i.e. they will appear to be empty
+method definitions). That's because most of these functions are in fact
+implemented in C++ code (since FXRuby is itself a C++ extension to Ruby).
+
+= TODO
+
+A few notes and suggestions from Hugh Sasse:
+
+* It may help to add information about what happens when block_given?()
+  is true or false, i.e. does this affect the return value for a method?
+* In lieu of (or in addition) to short code examples embedded in the API
+  documentation, links to examples that are shipped with FXRuby might be good.
+----
+
+The HTML pages for this documentation were generated using RDoc
+(http://rdoc.sourceforge.net). 

data/rdoc-sources/fxdefs.rb

@@ -0,0 +1,90 @@
+module Fox
+  # Make an unsigned int out of two unsigned shorts
+  def Fox.MKUINT(lo, hi); end
+  
+  # Return the message type for a selector
+  def Fox.SELTYPE(sel); end
+  
+  # Return the message identifier for a selector
+  def Fox.SELID(sel); end
+  
+  # Construct an FXColor value from its red, green and blue components
+  def Fox.FXRGB(r, g, b); end
+  
+  # Construct an FXColor value from its red, green, blue and alpha (transparency) components
+  def Fox.FXRGBA(r, g, b, a); end
+  
+  # Return the red value from an FXColor value
+  def Fox.FXREDVAL(color); end
+  
+  # Return the red value from an FXColor value
+  def Fox.FXGREENVAL(color); end
+
+  # Return the red value from an FXColor value
+  def Fox.FXBLUEVAL(color); end
+
+  # Return the red value from an FXColor value
+  def Fox.FXALPHAVAL(color); end
+
+  #
+  # Return the specified component value for this FXColor value,
+  # where _component_ is either 0, 1, 2 or 3.
+  #
+  def Fox.FXRGBACOMPVAL(color, component); end
+
+  #
+  # Return a "hot key" code value that represents the accelerator key
+  # described in the string _str_. The string can contain some combination
+  # of the modifiers _Ctrl_, _Alt_ and _Shift_, plus the key of interest.
+  # For example, to get the accelerator key for Ctrl+Alt+F7, you'd use:
+  #
+  #   hotKey = fxparseaccel("Ctrl+Alt+F7")
+  #
+  def Fox.fxparseaccel(str); end
+  
+  #
+  # Return a hot key value that represents the hot key described in
+  # the string _str_. This method is less flexible than the similar
+  # Fox.fxparseaccel, and is mainly used internally for parsing the
+  # labels for FXButton and FXMenuCommand widgets. For example, this:
+  #
+  #   fxparsehotkey("&File")
+  #
+  # returns the equivalent of:
+  #
+  #   fxparseaccel("Alt+F")
+  #
+  def Fox.fxparsehotkey(s); end
+  
+  # Locate hot key underline offset from begin of string
+  def Fox.fxfindhotkeyoffset(s); end
+  
+  # Get highlight color
+  def Fox.makeHiliteColor(clr); end
+  
+  # Get shadow color
+  def Fox.makeShadowColor(clr); end
+  
+  #
+  # Return the RGB value for this color name.
+  #
+  def Fox.fxcolorfromname(colorName); end
+  
+  #
+  # Return the name of the closest color to the input RGB value.
+  #
+  def Fox.fxnamefromcolor(color); end
+  
+  # Convert RGB to HSV
+  def Fox.fxrgb_to_hsv(r, g, b); end
+  
+  # Convert HSV to RGB
+  def Fox.fxhsv_to_rgb(h, s, v); end
+  
+  # Return the version number that the FOX library has been compiled with, as a String (e.g. "1.0.34"). 
+  def Fox.fxversion(); end
+  
+  # Controls tracing level
+  def Fox.fxTraceLevel; end
+end
+

data/tests/README

@@ -0,0 +1,19 @@
+This is the test suite for FXRuby (obviously still under development). It's
+mainly intended for use by Lyle to test new releases of FXRuby, but if you'd
+like to run the test suite yourself you will need to have installed a recent
+version of TestUnit, available here:
+
+    http://testunit.talbott.ws
+
+Each of the test cases has a file name of the form "TC_classname.rb". To run a
+particular test case, just type:
+
+    ruby TC_classname.rb
+
+and scan the results for any failures. To run the entire suite of test cases,
+type:
+
+    ruby TS_All.rb
+
+If you notice any failures in a (public) release of FXRuby, please notify
+Lyle. He wouldn't intentionally have let it go ;)

data/tests/TC_FXAccelTable.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+
+require 'fox12'
+
+include Fox
+
+class TC_FXAccelTable < Test::Unit::TestCase
+  def setup
+    @accel = FXAccelTable.new
+  end
+
+  def test_addAccel
+    hotkey = fxparseHotKey('&A')
+    target = FXObject.new
+    seldn, selup = 0, 0
+    @accel.addAccel(hotkey)
+    @accel.addAccel(hotkey, target)
+    @accel.addAccel(hotkey, target, seldn)
+    @accel.addAccel(hotkey, target, seldn, selup)
+  end
+  
+  def test_hasAccel
+    hotkey = fxparseHotKey('&b')
+    assert(!@accel.hasAccel?(hotkey))
+    @accel.addAccel(hotkey)
+    assert(@accel.hasAccel?(hotkey))
+  end
+  
+  def test_targetOfAccel
+    hotkey = fxparseHotKey("&x")
+    target = FXObject.new
+    @accel.addAccel(hotkey, target)
+    assert_same(target, @accel.targetOfAccel(hotkey))
+  end
+  
+  def test_removeAccel
+    hotkey = fxparseHotKey('&b')
+    @accel.addAccel(hotkey)
+    assert(@accel.hasAccel?(hotkey))
+    @accel.removeAccel(hotkey)
+    assert(!@accel.hasAccel?(hotkey))
+  end
+end

data/tests/TC_FXApp.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+require 'fox12'
+require 'testcase'
+
+include Fox
+
+class TC_FXApp < TestCase
+  def setup
+    super(self.class.name)
+  end
+  def test_initialized
+    assert(app.initialized?)
+  end
+end
+

data/tests/TC_FXArc.rb

@@ -0,0 +1,26 @@
+require 'test/unit'
+require 'fox12'
+
+include Fox
+
+class TC_FXArc < Test::Unit::TestCase
+  def test_new
+    anArc = FXArc.new
+    assert_equal(0, anArc.x)
+    assert_equal(0, anArc.y)
+    assert_equal(0, anArc.w)
+    assert_equal(0, anArc.h)
+    assert_equal(0, anArc.a)
+    assert_equal(0, anArc.b)
+  end
+  def test_new_with_values
+    anArc = FXArc.new(1, 2, 3, 4, 5, 6)
+    assert_equal(1, anArc.x)
+    assert_equal(2, anArc.y)
+    assert_equal(3, anArc.w)
+    assert_equal(4, anArc.h)
+    assert_equal(5, anArc.a)
+    assert_equal(6, anArc.b)
+  end
+end
+

data/tests/TC_FXButton.rb

@@ -0,0 +1,72 @@
+require 'test/unit'
+require 'fox12'
+require 'testcase'
+
+include Fox
+
+class TC_FXButton < TestCase
+  def setup
+    super("TC_FXButton")
+    @button = FXButton.new(mainWindow, "buttonText")
+  end
+  
+  def testText
+    assert(@button.text)
+    assert_instance_of(String, @button.text)
+    assert_equal("buttonText", @button.text)
+    assert_not_equal("googly-moogly", @button.text)
+    @button.text = nil
+    assert(@button.text)
+    assert_instance_of(String, @button.text)
+  end
+  
+  def testStyle
+    assert(@button.buttonStyle)
+    assert_instance_of(Fixnum, @button.buttonStyle)
+    
+    @button.buttonStyle |= BUTTON_AUTOGRAY
+    assert((@button.buttonStyle & BUTTON_AUTOGRAY) != 0)
+    @button.buttonStyle &= ~BUTTON_AUTOGRAY
+    assert((@button.buttonStyle & BUTTON_AUTOGRAY) == 0)
+
+    @button.buttonStyle |= BUTTON_AUTOHIDE
+    assert((@button.buttonStyle & BUTTON_AUTOHIDE) != 0)
+    @button.buttonStyle &= ~BUTTON_AUTOHIDE
+    assert((@button.buttonStyle & BUTTON_AUTOHIDE) == 0)
+
+    @button.buttonStyle |= BUTTON_TOOLBAR
+    assert((@button.buttonStyle & BUTTON_TOOLBAR) != 0)
+    @button.buttonStyle &= ~BUTTON_TOOLBAR
+    assert((@button.buttonStyle & BUTTON_TOOLBAR) == 0)
+
+    @button.buttonStyle |= BUTTON_DEFAULT
+    assert((@button.buttonStyle & BUTTON_DEFAULT) != 0)
+    @button.buttonStyle &= ~BUTTON_DEFAULT
+    assert((@button.buttonStyle & BUTTON_DEFAULT) == 0)
+
+    @button.buttonStyle |= BUTTON_INITIAL
+    assert((@button.buttonStyle & BUTTON_INITIAL) != 0)
+    @button.buttonStyle &= ~BUTTON_INITIAL
+    assert((@button.buttonStyle & BUTTON_INITIAL) == 0)
+  end
+  
+  def testState
+    assert(@button.state)
+    assert_kind_of(Fixnum, @button.state)
+    
+    @button.state = STATE_UP
+    assert_equal(STATE_UP, @button.state)
+    
+    @button.state = STATE_DOWN
+    assert_equal(STATE_DOWN, @button.state)
+    
+    @button.state = STATE_ENGAGED
+    assert_equal(STATE_ENGAGED, @button.state)
+    
+    @button.state = STATE_CHECKED
+    assert_equal(STATE_CHECKED, @button.state)
+    
+    @button.state = STATE_UNCHECKED
+    assert_equal(STATE_UNCHECKED, @button.state)
+  end
+end