fxruby 1.4.7 → 1.6.0

data/rdoc-sources/FXMenuCommand.rb

@@ -3,13 +3,12 @@ module Fox
   # The FXMenuCommand widget is used to invoke a command in the
   # application from a menu.  Menu commands may reflect
   # the state of the application by graying out or becoming hidden.
+  # When activated, a menu command sends a +SEL_COMMAND+ to its target.
   #
   # === Events
   #
   # The following messages are sent by FXMenuCommand 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 when the command is activated
   #
   class FXMenuCommand < FXMenuCaption

data/rdoc-sources/FXMenuRadio.rb

@@ -3,13 +3,16 @@ module Fox
   # The FXMenuRadio widget is used to change a state in the application from a menu.
   # Menu radio commands may reflect the state of the application by graying out, becoming
   # hidden, or by displaying a bullet.
+  # When activated, a menu radio sends a +SEL_COMMAND+ to its target;
+  # the message data contains the new state.
+  # A collection of menu radio widgets which belong to each other
+  # is supposed to be updated by a common +SEL_UPDATE+ handler to
+  # properly maintain the state between them.
   #
   # === Events
   #
   # The following messages are sent by FXMenuRadio 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 when the command is activated
   #
   class FXMenuRadio < FXMenuCommand

data/rdoc-sources/FXOptionMenu.rb

@@ -13,6 +13,12 @@ module Fox
   # +SEL_COMMAND+::		sent when this option is clicked; the message data is an FXEvent instance.
   #
   class FXOption < FXLabel
+    # Selection background color [FXColor]
+    attr_accessor :selBackColor
+    
+    # Selection text color [FXColor]
+    attr_accessor :selTextColor
+
     #
     # Returns an initialized FXOption instance.
     #
@@ -31,6 +37,7 @@ module Fox
   # +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 when this an option is selected; the message data is the option number.
   #
   class FXOptionMenu < FXLabel
   

data/rdoc-sources/FXPCXIcon.rb

@@ -7,6 +7,11 @@ module Fox
     # Return the suggested file extension for this image type ("pcx").
     #
     def FXPCXIcon.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPCXIcon.mimeType; end
 
     #
     # Return an initialized FXPCXIcon instance.

data/rdoc-sources/FXPCXImage.rb

@@ -7,6 +7,11 @@ module Fox
     # Return the suggested file extension for this image type ("pcx").
     #
     def FXPCXImage.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPCXImage.mimeType; end
 
     #
     # Return an initialized FXPCXImage instance.

data/rdoc-sources/FXPNGIcon.rb

@@ -7,6 +7,11 @@ module Fox
     # Return the suggested file extension for this image type ("png").
     #
     def FXPNGIcon.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPNGIcon.mimeType; end
 
     # Return +true+ if PNG image file format is supported.
     def FXPNGIcon.supported? ; end

data/rdoc-sources/FXPNGImage.rb

@@ -7,6 +7,11 @@ module Fox
     # Return the suggested file extension for this image type ("png").
     #
     def FXPNGImage.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPNGImage.mimeType; end
 
     # Return +true+ if PNG image file format is supported.
     def FXPNGImage.supported? ; end

data/rdoc-sources/FXPPMIcon.rb

@@ -7,6 +7,11 @@ module Fox
     # Return the suggested file extension for this image type ("ppm").
     #
     def FXPPMIcon.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPPMIcon.mimeType; end
 
     #
     # Return an initialized FXPPMIcon instance.

data/rdoc-sources/FXPPMImage.rb

@@ -7,6 +7,11 @@ module Fox
     # Return the suggested file extension for this image type ("ppm").
     #
     def FXPPMImage.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXPNGImage.mimeType; end
 
     #
     # Return an initialized FXPPMImage instance.

data/rdoc-sources/FXQuatd.rb

@@ -43,11 +43,6 @@ module Fox
     # instances.
     def initialize(ex, ey, ez); end
 
-    #
-    # Construct quaternion from 3x3 matrix; _mat_ is an FXMat3d instance.
-    #
-    def FXQuatd.fromMatrix(mat); end
-
     # Adjust quaternion length; returns a reference to self.
     def adjust!; end
     
@@ -145,17 +140,18 @@ module Fox
     def *(vec); end
     
     #
-    # Construct a quaternion from arc a->b on unit sphere.
+    # Construct a quaternion from arc a->b on unit sphere and return a reference
+    # to self.
     #
     # ==== Parameters:
     #
     # +a+::	[FXVec3d]
     # +b+::	[FXVec3d]
     #
-    def FXQuatd.arc(a, b); end
+    def arc!(a, b); end
     
     #
-    # Spherical lerp.
+    # Spherical lerp and return a reference to self.
     #
     # ==== Parameters:
     #
@@ -163,9 +159,6 @@ module Fox
     # +v+::	[FXQuatd]
     # +f+:: [Float]
     #
-    def FXQuatd.lerp(u, v, f); end
-    
-    # Convert to matrix (returns an FXMat3d instance).
-    def toMatrix; end
+    def lerp!(u, v, f); end
   end
 end

data/rdoc-sources/FXQuatf.rb

@@ -149,17 +149,18 @@ module Fox
     def *(vec); end
     
     #
-    # Construct a quaternion from arc a->b on unit sphere.
+    # Construct a quaternion from arc a->b on unit sphere and
+    # return reference to self.
     #
     # ==== Parameters:
     #
     # +a+::	[FXVec3f]
     # +b+::	[FXVec3f]
     #
-    def FXQuatf.arc(a, b); end
+    def arc!(a, b); end
     
     #
-    # Spherical lerp.
+    # Spherical lerp, return reference to self.
     #
     # ==== Parameters:
     #
@@ -167,9 +168,6 @@ module Fox
     # +v+::	[FXQuatf]
     # +f+:: 	[Float]
     #
-    def FXQuatf.lerp(u, v, f); end
-    
-    # Convert to a 3x3 matrix; returns an FXMat3f instance.
-    def toMatrix; end
+    def lerp!(u, v, f); end
   end
 end

data/rdoc-sources/FXRGBIcon.rb

@@ -7,6 +7,11 @@ module Fox
     # Return the suggested file extension for this image type ("rgb").
     #
     def FXRGBIcon.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXRGBIcon.mimeType; end
 
     #
     # Return an initialized FXRGBIcon instance.

data/rdoc-sources/FXRGBImage.rb

@@ -7,6 +7,11 @@ module Fox
     # Return the suggested file extension for this image type ("rgb").
     #
     def FXRGBImage.fileExt; end
+    
+    #
+    # Return the MIME type for this image type
+    #
+    def FXRGBImage.mimeType; end
 
     #
     # Return an initialized FXRGBImage instance.

data/rdoc-sources/FXRadioButton.rb

@@ -3,6 +3,12 @@ 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.
+  # When pressed, the radio button sets its state to +TRUE+ and sends a +SEL_COMMAND+
+  # message to its target, with the message data set to the state of the radio button.
+  # A group of radio buttons can be made mutually exclusive by linking them
+  # to a common data target (i.e. an instance of FXDataTarget).
+  # Alternatively, an application can implement a common +SEL_UPDATE+ handler to
+  # check and uncheck radio buttons as appropriate.
   #
   # === Events
   #

data/rdoc-sources/FXRanged.rb

@@ -37,6 +37,9 @@ module Fox
     # Return the length of the diagonal of the box
     def diameter; end
 
+    # Return the radius of the box
+    def radius; end
+
     # Return the diagonal vector for the box (an FXVec3d instance).
     def diagonal; end
 

data/rdoc-sources/FXRangef.rb

@@ -37,6 +37,9 @@ module Fox
     # Return the length of the diagonal of the box
     def diameter; end
 
+    # Return the radius of the box.
+    def radius; end
+
     # Return the diagonal vector for the box (an FXVec3f instance).
     def diagonal; end
 

data/rdoc-sources/FXRealSlider.rb

@@ -9,6 +9,8 @@ module Fox
   #
   # 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.
@@ -90,7 +92,7 @@ module Fox
     end
 
     # Set slider range (where _lo_ and _hi_ are Float values).
-    def setRange(lo, hi); end
+    def setRange(lo, hi, notify=false); end
 
     # Return the slider range as an array of Float values [lo, hi].
     def getRange(); end

data/rdoc-sources/FXRealSpinner.rb

@@ -8,8 +8,6 @@ module Fox
   #
   # +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 a Float
   #   indicating the new spinner value.
@@ -71,6 +69,9 @@ module Fox
 
     # 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.
@@ -95,11 +96,17 @@ module Fox
     end
   
     # Increment spinner
-    def increment(); end
+    def increment(notify=false); end
   
+    # Increment spinner by certain amount
+    def incrementByAmount(amt, notify=false); end
+
     # Decrement spinner
-    def decrement(); end
+    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
   

data/rdoc-sources/FXRecentFiles.rb

@@ -35,6 +35,9 @@ module Fox
   # <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
     
@@ -48,16 +51,17 @@ module Fox
     attr_accessor :selector
     
     #
-    # Construct a new FXRecentFiles object with the default group name.
+    # Construct a new FXRecentFiles group, using the global application instance.
     #
     def initialize # :yields: theRecentFiles
     end
   
-    #
-    # Construct a new FXRecentFiles object with the specified
-    # group name, target and message identifier.
-    #
-    def initialize(group, tgt=nil, sel=0) # :yields: theRecentFiles
+    # 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, tgt=nil, sel=0) # :yields: theRecentFiles
     end
 
     # Append a file to the end of the list.

data/rdoc-sources/FXRectangle.rb

@@ -71,6 +71,18 @@ module Fox
     #
     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.
     #

data/rdoc-sources/FXRuler.rb

@@ -5,6 +5,13 @@ module Fox
   # indents, and tickmarks.
   # The ruler widget sends a +SEL_CHANGED+ message when the indentation or margins
   # are interactively changed by the user.
+  # If the document size exceeds the available space, it is possible to
+  # scroll the document using setPosition().  When the document size is
+  # less than the available space, the alignment options can be used to
+  # center, left-adjust, or right-adjust the document.
+  # Finally, a special option exists to stretch the document to the
+  # available space, that is to say, the document will always be fitten
+  # with given left and right edges substracted from the available space.
   #
   # === Events
   #
@@ -12,6 +19,7 @@ module Fox
   #
   # +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 whenever something about the ruler changes
   #
   # === Ruler options
   #
@@ -29,6 +37,14 @@ module Fox
   # +RULER_MARKERS+::		Draw markers for indentation settings
   # +RULER_METRIC+::		Metric subdivision (default)
   # +RULER_ENGLISH+::		English subdivision
+  # +RULER_MARGIN_ADJUST+::	Allow margin adjustment
+  # +RULER_ALIGN_CENTER+::	Center document horizontally
+  # +RULER_ALIGN_LEFT+::	Align document to the left
+  # +RULER_ALIGN_RIGHT+::	Align document to the right
+  # +RULER_ALIGN_TOP+::		Align document to the top
+  # +RULER_ALIGN_BOTTOM+::	Align document to the bottom
+  # +RULER_ALIGN_STRETCH+::	Stretch document to fit horizontally
+  # +RULER_ALIGN_NORMAL+::	Normally, document is centered both ways
   #
   # === Message identifiers:
   #
@@ -39,6 +55,9 @@ module Fox
     # Current position [Integer]
     attr_accessor :position
     
+    # Content size [Integer]
+    attr_accessor :contentSize
+    
     # Document size [Integer]
     attr_accessor :documentSize
   
@@ -84,6 +103,9 @@ module Fox
     # The ruler style [Integer]
     attr_accessor :rulerStyle
     
+    # Ruler alignment [Integer]
+    attr_accessor :rulerAlignment
+
     # The current text color [FXColor]
     attr_accessor :textColor
     
@@ -98,5 +120,11 @@ module Fox
     #
     def initialize(p, tgt=nil, sel=0, opts=RULER_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theRuler
     end
+    
+    # Return lower edge of document (an integer)
+    def documentLower; end
+    
+    # Return upper edge of document (an integer)
+    def documentUpper; end
   end
 end