fxruby 1.4.7 → 1.6.0

data/rdoc-sources/FXCheckButton.rb

@@ -47,5 +47,12 @@ module Fox
     # Construct new check button
     def initialize(parent, text, target=nil, selector=0, opts=CHECKBUTTON_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theCheckButton
     end
+    
+    #
+    # Set the check button state to one of +TRUE+, +FALSE+ or +MAYBE+.
+    # If _notify_ is +true+, send a +SEL_COMMAND+ message to the message target
+    # after the state has been updated.
+    #
+    def setCheck(state, notify=false); end
   end
 end

data/rdoc-sources/FXColorList.rb

@@ -0,0 +1,55 @@
+module Fox
+  # Color item
+  class FXColorItem < FXListItem
+    # Item color [FXColor]
+    attr_accessor :color
+    
+    # Return a new color item, initialized with the given text, color and
+    # user data.
+    def initialize(text, clr, data=nil) # :yields: theColorItem
+    end
+  end
+  
+  # Displays a list of colors
+  class FXColorList < FXList
+
+    #
+    # Return an initially empty list of colors.
+    #
+    def initialize(p, tgt=nil, sel=0, opts=LIST_BROWSESELECT, x=0, y=0, w=0, h=0) # :yields: theColorList
+    end
+
+    #
+    # Fill list by appending color items from array of strings and array of colors.
+    #
+    def fillItems(strings, colors=nil, ptr=nil, notify=false); end
+
+    #
+    # Insert item at index with given text, color, and user-data pointer
+    #
+    def insertItem(index, text, color=0, ptr=nil, notify=false); end
+
+    #
+    # Append new item with given text, color, and user-data pointer
+    #
+    def appendItem(text, color=0, ptr=nil, notify=false); end
+
+    #
+    # Prepend new item with given text, color, and user-data pointer
+    #
+    def prependItem(text, color=0, ptr=nil, notify=false); end
+
+    #
+    # Change item color for the item at _index_.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def setItemColor(index, color); end
+
+    #
+    # Return item color for the item at _index_.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def getItemColor(index); end
+  end
+end
+

data/rdoc-sources/FXColorRing.rb

@@ -0,0 +1,49 @@
+module Fox
+  #
+  # A Color Ring widget provides an intuitive way to specify a color.
+  # The outer ring of the widget is rotated to control the hue of the color
+  # being specified, while the inner triangle varies the color saturation
+  # and the brightness of the color.  The color saturation axis of the
+  # triangle goes from a fully saturated "pure" color to "pastel" color;
+  # the brightness goes from black to a bright color.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXColorRing to its target:
+  #
+  # +SEL_CHANGED+::		sent continuously while the user is dragging the spot around; the message data is a three-element array containing the hue, saturation and value values.
+  # +SEL_COMMAND+::		sent when the user releases the mouse button and "drops" the spot at its new location; the message data is a three-element array containing the hue, saturation and value values.
+  # +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.
+  #
+  class FXColorRing < FXFrame
+  
+    # Hue [Float]
+    attr_accessor :hue
+    
+    # Saturation [Float]
+    attr_accessor :sat
+    
+    # Value [Float]
+    attr_accessor :val
+    
+    # Width of hue ring in pixels [Integer]
+    attr_accessor :ringWidth
+    
+    # Status line help text [String]
+    attr_accessor :helpText
+    
+    # Tool tip message [String]
+    attr_accessor :tipText
+    
+    #
+    # Return an initialized FXColorRing instance.
+    #
+    def initialize(p, tgt=nil, sel=0, opts=FRAME_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theColorRing
+    end
+    
+    # Set the hue, saturation and value (all floating point values)
+    def setHueSatVal(h, s, v); end
+  end
+end
+

data/rdoc-sources/FXColorWheel.rb

@@ -12,7 +12,7 @@ module Fox
   # +SEL_COMMAND+::		sent when the new color is set; the message data is a 3-element array of floats containing the hue, saturation and value.
   # +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.
-
+  #
   class FXColorWheel < FXFrame
 
     # Hue [Float]
@@ -30,8 +30,28 @@ module Fox
     # Tool tip message [String]  
     attr_accessor :tipText
 
+    #
     # Construct color wheel
-    def initialize(parent, target=nil, selector=0, opts=FRAME_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theColorWheel
+    #
+    # ==== Parameters:
+    #
+    # +p+::	Parent widget [FXComposite]
+    # +tgt+::	Message target object [FXObject]
+    # +sel+::	Message identifier [Integer]
+    # +opts+::	Options [Integer]
+    # +x+::
+    # +y+::
+    # +w+::
+    # +h+::
+    # +pl+::
+    # +pr+::
+    # +pt+::
+    # +pb+::
+    #
+    def initialize(p, tgt=nil, sel=0, opts=FRAME_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theColorWheel
     end
+
+    # Set hue, saturation and value all in one shot.
+    def setHueSatVal(h, s, v); end
   end
 end

data/rdoc-sources/FXComboBox.rb

@@ -48,6 +48,9 @@ module Fox
     # Number of columns [Integer]
     attr_accessor :numColumns
     
+    # Text justification mode; default is +JUSTIFY_LEFT+ [Integer]
+    attr_accessor :justify
+    
     # Number of items in the list [Integer]
     attr_reader	:numItems
     
@@ -197,5 +200,12 @@ module Fox
 
     # Sort items using current sort function
     def sortItems() ; end
+    
+    #
+    # Set current item to _index_, where _index_ is the zero-based index of
+    # the item. If _notify_ is +true+, a +SEL_COMMAND+ message is sent
+    # to the combo box's message target.
+    #
+    def setCurrentItem(index, notify=false); end
   end
 end

data/rdoc-sources/FXDC.rb

@@ -540,6 +540,24 @@ module Fox
     #
     def drawArea(source, sx, sy, sw, sh, dx, dy) ; end
   
+    #
+    # Copy some rectangular area from _source_ into the drawable attached to this
+    # device context, stretching it to width _dw_ and height _dh_.
+    #
+    # === Parameters:
+    #
+    # +source+::	the source drawable from which to copy [FXDrawable]
+    # +sx+::		x-coordinate of the upper left corner of the source rectangle [Integer]
+    # +sy+::		y-coordinate of the upper left corner of the source rectangle [Integer]
+    # +sw+::		width of the source rectangle, in pixels [Integer]
+    # +sh+::		height of the source rectangle, in pixels [Integer]
+    # +dx+::		x-coordinate of the the destination point in this drawable [Integer]
+    # +dy+::		y-coordinate of the the destination point in this drawable [Integer]
+    # +dw+::		destination width, in pixels [Integer]
+    # +dh+::		destination height, in pixels [Integer]
+    #
+    def drawArea(source, sx, sy, sw, sh, dx, dy, dw, dh) ; end
+
     #
     # Draw _image_ into the drawable attached to this device context.
     #

data/rdoc-sources/FXDial.rb

@@ -13,6 +13,8 @@ module Fox
   #
   # The following messages are sent by FXDial 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_CHANGED+::             sent when the dial's value changes; the message data is the new value (an integer).
@@ -37,7 +39,8 @@ module Fox
     #
     # The revolution increment is the amount of change in the position
     # for revolution of the dial; the dial may go through multiple revolutions
-    # to go through its whole range. [Integer]
+    # to go through its whole range. By default it takes one 360 degree turn of
+    # the dial to go from the lower to the upper range. [Integer]
     #
     attr_accessor :revolutionIncrement
 
@@ -66,9 +69,39 @@ module Fox
     # Tool tip message for this dial
     attr_accessor :tipText
 
+    #
     # Construct a dial widget
+    #
+    # ==== Parameters:
+    #
+    # +p+::	parent widget for this dial [FXComposite]
+    # +tgt+::	message target object for this dial [FXObject]
+    # +sel+::	message identifier [Integer]
+    # +opts+::
+    # +x+::
+    # +y+::
+    # +w+::
+    # +h+::
+    # +pl+::
+    # +pr+::
+    # +pt+::
+    # +pb+::
+    #
     def initialize(p, tgt=nil, sel=0, opts=DIAL_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theDial
     end
+    
+    #
+    # Set the dial value. If _notify_ is +true+, a +SEL_COMMAND+ message is
+    # sent to the dial's message target after the value is changed.
+    #
+    def setValue(value, notify=false); end
+    
+    #
+    # Set the dial's range. If _notify_ is +true+, and the range modification
+    # causes the dial's value to change, a +SEL_COMMAND+ message is sent
+    # to the dial's message target after the value is changed.
+    #
+    def setRange(range, notify=false); end
   end
 end
 

data/rdoc-sources/FXDirList.rb

@@ -45,6 +45,7 @@ module Fox
   # determines the icons to be displayed by consulting the file-associations registry
   # settings.  A number of messages can be sent to the FXDirList to control the
   # filter pattern, sorting order, case sensitivity, and hidden file display mode.
+  # The Directory list widget supports drags and drops of files.
   #
   # === Events
   #

data/rdoc-sources/FXDockBar.rb

@@ -2,7 +2,17 @@ module Fox
   #
   # A dock bar widget can be docked inside a dock site widget, or floated
   # around freely.  Users can move, undock, and dock the dock bar widget
-  # by means of a handle such as a tool bar grip.
+  # by means of a handle such as a tool bar grip.  When docking, the dock
+  # bar sends a +SEL_DOCKED+ message to its target; when undocking, it sends
+  # a +SEL_FLOATED+ message. In either case the dock site involved is passed
+  # as the message data.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXDockBar to its target:
+  #
+  # +SEL_DOCKED+::		sent when the dock bar is docked; the message data is a reference to the new dock site (an FXDockSite instance).
+  # +SEL_FLOATED+::		sent when the dock bar is undocked; the message data is a reference to the previous dock site.
   #
   # === Dock Bar Options
   #
@@ -73,6 +83,11 @@ module Fox
     # Return +true+ if docked
     def docked? ; end
 
+    #
+    # Return +true+ if the dock bar would dock or undock if at locaton (_barx_, _bary_).
+    #
+    def insideDock?(docksite, barx, bary); end
+
     #
     # Set parent when docked.
     # If it was docked, reparent under the new docking window.
@@ -106,24 +121,24 @@ module Fox
     # However, if after is -1, it will be docked as the innermost bar just before
     # the work-area, while if after is 0, if will be docked as the outermost bar.
     #
-    def dock(docksite, before=nil); end
+    def dock(docksite, before=nil, notify=false); end
 
     #
     # Dock the bar against the given side, near the given position relative
     # to the toolbar dock's origin.
     #
-    def dock(docksite, local_x, local_y); end
+    def dock(docksite, local_x, local_y, notify); end
 
     #
     # Undock or float the bar.
     # The initial position of the wet dock is a few pixels
     # below and to the right of the original docked position.
     #
-    def undock(root_x, root_y); end
+    def undock(root_x, root_y, notify=false); end
 
     #
-    # Change set of sides where docking is allowed.
-    # The default is to allow docking on all sides.
+    # Change set of sides (a combination of +ALLOW_TOP+, +ALLOW_LEFT+, etc.), 
+    # where docking is allowed. The default is to allow docking on all sides.
     #
     def allowedSides=(allowed); end
 

data/rdoc-sources/FXDockHandler.rb

@@ -3,6 +3,13 @@ module Fox
   # The dock handler exists as a common base class for tool bar grip
   # and dock title.  
   #
+  # === Events
+  #
+  # The following messages are sent by FXDockHandler 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.
+  #
   class FXDockHandler < FXFrame
     # Status line help text [String]
     attr_accessor :helpText

data/rdoc-sources/FXDockSite.rb

@@ -21,6 +21,11 @@ module Fox
   # a top level window using +LAYOUT_SIDE_TOP+ or +LAYOUT_SIDE_BOTTOM+, and
   # vertically oriented if placed with +LAYOUT_SIDE_LEFT+ or +LAYOUT_SIDE_RIGHT+.
   #
+  # === Dock Site Options
+  #
+  # +DOCKSITE_WRAP+::		Dockbars are wrapped to another galley when not enough space on current galley
+  # +DOCKSITE_NO_WRAP+::	Never wrap dockbars to another galley even if not enough space
+  #
   class FXDockSite < FXPacker
     #
     # Construct a toolbar dock layout manager. Passing +LAYOUT_SIDE_TOP+ or +LAYOUT_SIDE_BOTTOM+
@@ -81,6 +86,19 @@ module Fox
     # +bar+::	a reference to the removed dockbar [FXDockBar]
     #
     def undockToolBar(bar); end
+    
+    #
+    # If _wrap_ is +true+, allow the wrapping of dockbars (i.e. set the
+    # +DOCKSITE_WRAP+ option.)
+    #
+    def wrapGalleys=(wrap); end
+    
+    #
+    # Return +true+ if the +DOCKSITE_WRAP+ option is set, indicating that
+    # dockbars will be wrapped to another galley if there's not enough space on
+    # current galley.
+    #
+    def wrapGalleys?; end
   end
 end
 

data/rdoc-sources/FXExtentd.rb

@@ -0,0 +1,85 @@
+module Fox
+  class FXExtentd
+    # Lower corner of this extent (an FXVec2d instance).
+    attr_reader :lower
+    
+    # Upper corner of this extent (an FXVec2d instance).
+    attr_reader :upper
+    
+    # Default constructor
+    def initialize; end
+
+    # Copy constructor
+    def initialize(ext); end
+
+    # Initialize from two vectors (where _lo_ and _hi_ are two
+    # FXVec2d instances).
+    def initialize(lo, hi); end
+
+    # Initialize from four numbers
+    def initialize(xlo, xhi, ylo, yhi); end
+
+    # Indexing with 0..1 (returns an FXVec2d instance).
+    def [](i); end
+
+    # Return width of box
+    def width; end
+
+    # Return height of box
+    def height; end
+
+    # Return length of longest side
+    def longest; end
+
+    # Return length of shortest side
+    def shortest; end
+
+    # Return length of diagonal
+    def diameter; end
+
+    # Return radius of box
+    def radius; end
+
+    # Compute diagonal vector (returns an FXVec2d)
+    def diagonal; end
+
+    # Return center of box (as an FXVec2d)
+    def center; end
+
+    # Return +true+ if empty
+    def empty?; end
+
+    # Return +true+ if box contains point (_x_, _y_)
+    def contains?(x, y); end
+
+    # Return +true+ if box contains point _p_ (an FXVec2d instance)
+    def contains?(p); end
+
+    # Return +true+ if box properly contains another box (where _ext_ is
+    # another FXExtentd instance).
+    def contains?(ext); end
+
+    # Include point (_x_, _y_) and return a reference to self.
+    def include!(x, y); end
+
+    # Include point _v_ (an FXVec2d instance) and return a reference to self.
+    def include!(v); end
+
+    # Include given range into extent (where _ext_ is another FXExtentd instance)
+    # and return a reference to self.
+    def include!(ext); end
+
+    # Return +true+ if this extent's bounds overlap with _other_ extent's bounds.
+    def overlap?(other); end
+
+    # Return corner number 0, 1, 2 or 3 (as a FXVec2d instance).
+    def corner(c); end
+
+    # Return a new FXExtentd that is the union of this extent and _other_.
+    def unite_with(other); end
+
+    # Return a new FXExtentd that is the intersection of this extent and _other_.
+    def intersect_with(other); end
+  end
+end
+