fxruby 1.6.13-mswin32

data/rdoc-sources/FXRealSlider.rb

@@ -0,0 +1,101 @@
+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_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 (a Float).
+  # +SEL_CHANGED+::
+  #   sent continuously while the slider is being moved; the message data is a Float 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]
+    # +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=REALSLIDER_NORMAL, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0) # :yields: theRealSlider
+    end
+
+    # Set slider range (where _lo_ and _hi_ are Float values).
+    def setRange(lo, hi, notify=false); 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,140 @@
+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_COMMAND+::
+  #   sent whenever the spinner's value changes; the message data is a Float
+  #   indicating the new spinner value.
+  # +SEL_CHANGED+::
+  #   sent whenever the text in the spinner's text field changes; the message
+  #   data is a Float 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
+    
+    # Spinner granularity [Float]
+    attr_accessor :granularity
+
+    #
+    # 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]
+    # +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=REALSPIN_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theRealSpinner
+    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/FXRecentFiles.rb

@@ -0,0 +1,77 @@
+module Fox
+  #
+  # The recent files object manages a most recently used file list by
+  # means of the standard system registry.
+  # When connected to a widget, like a menu command, the recent files object
+  # updates the menu commands label to the associated recent file name; when
+  # the menu command is invoked, the recent file object sends its target a
+  # +SEL_COMMAND+ message with the message data set to the associated file name
+  # (a String).
+  # When adding or removing file names, the recent files object automatically
+  # updates the system registry to record these changes.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXRecentFiles to its target:
+  #
+  # +SEL_COMMAND+::
+  #   sent when one of the recent files in this list is selected,
+  #   usually as a result of being selected from a menu command.
+  #   The message data is a String containing the name of the file.
+  #
+  # === Message identifiers
+  #
+  # <tt>ID_CLEAR</tt>::		Clear the list of files
+  # <tt>ID_ANYFILES</tt>::	x
+  # <tt>ID_FILE_1</tt>::	x
+  # <tt>ID_FILE_2</tt>::	x
+  # <tt>ID_FILE_3</tt>::	x
+  # <tt>ID_FILE_4</tt>::	x
+  # <tt>ID_FILE_5</tt>::	x
+  # <tt>ID_FILE_6</tt>::	x
+  # <tt>ID_FILE_7</tt>::	x
+  # <tt>ID_FILE_8</tt>::	x
+  # <tt>ID_FILE_9</tt>::	x
+  # <tt>ID_FILE_10</tt>::	x
+  #
+  class FXRecentFiles < FXObject
+    # Application associated with this recent files group [FXApp]
+    attr_reader :app
+
+    # Maximum number of files to track [Integer]
+    attr_accessor :maxFiles
+    
+    # Group name [String]
+    attr_accessor :groupName
+    
+    # Message target [FXObject]
+    attr_accessor :target
+    
+    # Message identifier [Integer]
+    attr_accessor :selector
+    
+    #
+    # Construct a new FXRecentFiles group, using the global application instance.
+    #
+    def initialize # :yields: theRecentFiles
+    end
+  
+    # Make new recent files group with default groupname
+    def initialize(a) # :yields: theRecentFiles
+    end
+    
+    # Make new recent files group with groupname gp
+    def initialize(a, gp, target=nil, selector=0) # :yields: theRecentFiles
+    end
+
+    # Append a file to the end of the list.
+    def appendFile(filename); end
+  
+    # Remove a file from the list.
+    def removeFile(filename); end
+  
+    # Clear the list of files.
+    def clear(); end
+  end
+end
+

data/rdoc-sources/FXRectangle.rb

@@ -0,0 +1,149 @@
+module Fox
+  #
+  # Rectangle
+  #
+  class FXRectangle
+
+    #
+    # Upper left corner's x-coordinate [Integer]
+    #
+    attr_accessor :x
+    
+    # Upper left corner's y-coordinate [Integer]
+    attr_accessor :y
+    
+    # Rectangle width [Integer]
+    attr_accessor :w
+    
+    # Rectangle height [Integer]
+    attr_accessor :h
+  
+    #
+    # Return an uninitialized FXRectangle instance.
+    #
+    def initialize; end
+    
+    #
+    # Return an initialized FXRectangle instance.
+    #
+    # ==== Parameters:
+    #
+    # +xx+::	upper left corner's initial x-coordinate [Integer]
+    # +yy+::	upper left corner's initial y-coordinate [Integer]
+    # +ww+::	initial width [Integer]
+    # +hh+::	initial height [Integer]
+    #
+    def initialize(xx, yy, ww, hh); end
+    
+    #
+    # Return an initialized FXRectangle instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	upper left corner's initial position [FXPoint]
+    # +s+::	initial size [FXSize]
+    #
+    def initialize(p, s); end
+
+    #
+    # Return an initialized FXRectangle instance.
+    #
+    # ==== Parameters:
+    #
+    # +topleft+::	upper left corner's initial position [FXPoint]
+    # +bottomright+::	bottom right corner's initial position [FXPoint]
+    #
+    def initialize(topleft, bottomright); end
+  
+    #
+    # Return true if _p_ (an FXPoint instance) is contained within this rectangle.
+    #
+    def contains?(p); end
+    
+    #
+    # Return true if the point at (_xx_, _yy_) is contained within this rectangle.
+    #
+    def contains?(xx, yy); end
+  
+    #
+    # Return true if _r_ (another FXRectangle instance) is properly contained within
+    # this rectangle.
+    #
+    def contains?(r); end
+  
+    #
+    # Shift each of the rectangle's corners by the amount _p_ (an FXPoint
+    # instance) and return a reference to the rectangle.
+    #
+    def move!(p); end
+    
+    #
+    # Shift each of the rectangle's corners by the amount (_dx_, _dy_)
+    # and return a reference to the rectangle.
+    #
+    def move!(dx, dy); end
+
+    #
+    # Grow the rectangle by some amount and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +margin+::	number of units to grow on each side [Integer]
+    #
+    def grow!(margin); end
+
+    #
+    # Grow the rectangle by some amount and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +hormargin+::	number of units to grow on the left and right sides [Integer]
+    # +vermargin+::	number of units to grow on the top and bottom sides [Integer]
+    #
+    def grow!(hormargin, vermargin); end
+
+    #
+    # Grow the rectangle by some amount and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +leftmargin+::	number of units to grow on the left side [Integer]
+    # +rightmargin+::	number of units to grow on the right side [Integer]
+    # +topmargin+::	number of units to grow on the top side [Integer]
+    # +bottommargin+::	number of units to grow on the bottom side [Integer]
+    #
+    def grow!(leftmargin, rightmargin, topmargin, bottommargin); end
+  
+    #
+    # Shrink the rectangle by _margin_ units, and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +margin+::	number of units to shrink on each side [Integer]
+    #
+    def shrink!(margin); end
+
+    #
+    # Shrink the rectangle by some amount, and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +hormargin+::	number of units to shrink on the left and right sides [Integer]
+    # +vermargin+::	number of units to shrink on the top and bottom sides [Integer]
+    #
+    def shrink!(hormargin, vermargin); end
+
+    #
+    # Shrink the rectangle by some amount, and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +leftmargin+::	number of units to shrink on the left side [Integer]
+    # +rightmargin+::	number of units to shrink on the right side [Integer]
+    # +topmargin+::	number of units to shrink on the top side [Integer]
+    # +bottommargin+::	number of units to shrink on the bottom side [Integer]
+    #
+    def shrink!(leftmargin, rightmargin, topmargin, bottommargin); end
+  end
+end
+