fxruby 1.2.2

data/rdoc-sources/FXRGBIcon.rb

@@ -0,0 +1,49 @@
+module Fox
+  #
+  # Iris RGB Icon
+  #
+  class FXRGBIcon < FXIcon
+    #
+    # Return an initialized FXRGBIcon instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +pix+::	a memory buffer formatted in IRIS RGB 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: theRGBIcon
+    end
+  end
+  
+  #
+  # Load a RGB file from a stream.
+  # If successful, returns an array containing the image pixel data (as a
+  # String), the transparency color, 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 fxloadRGB(store); end
+
+  #
+  # Save a RGB image to a stream.
+  # Returns +true+ on success, +false+ on failure.
+  #
+  # ==== Parameters:
+  #
+  # +store+::	stream to which to write the file data [FXStream]
+  # +data+::	the image pixel data [String]
+  # +transp+::	transparency color [FXColor]
+  # +opts+::	options [Integer]
+  # +width+::	width [Integer]
+  # +height+::	height [Integer]
+  #
+  def fxsavePNG(store, data, transp, width, height); end
+end
+

data/rdoc-sources/FXRGBImage.rb

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

data/rdoc-sources/FXRadioButton.rb

@@ -0,0 +1,64 @@
+module Fox
+  #
+  # A radio button is a tri-state button.  Normally, it is either
+  # +TRUE+ or +FALSE+; a third state +MAYBE+ may be set to indicate that no selection
+  # has been made yet by the user, or that the state is ambiguous.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXRadioButton to its target:
+  #
+  # +SEL_COMMAND+::		sent when the radio button is pressed.
+  # +SEL_KEYPRESS+::		sent when a key goes down; the message data is an FXEvent instance.
+  # +SEL_KEYRELEASE+::		sent when a key goes up; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONPRESS+::	sent when the left mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONRELEASE+::	sent when the left mouse button goes up; the message data is an FXEvent instance.
+  #
+  # === RadioButton flags
+  #
+  # +RADIOBUTTON_AUTOGRAY+::	Automatically gray out when not updated
+  # +RADIOBUTTON_AUTOHIDE+::	Automatically hide when not updated
+  # +RADIOBUTTON_NORMAL+::	<tt>JUSTIFY_NORMAL|ICON_BEFORE_TEXT</tt>
+  #
+  class FXRadioButton < FXLabel
+
+    # Radio button state, one of +TRUE+, +FALSE+ or +MAYBE+ [Integer]
+    attr_accessor :checkState
+    
+    # Radio button style [Integer]
+    attr_accessor :radioButtonStyle
+    
+    # Radio ball color [FXColor]
+    attr_accessor :radioColor
+    
+    # Radio disk color [FXColor]
+    attr_accessor :diskColor
+
+    #
+    # Construct new radio button
+    #
+    def initialize(parent, text, target=nil, selector=0, opts=RADIOBUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theRadioButton
+    end
+
+    #
+    # Return +true+ if the radio button state is +TRUE+
+    #
+    def checked?
+      self.checkState == Fox::TRUE
+    end
+    
+    #
+    # Return +true+ if the radio button state is +FALSE+
+    #
+    def unchecked?
+      self.checkState == Fox::FALSE
+    end
+
+    #
+    # Return +true+ if the radio button state is +MAYBE+
+    #
+    def maybe?
+      self.checkState == Fox::MAYBE
+    end
+  end
+end

data/rdoc-sources/FXRanged.rb

@@ -0,0 +1,97 @@
+module Fox
+  #
+  # Represents a range in 3-D space.
+  #
+  class FXRanged
+  
+    # Lower corner of range [FXVec3d]
+    attr_accessor :lower
+
+    # Upper corner of range [FXVec3d]
+    attr_accessor :upper
+
+    # Default constructor
+    def initialize(xlo=0.0, xhi=0.0, ylo=0.0, yhi=0.0, zlo=0.0, zhi=0.0) ; end
+
+    # Initialize this FXRanged instance from another instance
+    def initialize(bounds); end
+
+    # Initialize box to fully contain the given sphere (an FXSphered instance)
+    def initialize(sphere); end
+
+    # Return the width of the box
+    def width; end
+
+    # Return the height of the box
+    def height; end
+
+    # Return the depth of the box
+    def depth; end
+
+    # Return the length of the longest side of the box
+    def longest; end
+
+    # Return the length of the shortest side of the box
+    def shortest; end
+
+    # Return the length of the diagonal of the box
+    def diameter; end
+
+    # Return the diagonal vector for the box (an FXVec3d instance).
+    def diagonal; end
+
+    # Return the center of the box (a point, as an FXVec3d instance).
+    def center; end
+
+    # Returns +true+ if this is an empty range (i.e. if any of the side
+    # lengths is zero or less).
+    def empty?() ; end
+
+    # Returns +true+ if this range contains the point (_x_, _y_, _z_).
+    def contains?(x, y, z) ; end
+
+    # Returns +true+ if this range contains the point _p_ (an FXVec3d instance)
+    def contains?(p) ; end
+
+    # Returns +true+ if this box properly contains _aRange_ (another FXRanged
+    # instance)
+    def contains?(aRange) ; end
+
+    # Returns +true+ if this box properly contains _aSphere_ (an FXSphered
+    # instance)
+    def contains?(aSphere) ; end
+
+    #
+    # Include the given range or point into this range and return a reference
+    # to self. Valid forms are:
+    #
+    #     range.include!(aRange)  -> range
+    #     range.include!(x, y, z) -> range
+    #     range.include!(vec)     -> range
+    #     range.include!(sphere)  -> range
+    #
+    def include!(*args) ; end
+
+    # Intersect box with a plane <em>ax+by+cz+w</em>; returns -1, 0 or 1.
+    def intersect(plane); end
+
+    # Return true if the ray from _u_ to _v_ (both FXVec3d instances
+    # representing the ray endpoints) intersects this box.
+    def intersects?(u, v) ; end
+
+    # Returns +true+ if any part of this range overlaps the _other_ range.
+    def overlaps?(other) ; end
+
+    # Return the _c_th corner of this box (an FXVec3d instance).
+    # Raises IndexError if _c_ is less than zero or greater than 7.
+    def corner(c); end
+
+    # Return a new FXRanged instance which is the union of this box and
+    # another box.
+    def union(other); end
+
+    # Return a new FXRanged instance which is the intersection of this box
+    # and another box.
+    def intersection(other); end
+  end
+end

data/rdoc-sources/FXRangef.rb

@@ -0,0 +1,97 @@
+module Fox
+  #
+  # Represents a range in 3-D space.
+  #
+  class FXRangef
+  
+    # Lower corner of range [FXVec3f]
+    attr_accessor :lower
+
+    # Upper corner of range [FXVec3f]
+    attr_accessor :upper
+
+    # Default constructor
+    def initialize(xlo=0.0, xhi=0.0, ylo=0.0, yhi=0.0, zlo=0.0, zhi=0.0) ; end
+
+    # Initialize this FXRangef instance from another instance
+    def initialize(bounds); end
+
+    # Initialize box to fully contain the given sphere (an FXSpheref instance)
+    def initialize(sphere); end
+
+    # Return the width of the box
+    def width; end
+
+    # Return the height of the box
+    def height; end
+
+    # Return the depth of the box
+    def depth; end
+
+    # Return the length of the longest side of the box
+    def longest; end
+
+    # Return the length of the shortest side of the box
+    def shortest; end
+
+    # Return the length of the diagonal of the box
+    def diameter; end
+
+    # Return the diagonal vector for the box (an FXVec3f instance).
+    def diagonal; end
+
+    # Return the center of the box (a point, as an FXVec3f instance).
+    def center; end
+
+    # Returns +true+ if this is an empty range (i.e. if any of the side
+    # lengths is zero or less).
+    def empty?() ; end
+
+    # Returns +true+ if this range contains the point (_x_, _y_, _z_).
+    def contains?(x, y, z) ; end
+
+    # Returns +true+ if this range contains the point _p_ (an FXVec3f instance)
+    def contains?(p) ; end
+
+    # Returns +true+ if this box properly contains _aRange_ (another FXRangef
+    # instance)
+    def contains?(aRange) ; end
+
+    # Returns +true+ if this box properly contains _aSphere_ (an FXSpheref
+    # instance)
+    def contains?(aSphere) ; end
+
+    #
+    # Include the given range or point into this range and return a reference
+    # to self. Valid forms are:
+    #
+    #     range.include!(aRange)  -> range
+    #     range.include!(x, y, z) -> range
+    #     range.include!(vec)     -> range
+    #     range.include!(sphere)  -> range
+    #
+    def include!(*args) ; end
+
+    # Intersect box with a plane <em>ax+by+cz+w</em>; returns -1, 0 or 1.
+    def intersect(plane); end
+
+    # Return true if the ray from _u_ to _v_ (both FXVec3f instances
+    # representing the ray endpoints) intersects this box.
+    def intersects?(u, v) ; end
+
+    # Returns +true+ if any part of this range overlaps the _other_ range.
+    def overlaps?(other) ; end
+
+    # Return the _c_th corner of this box (an FXVec3f instance).
+    # Raises IndexError if _c_ is less than zero or greater than 7.
+    def corner(c); end
+
+    # Return a new FXRangef instance which is the union of this box and
+    # another box.
+    def union(other); end
+
+    # Return a new FXRangef instance which is the intersection of this box
+    # and another box.
+    def intersection(other); end
+  end
+end

data/rdoc-sources/FXRealSlider.rb

@@ -0,0 +1,99 @@
+module Fox
+  #
+  # The slider widget is a valuator widget which provides simple linear value range.
+  # Two visual appearances are supported:- the sunken look, which is enabled with
+  # the +REALSLIDER_INSIDE_BAR+ option and the regular look.  The latter may have optional
+  # arrows on the slider thumb.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXRealSlider to its target:
+  #
+  # +SEL_LEFTBUTTONPRESS+::	sent when the left mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONRELEASE+::	sent when the left mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_MIDDLEBUTTONPRESS+::	sent when the middle mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_MIDDLEBUTTONRELEASE+::	sent when the middle mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_COMMAND+::
+  #   sent at the end of a slider move; the message data is the new position of the slider (a Float).
+  # +SEL_CHANGED+::
+  #   sent continuously while the slider is being moved; the message data is an integer indicating
+  #   the current slider position.
+  #
+  # === Real slider control styles
+  #
+  # +REALSLIDER_HORIZONTAL+::	RealSlider shown horizontally
+  # +REALSLIDER_VERTICAL+::		RealSlider shown vertically
+  # +REALSLIDER_ARROW_UP+::		RealSlider has arrow head pointing up
+  # +REALSLIDER_ARROW_DOWN+::	RealSlider has arrow head pointing down
+  # +REALSLIDER_ARROW_LEFT+::	RealSlider has arrow head pointing left
+  # +REALSLIDER_ARROW_RIGHT+::	RealSlider has arrow head pointing right
+  # +REALSLIDER_INSIDE_BAR+::	RealSlider is inside the slot rather than overhanging
+  # +REALSLIDER_TICKS_TOP+::	Ticks on the top of horizontal slider
+  # +REALSLIDER_TICKS_BOTTOM+::	Ticks on the bottom of horizontal slider
+  # +REALSLIDER_TICKS_LEFT+::	Ticks on the left of vertical slider
+  # +REALSLIDER_TICKS_RIGHT+::	Ticks on the right of vertical slider
+  # +REALSLIDER_NORMAL+::		same as <tt>REALSLIDER_HORIZONTAL</tt>
+  #
+  # === Message identifiers
+  #
+  # +ID_AUTOINC+::	x
+  # +ID_AUTODEC+::	x
+  #
+  class FXRealSlider < FXFrame
+
+    # Slider value [Float]
+    attr_accessor :value
+
+    # Slider style [Integer]
+    attr_accessor :sliderStyle
+
+    # Slider head size, in pixels [Integer]
+    attr_accessor :headSize
+    
+    # Slider slot size, in pixels [Integer]
+    attr_accessor :slotSize
+    
+    # Slider auto-increment (or decrement) value [Float]
+    attr_accessor :increment
+    
+    # Delta between ticks [Float]
+    attr_accessor :tickDelta
+    
+    # Color of the slot that the slider head moves in [FXColor]
+    attr_accessor :slotColor
+    
+    # Status line help text for this slider [String]
+    attr_accessor :helpText
+    
+    # Tool tip text for this slider [String]
+    attr_accessor :tipText
+    
+    #
+    # Return an initialized FXRealSlider instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this slider [FXComposite]
+    # +tgt+::	the message target, if any, for this slider [FXObject]
+    # +sel+::	the message identifier for this slider [Integer]
+    # +opts+::	slider options [Integer]
+    # +x+::	initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
+    # +y+::	initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
+    # +w+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +h+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    #
+    def initialize(p, tgt=nil, sel=0, opts=REALSLIDER_NORMAL, x=0, y=0, w=0, h=0, pl=0, pr=0, pt=0, pb=0) # :yields: theRealSlider
+    end
+
+    # Set slider range (where _lo_ and _hi_ are Float values).
+    def setRange(lo, hi); end
+
+    # Return the slider range as an array of Float values [lo, hi].
+    def getRange(); end
+  end
+end
+

data/rdoc-sources/FXRealSpinner.rb

@@ -0,0 +1,133 @@
+module Fox
+  #
+  # Real-valued spinner control
+  #
+  # === Events
+  #
+  # The following messages are sent by FXRealSpinner to its target:
+  #
+  # +SEL_KEYPRESS+::	sent when a key goes down; the message data is an FXEvent instance.
+  # +SEL_KEYRELEASE+::	sent when a key goes up; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONPRESS+::	sent when the left mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_LEFTBUTTONRELEASE+::	sent when the left mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_COMMAND+::
+  #   sent whenever the spinner's value changes; the message data is an integer
+  #   indicating the new spinner value.
+  # +SEL_CHANGED+::
+  #   sent whenever the text in the spinner's text field changes; the message
+  #   data is an integer indicating the new spinner value.
+  #
+  # === Spinner options
+  #
+  # +REALSPIN_NORMAL+::	Normal, non-cyclic
+  # +REALSPIN_CYCLIC+::	Cyclic spinner
+  # +REALSPIN_NOTEXT+::	No text visible
+  # +REALSPIN_NOMAX+::	Spin all the way up to infinity
+  # +REALSPIN_NOMIN+::	Spin all the way down to -infinity
+  # +REALSPIN_LOG+::	Logarithmic rather than linear
+  #
+  # === Message identifiers
+  #
+  # +ID_INCREMENT+::	x
+  # +ID_DECREMENT+::	x
+  # +ID_ENTRY+::	x
+  #
+  class FXRealSpinner < FXPacker
+    # Current value [Float]
+    attr_accessor :value
+
+    # Spinner range (low and high values) [Range]
+    attr_accessor :range
+
+    # Text font for this spinner [FXFont]
+    attr_accessor :font
+
+    # Status line help text for this spinner [String]
+    attr_accessor :helpText
+
+    # Tool tip text for this spinner [String]
+    attr_accessor :tipText
+    
+    # Spinner style [Integer]
+    attr_accessor :spinnerStyle
+    
+    # Color of the "up" arrow [FXColor]
+    attr_accessor :upArrowColor
+
+    # Color of the "down" arrow [FXColor]
+    attr_accessor :downArrowColor
+
+    # Normal text color [FXColor]
+    attr_accessor :textColor
+
+    # Background color for selected text [FXColor]
+    attr_accessor :selBackColor
+
+    # Foreground color for selected text [FXColor]
+    attr_accessor :selTextColor
+
+    # Cursor color [FXColor]
+    attr_accessor :cursorColor
+
+    # Number of columns (i.e. width of spinner's text field, in terms of number of columns of 'm') [Integer]
+    attr_accessor :numColumns
+
+    #
+    # Return an initialized FXRealSpinner instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this spinner [FXComposite]
+    # +cols+::	number of columns to display in the text field [Integer]
+    # +tgt+::	the message target, if any, for this spinner [FXObject]
+    # +sel+::	the message identifier for this spinner [Integer]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    #
+    def initialize(p, cols, tgt=nil, sel=0, opts=REALSPIN_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theRealSpinner
+    end
+  
+    # Increment spinner
+    def increment(); end
+  
+    # Decrement spinner
+    def decrement(); end
+  
+    # Return +true+ if the spinner is in cyclic mode.
+    def cyclic?; end
+  
+    #
+    # Set to cyclic mode, i.e. wrap around at maximum/minimum.
+    #
+    def cyclic=(cyc); end
+  
+    # Return +true+ if this spinner's text field is visible.
+    def textVisible?; end
+  
+    # Set the visibility of this spinner's text field.
+    def textVisible=(shown); end
+  
+    #
+    # Change the spinner increment value, i.e. the amount by which the spinner's
+    # value increases when the up arrow is clicked.
+    #
+    def setIncrement(inc); end
+
+    # Get the spinner increment value.
+    def getIncrement(); end
+
+    # Set the "editability" of this spinner's text field.
+    def editable=(ed); end
+  
+    # Return +true+ if the spinner's text field is editable.
+    def editable?; end
+  end
+end
+