fxruby 1.6.13-mswin32

data/rdoc-sources/FXSlider.rb

@@ -0,0 +1,98 @@
+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 SLIDER_INSIDE_BAR option and the regular look.  The latter may have optional
+  # arrows on the slider thumb.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXSlider 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_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 (an Integer).
+  # +SEL_CHANGED+::
+  #   sent continuously while the slider is being moved; the message data is an integer indicating
+  #   the current slider position.
+  #
+  # === Slider control styles
+  #
+  # +SLIDER_HORIZONTAL+::	Slider shown horizontally
+  # +SLIDER_VERTICAL+::		Slider shown vertically
+  # +SLIDER_ARROW_UP+::		Slider has arrow head pointing up
+  # +SLIDER_ARROW_DOWN+::	Slider has arrow head pointing down
+  # +SLIDER_ARROW_LEFT+::	Slider has arrow head pointing left
+  # +SLIDER_ARROW_RIGHT+::	Slider has arrow head pointing right
+  # +SLIDER_INSIDE_BAR+::	Slider is inside the slot rather than overhanging
+  # +SLIDER_TICKS_TOP+::	Ticks on the top of horizontal slider
+  # +SLIDER_TICKS_BOTTOM+::	Ticks on the bottom of horizontal slider
+  # +SLIDER_TICKS_LEFT+::	Ticks on the left of vertical slider
+  # +SLIDER_TICKS_RIGHT+::	Ticks on the right of vertical slider
+  # +SLIDER_NORMAL+::		same as <tt>SLIDER_HORIZONTAL</tt>
+  #
+  # === Message identifiers
+  #
+  # +ID_AUTOINC+::	x
+  # +ID_AUTODEC+::	x
+  #
+  class FXSlider < FXFrame
+
+    # Slider value [Integer]
+    attr_accessor :value
+
+    # Slider range [Range]
+    attr_accessor :range
+
+    # 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 [Integer]
+    attr_accessor :increment
+    
+    # Delta between ticks [Integer]
+    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 FXSlider instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this slider [FXComposite]
+    # +target+::	the message target, if any, for this slider [FXObject]
+    # +selector+::	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]
+    # +width+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +height+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    # +padLeft+::	internal padding on the left side, in pixels [Integer]
+    # +padRight+::	internal padding on the right side, in pixels [Integer]
+    # +padTop+::	internal padding on the top side, in pixels [Integer]
+    # +padBottom+::	internal padding on the bottom side, in pixels [Integer]
+    #
+    def initialize(p, target=nil, selector=0, opts=SLIDER_NORMAL, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0) # :yields: theSlider
+    end
+  end
+end
+

data/rdoc-sources/FXSphered.rb

@@ -0,0 +1,80 @@
+module Fox
+  #
+  # Spherical bounds
+  #
+  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=0.0); end
+    
+    # Initialize from center (_x_, _y_, _z_) and radius (_rad_).
+    def initialize(x, y, z, rad=0.0); 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
+    
+    # Expand radius to include point and return a reference to self.
+    def includeInRadius!(x, y, z); end
+
+    # Expand radius to include point (an FXVec3d instance) and return a reference to self.
+    def includeInRadius!(p); end
+    
+    # Include the range _box_ (an FXRanged instance) into this sphere and return self.
+    def include!(box); end
+    
+    # Expand radius to include box (an FXRanged instance) and return a reference to self.
+    def includeInRadius!(box);
+
+    # 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
+    
+    # Expand radius to include sphere (an FXSphered instance) and return self.
+    def includeInRadius!(sphere); 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,80 @@
+module Fox
+  #
+  # Spherical bounds
+  #
+  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=0.0); end
+    
+    # Initialize from center (_x_, _y_, _z_) and radius (_rad_).
+    def initialize(x, y, z, rad=0.0); 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
+    
+    # Expand radius to include point and return a reference to self.
+    def includeInRadius!(x, y, z); end
+
+    # Expand radius to include point (an FXVec3f instance) and return a reference to self.
+    def includeInRadius!(p); end
+
+    # Include the range _box_ (an FXRangef instance) into this sphere and return self.
+    def include!(box); end
+    
+    # Expand radius to include box (an FXRangef instance) and return a reference to self.
+    def includeInRadius!(box);
+
+    # Include the sphere _sphere_ (an FXSpheref instance) into this sphere and return self.
+    def include!(sphere); end
+    
+    # Expand radius to include sphere (an FXSpheref instance) and return self.
+    def includeInRadius!(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,136 @@
+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_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]
+    # +target+::	the message target, if any, for this spinner [FXObject]
+    # +selector+::	the message identifier for this spinner [Integer]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +width+::	initial width [Integer]
+    # +height+::	initial height [Integer]
+    # +padLeft+::	internal padding on the left side, in pixels [Integer]
+    # +padRight+::	internal padding on the right side, in pixels [Integer]
+    # +padTop+::	internal padding on the top side, in pixels [Integer]
+    # +padBottom+::	internal padding on the bottom side, in pixels [Integer]
+    #
+    def initialize(p, cols, target=nil, selector=0, opts=SPIN_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theSpinner
+    end
+  
+    # Increment spinner
+    def increment(notify=FALSE); end
+    
+    # Increment spinner by certain amount
+    def incrementByAmount(amt, notify=false); end
+  
+    # Decrement spinner
+    def decrement(notify=FALSE); end
+    
+    # Decrement spinner by certain amount
+    def decrementByAmount(amt, notify=false); 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/FXSplashWindow.rb

@@ -0,0 +1,27 @@
+module Fox
+  #
+  # The Splash Window is a window typically shown during startup
+  # of an application.  It comprises a large icon, which is also
+  # used as the shape of the window if +SPLASH_SHAPED+ is passed;
+  # with the +SPLASH_SIMPLE+ option the window will be simply rectangular.
+  #
+  # === Splash window options
+  #
+  # +SPLASH_SIMPLE+::		Simple rectangular splash window
+  # +SPLASH_SHAPED+::		Shaped splash window
+  # +SPLASH_OWNS_ICON+::	Splash window will own the icon and destroy it
+  # +SPLASH_DESTROY+::		Splash window will destroy itself when timer expires
+  #
+  class FXSplashWindow < FXTopWindow
+    # The splash window's icon [FXIcon]
+    attr_accessor :icon
+    
+    # The delay before hiding the splash window, in milliseconds [Integer]
+    attr_accessor :delay
+
+    # Construct splash window
+    def initialize(owner, icon, opts=SPLASH_SIMPLE, ms=5000) # :yields: theSplashWindow
+    end
+  end
+end
+

data/rdoc-sources/FXSplitter.rb

@@ -0,0 +1,89 @@
+module Fox
+  #
+  # A splitter window is used to interactively repartition
+  # two or more subpanels.
+  # Space may be subdivided horizontally (+SPLITTER_HORIZONTAL+, which
+  # the default) or vertically (+SPLITTER_VERTICAL+ option).
+  # 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]
+    # +width+::	initial width [Integer]
+    # +height+::	initial height [Integer]
+    #
+    def initialize(p, opts=SPLITTER_NORMAL, x=0, y=0, width=0, height=0) # :yields: theSplitter
+    end
+
+    #
+    # Return an initialized FXSplitter instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this splitter [FXComposite]
+    # +target+::	the message target for this splitter [FXObject]
+    # +selector+::	the message identifier for this splitter [Integer]
+    # +opts+::	the options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +width+::	initial width [Integer]
+    # +height+::	initial height [Integer]
+    #
+    def initialize(p, tgt, sel, opts=SPLITTER_NORMAL, x=0, y=0, width=0, height=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
+