fxruby 1.2.2

data/rdoc-sources/FXSphered.rb

@@ -0,0 +1,65 @@
+module Fox
+  class FXSphered
+    # Sphere center [FXVec3d]
+    attr_accessor :center
+    
+    # Sphere radius [Float]
+    attr_accessor :radius
+    
+    # Default constructor
+    def initialize; end
+    
+    # Copy constructor
+    def initialize(otherSphere); end
+    
+    # Initialize from center and radius
+    def initialize(cen, rad); end
+    
+    # Initialize from center (_x_, _y_, _z_) and radius (_rad_).
+    def initialize(x, y, z, rad); end
+    
+    # Initialize sphere to fully contain the given bounding box (an FXRanged instance).
+    def initialize(bounds); end
+    
+    # Return the diameter of this sphere.
+    def diameter; end
+    
+    # Return +true+ if this sphere is empty (i.e. has zero radius).
+    def empty?; end
+    
+    # Return +true+ if this sphere contains the point at (_x_, _y_, _z_).
+    def contains?(x, y, z); end
+    
+    # Return +true+ if this sphere contains the point _p_ (an FXVec3d instance).
+    def contains?(p); end
+    
+    # Return +true+ if this sphere properly contains _box_ (an FXRanged instance).
+    def contains?(box); end
+    
+    # Return +true+ if this sphere properly contains _sphere_ (another FXSphered instance).
+    def contains?(sphere); end
+    
+    # Include the point _p_ (an FXVec3d instance) and return a reference to self.
+    def include!(p); end
+    
+    # Include the range _box_ (an FXRanged instance) into this sphere and return self.
+    def include!(box); end
+    
+    # Include the sphere _sphere_ (an FXSphered instance) into this sphere and return self.
+    def include!(sphere); end
+    
+    # Intersect this sphere with the plane <em>ax+by+cz+w</em> and return -1, 0 or +1.
+    # Here, _plane_ is an FXVec4d instance describing the plane.
+    def intersect(plane); end
+    
+    # Return +true+ if this sphere intersects the ray between points _u_ and _v_
+    # (both FXVec3d instances).
+    def intersects?(u, v); end
+    
+    # Return +true+ if this sphere overlaps with _box_ (an FXRanged instance).
+    def overlaps?(box); end
+    
+    # Return +true+ if this sphere overlaps with another sphere.
+    def overlaps?(sphere); end
+  end
+end

data/rdoc-sources/FXSpheref.rb

@@ -0,0 +1,65 @@
+module Fox
+  class FXSpheref
+    # Sphere center [FXVec3f]
+    attr_accessor :center
+    
+    # Sphere radius [Float]
+    attr_accessor :radius
+    
+    # Default constructor
+    def initialize; end
+    
+    # Copy constructor
+    def initialize(otherSphere); end
+    
+    # Initialize from center and radius
+    def initialize(cen, rad); end
+    
+    # Initialize from center (_x_, _y_, _z_) and radius (_rad_).
+    def initialize(x, y, z, rad); end
+    
+    # Initialize sphere to fully contain the given bounding box (an FXRangef instance).
+    def initialize(bounds); end
+    
+    # Return the diameter of this sphere.
+    def diameter; end
+    
+    # Return +true+ if this sphere is empty (i.e. has zero radius).
+    def empty?; end
+    
+    # Return +true+ if this sphere contains the point at (_x_, _y_, _z_).
+    def contains?(x, y, z); end
+    
+    # Return +true+ if this sphere contains the point _p_ (an FXVec3f instance).
+    def contains?(p); end
+    
+    # Return +true+ if this sphere properly contains _box_ (an FXRangef instance).
+    def contains?(box); end
+    
+    # Return +true+ if this sphere properly contains _sphere_ (another FXSpheref instance).
+    def contains?(sphere); end
+    
+    # Include the point _p_ (an FXVec3f instance) and return a reference to self.
+    def include!(p); end
+    
+    # Include the range _box_ (an FXRangef instance) into this sphere and return self.
+    def include!(box); end
+    
+    # Include the sphere _sphere_ (an FXSpheref instance) into this sphere and return self.
+    def include!(sphere); end
+    
+    # Intersect this sphere with the plane <em>ax+by+cz+w</em> and return -1, 0 or +1.
+    # Here, _plane_ is an FXVec4f instance describing the plane.
+    def intersect(plane); end
+    
+    # Return +true+ if this sphere intersects the ray between points _u_ and _v_
+    # (both FXVec3f instances).
+    def intersects?(u, v); end
+    
+    # Return +true+ if this sphere overlaps with _box_ (an FXRangef instance).
+    def overlaps?(box); end
+    
+    # Return +true+ if this sphere overlaps with another sphere.
+    def overlaps?(sphere); end
+  end
+end

data/rdoc-sources/FXSpinner.rb

@@ -0,0 +1,132 @@
+module Fox
+  #
+  # Spinner control
+  #
+  # === Events
+  #
+  # The following messages are sent by FXSpinner 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
+  #
+  # +SPIN_NORMAL+::	Normal, non-cyclic
+  # +SPIN_CYCLIC+::	Cyclic spinner
+  # +SPIN_NOTEXT+::	No text visible
+  # +SPIN_NOMAX+::	Spin all the way up to infinity
+  # +SPIN_NOMIN+::	Spin all the way down to -infinity
+  #
+  # === Message identifiers
+  #
+  # +ID_INCREMENT+::	x
+  # +ID_DECREMENT+::	x
+  # +ID_ENTRY+::	x
+  #
+  class FXSpinner < FXPacker
+    # Current value [Integer]
+    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 FXSpinner 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=SPIN_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theSpinner
+    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
+

data/rdoc-sources/FXSplitter.rb

@@ -0,0 +1,88 @@
+module Fox
+  #
+  # A splitter window is used to interactively repartition
+  # two or more subpanels.
+  # The space may be subdivided horizontally or vertically.
+  # When the splitter is itself resized, the right-most (or bottom-most)
+  # child window will be resized unless the splitter window is _reversed_;
+  # if the splitter is reversed, the left-most (or top-most) child window
+  # will be resized instead.
+  # Normally, children are resizable from size 0 upwards; however, if the child
+  # in a horizontally-oriented splitter has +LAYOUT_FILL_X+ in combination with 
+  # +LAYOUT_FIX_WIDTH+, it will not be made smaller than its default width,
+  # except when the child is the last visible widget (or first when the
+  # +SPLITTER_REVERSED+ option has been passed to the splitter).
+  # In a vertically-oriented splitter, children with +LAYOUT_FILL_Y+ and 
+  # +LAYOUT_FIX_HEIGHT+ behave analogously.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXSplitter 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_COMMAND+::		sent at the end of a resize operation, to signal that the resize is complete
+  # +SEL_CHANGED+::		sent continuously while a resize operation is occurring
+  #
+  # === Splitter options
+  #
+  # +SPLITTER_HORIZONTAL+::   Split horizontally
+  # +SPLITTER_VERTICAL+::     Split vertically
+  # +SPLITTER_REVERSED+::     Reverse-anchored
+  # +SPLITTER_TRACKING+::     Track continuous during split
+  # +SPLITTER_NORMAL+::       same as +SPLITTER_HORIZONTAL+
+  #
+  class FXSplitter < FXComposite
+  
+    # Splitter style [Integer]
+    attr_accessor :splitterStyle
+    
+    # Splitter bar size, in pixels [Integer]
+    attr_accessor :barSize
+    
+    #
+    # Return an initialized FXSplitter instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this splitter [FXComposite]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    #
+    def initialize(p, opts=SPLITTER_NORMAL, x=0, y=0, w=0, h=0) # :yields: theSplitter
+    end
+
+    #
+    # Return an initialized FXSplitter instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this splitter [FXComposite]
+    # +tgt+::	the message target for this splitter [FXObject]
+    # +sel+::	the message identifier for this splitter [Integer]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    #
+    def initialize(p, tgt, sel, opts=SPLITTER_NORMAL, x=0, y=0, w=0, h=0) # :yields: theSplitter
+    end
+    
+    #
+    # Return size of the panel at index.
+    # Raises IndexError if _index_ is out of range.
+    #
+    def getSplit(index); end
+
+    #
+    # Change the size of panel at the given index.
+    # Raises IndexError if _index_ is out of range.
+    #
+    def setSplit(index, size); end
+  end
+end
+

data/rdoc-sources/FXSpring.rb

@@ -0,0 +1,61 @@
+module Fox
+  #
+  # The spring widgets, when properly embedded side by side in a horizontal
+  # frame or vertical frame widget, behave like a set of connected springs
+  # of various lengths.
+  #
+  # The third and fourth arguments to the FXSpring.new method (+relw+ and +relh+)
+  # determine the "length" of the spring. You can also change these settings after
+  # the widget is constructed using the FXSpring#relativeWidth and FXSpring#relativeHeight
+  # accessor methods.
+  # The actual length that you specify is not really
+  # important; the only thing that counts is the relative length of one
+  # spring widget to that of another, although the length does determine
+  # the default size. The special value zero may be given for +relw+ (or +relh+)
+  # to cause the spring to calculate its default width (height) normally,
+  # just like the FXPacker base class does.
+  #
+  # In a typical scenario, either the relative width or height is set to
+  # zero, an the flag <tt>LAYOUT_FILL_X</tt> or <tt>LAYOUT_FILL_Y</tt> is passed.
+  # When placed inside a horizontal frame, the <tt>LAYOUT_FILL_X</tt> together with
+  # the relative widths of the springs will cause a fixed width-ratio
+  # between the springs.
+  #
+  # You also can mix normal controls and springs together in a horizontal
+  # or vertical frames to provide arbitrary stretchable spacing between
+  # widgets; in this case, the springs do not need to have any children.
+  # Since the spring widget is derived from the FXPacker layout manager,
+  # it provides the same layout behavior as FXPacker.
+  #
+  class FXSpring < FXPacker
+    # Relative width [Integer]
+    attr_accessor :relativeWidth
+    
+    # Relative height [Integer]
+    attr_accessor :relativeHeight
+    
+    #
+    # Return an initialized FXSpring instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this spring [FXComposite]
+    # +relw+::	the relative width [Integer]
+    # +relh+::	the relative height [Integer]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +pl+::	left-side padding (in pixels) [Integer]
+    # +pr+::	right-side padding (in pixels) [Integer]
+    # +pt+::	top-side padding (in pixels) [Integer]
+    # +pb+::	bottom-side padding (in pixels) [Integer]
+    # +hs+::	horizontal spacing (in pixels) [Integer]
+    # +vs+::	vertical spacing (in pixels) [Integer]
+    #
+    def initialize(p, opts=0, relw=0, relh=0, x=0, y=0, w=0, h=0, pl=DEFAULT_SPACING, pr=DEFAULT_SPACING, pt=DEFAULT_SPACING, pb=DEFAULT_SPACING, hs=DEFAULT_SPACING, vs=DEFAULT_SPACING) # :yields: theSpring
+    end
+  end
+end
+

data/rdoc-sources/FXStatusBar.rb

@@ -0,0 +1,42 @@
+module Fox
+  #
+  # Status bar
+  #
+  # === Status bar options
+  #
+  # +STATUSBAR_WITH_DRAGCORNER+:: Causes the drag corner to be shown
+  #
+  class FXStatusBar < FXHorizontalFrame
+  
+    # The status line widget [FXStatusLine]
+    attr_reader :statusLine
+    
+    # The drag corner widget [FXDragCorner]
+    attr_reader :dragCorner
+    
+    # If +true+, the drag corner is shown [Boolean]
+    attr_accessor :cornerStyle
+  
+    #
+    # Return an initialized FXStatusBar instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this status bar [FXComposite]
+    # +opts+::	status bar 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]
+    # +hs+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vs+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, opts=0, x=0, y=0, w=0, h=0, pl=3, pr=3, pt=2, pb=2, hs=4, vs=0) # :yields: theStatusBar
+    end
+  end
+end
+