fxruby 1.4.7 → 1.6.0

data/rdoc-sources/FXGIFIcon.rb

@@ -8,6 +8,11 @@ module Fox
     #
     def FXGIFIcon.fileExt; end
 
+    #
+    # Return the suggested MIME type for this image type
+    #
+    def FXGIFIcon.mimeType; end
+
     #
     # Return an initialized FXGIFIcon instance.
     #

data/rdoc-sources/FXGIFImage.rb

@@ -6,6 +6,11 @@ module Fox
     #
     def FXGIFImage.fileExt; end
 
+    #
+    # Return the suggested MIME type for this image type.
+    #
+    def FXGIFImage.mimeType; end
+
     #
     # Return an initialized FXGIFImage instance.
     #

data/rdoc-sources/FXGLViewer.rb

@@ -93,6 +93,29 @@ module Fox
   #
   # The following messages are sent by FXGLViewer to its message 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_RIGHTBUTTONPRESS+::	sent when the right mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONRELEASE+::	sent when the right mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_MOTION+::		sent when the mouse pointer is moved; the message data is an FXEvent instance.
+  # +SEL_MOUSEWHEEL+::		sent when the mouse wheel is spun; the message data is an FXEvent instance.
+  # +SEL_CLICKED+::		sent when the mouse is single-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_DOUBLECLICKED+::	sent when the mouse is double-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_TRIPLECLICKED+::	sent when the mouse is triple-clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_PICKED+::		sent when an object is picked; the message data is an FXEvent instance.
+  # +SEL_SELECTED+::		sent when object(s) are selected in the viewer; the message data is an array of references to the selected objects.
+  # +SEL_DESELECTED+::		sent when object(s) are deselected in the viewer; the message data is an array of references to the deselected objects.
+  # +SEL_LASSOED+::		sent when a lasso-selection has been completed; the message data is an FXEvent instance.
+  # +SEL_INSERTED+::		sent when the viewer receives a +SEL_INSERTED+ message.
+  # +SEL_DELETED+::		sent when the viewer receives a +SEL_COMMAND+ message with the +ID_DELETE_SEL+ identifier; the message data is an array of references to the selected object(s).
+  # +SEL_DRAGGED+::		sent when the selected object is dragged around in the viewer; the message data is a reference to the selected object.
+  # +SEL_COMMAND+::		sent when the mouse is clicked somewhere in the widget; the message data is a reference to the clicked object (possibly +nil+)
+  # +SEL_CHANGED+::		sent when the selection changes; the message data is a reference to the newly selected object (or +nil+).
+  # 
   # === FXGLViewer options
   #
   # +VIEWER_LIGHTING+::	Lighting is on

data/rdoc-sources/FXGradientBar.rb

@@ -30,6 +30,16 @@ module Fox
   # The FXGradientBar is a control that is used to edit color gradient,
   # such as used in texture mapping and shape filling.
   #
+  # === Events
+  #
+  # The following messages are sent by FXGradientBar 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_CHANGED+::		sent when anything about a segment changes; the message data is an integer indicating the segment number
+  # +SEL_SELECTED+::		sent when one or more segments are selected.
+  # +SEL_DESELECTED+::		sent when one or more segments are deselected.
+  #
   # === Gradient bar orientation
   #
   # +GRADIENTBAR_HORIZONTAL+::		Gradient bar shown horizontally

data/rdoc-sources/FXHeader.rb

@@ -110,6 +110,9 @@ module Fox
   # +SEL_COMMAND+::
   #   sent when a header item is clicked; the message data is an integer
   #   indicating the index of the current item.
+  # +SEL_CLICKED+::
+  #   sent when a header item is clicked; the message data is an integer
+  #   indicating the index of the current item.
   # +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_REPLACED+::		sent when a header item is about to be replaced; the message data is an Integer indicating the index of the item to be replaced.
@@ -250,6 +253,14 @@ module Fox
     #
     def prependItem(text, icon=nil, size=0, data=nil, notify=false); end
   
+    #
+    # Extract item from list and return a reference to the item.
+    # If _notify_ is  +true+, a +SEL_DELETED+ message is sent to the header's
+    # message target before the item is extracted from the list.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def extractItem(index, notify=false); end
+    
     #
     # Remove the item at the specified index from this header.
     # If _notify_ is  +true+, a +SEL_DELETED+ message is sent to the header's message target

data/rdoc-sources/FXICOIcon.rb

@@ -8,6 +8,11 @@ module Fox
     #
     def FXICOIcon.fileExt; end
 
+    #
+    # Return the MIME type for this image type
+    #
+    def FXICOIcon.mimeType; end
+
     #
     # Return an initialized FXICOIcon instance.
     #

data/rdoc-sources/FXICOImage.rb

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

data/rdoc-sources/FXIconList.rb

@@ -284,6 +284,14 @@ module Fox
     #
     def moveItem(newIndex, oldIndex, notify=false); end
 
+    #
+    # Extract item from list and return a reference to the item.
+    # If _notify_ is  +true+, a +SEL_DELETED+ message is sent to the list's
+    # message target before the item is extracted from the list.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def extractItem(index, notify=false); end
+
     # Remove item at _index_ from the list.
     # If _notify_ is  +true+, a +SEL_DELETED+ message is sent to the list's message target
     # before the item is removed.

data/rdoc-sources/FXIconSource.rb

@@ -27,7 +27,7 @@ module Fox
     # icon.
     # Returns a reference to the icon.
     #
-    def loadIcon(filename, type=nil); end
+    def loadIconFile(filename, type=nil); end
 
     #
     # Load an icon of a given type (e.g. "gif") from reswrapped data.
@@ -37,7 +37,7 @@ module Fox
     # to divine the icon format if the parameter is omitted).
     # Returns a reference to the icon.
     #
-    def loadIcon(pixels, type=nil); end
+    def loadIconData(pixels, type=nil); end
 
     #
     # Load an icon of a given type (e.g. "gif") from an already open stream.
@@ -47,7 +47,7 @@ module Fox
     # to divine the icon format if the parameter is omitted).
     # Returns a reference to the icon.
     #
-    def loadIcon(store, type=nil); end
+    def loadIconStream(store, type=nil); end
 
     #
     # Load an image from the file filename. By default, the file extension is
@@ -57,7 +57,7 @@ module Fox
     # file, since the filename does not give any clue as to the type of the
     # image.
     #
-    def loadImage(filename, type=nil); end
+    def loadImageFile(filename, type=nil); end
 
     #
     # Load an image of a given type (e.g. "gif") from reswrapped data.
@@ -66,7 +66,7 @@ module Fox
     # versions will attempt to inspect the first few bytes of the stream
     # to divine the icon format if the parameter is omitted).
     #
-    def loadImage(pixels, type=nil); end
+    def loadImageData(pixels, type=nil); end
   
     #
     # Load an image of a given type (e.g. "gif") from an already open stream.
@@ -75,25 +75,25 @@ module Fox
     # versions will attempt to inspect the first few bytes of the stream
     # to divine the image format if the parameter is omitted).
     #
-    def loadImage(store, type=nil); end
+    def loadImageStream(store, type=nil); end
 
     # Load icon and scale it such that its dimensions do not exceed given size
-    def loadScaledIcon(filename, size=32, qual=0, type=nil); end
+    def loadScaledIconFile(filename, size=32, qual=0, type=nil); end
 
     # Load icon and scale it such that its dimensions do not exceed given size
-    def loadScaledIcon(pixels, size=32, qual=0, type=nil); end
+    def loadScaledIconData(pixels, size=32, qual=0, type=nil); end
 
     # Load icon and scale it such that its dimensions do not exceed given size
-    def loadScaledIcon(store, size=32, qual=0, type=nil); end
+    def loadScaledIconStream(store, size=32, qual=0, type=nil); end
 
     # Load image and scale it such that its dimensions do not exceed given size
-    def loadScaledImage(filename, size=32, qual=0, type=nil); end
+    def loadScaledImageFile(filename, size=32, qual=0, type=nil); end
 
     # Load image and scale it such that its dimensions do not exceed given size
-    def loadScaledImage(pixels, size=32, qual=0, type=nil); end
+    def loadScaledImageData(pixels, size=32, qual=0, type=nil); end
 
     # Load image and scale it such that its dimensions do not exceed given size
-    def loadScaledImage(store, size=32, qual=0, type=nil); end
+    def loadScaledImageStream(store, size=32, qual=0, type=nil); end
   end
 end
 

data/rdoc-sources/FXImage.rb

@@ -67,8 +67,6 @@ module Fox
 
     #
     # Return the color of the pixel at (_x_, _y_).
-    # Raises RuntimeError if the client-side pixel buffer has already been
-    # released.
     #
     # ==== Parameters:
     #
@@ -79,8 +77,6 @@ module Fox
 
     #
     # Set pixel at (_x_, _y_) to _clr_.
-    # Raises RuntimeError if the client-side pixel buffer has already been
-    # released.
     #
     # ==== Parameters:
     #

data/rdoc-sources/FXInputDialog.rb

@@ -48,21 +48,34 @@ module Fox
     #
     def FXInputDialog.getString(initial, owner, caption, label, ic=nil); end
   
+    #
+    # Prompt for a string, in a free-floating window..
+    #
+    def FXInputDialog.getString(initial, app, caption, label, ic=nil); end
+  
     #
     # Prompt the user for an integer number, starting from the specified _initial_ value.
     # Return the input value if the user clicks *OK*, else return +nil+.
-    # The input is constrained between _lo_ and _hi_, unless _lo_ > _hi_, in which
-    # case the input can be any number.
+    # The input is constrained between _lo_ and _hi_.
     #
-    def FXInputDialog.getInteger(initial, owner, caption, label, ic=nil, lo=1, hi=0); end
+    def FXInputDialog.getInteger(initial, owner, caption, label, ic=nil, lo=-2147483647, hi=2147483647); end
   
+    #
+    # Prompt for an integer, in a free-floating window..
+    #
+    def FXInputDialog.getInteger(initial, app, caption, label, ic=nil, lo=-2147483647, hi=2147483647); end
+
     #
     # Prompt the user for a real number, starting from the specified _initial_ value.
     # Return the input value if the user clicks *OK*, else return +nil+.
-    # The input is constrained between _lo_ and _hi_, unless _lo_ > _hi_, in which
-    # case the input can be any number.
+    # The input is constrained between _lo_ and _hi_.
+    #
+    def FXInputDialog.getReal(initial, owner, caption, label, ic=nil, lo=-1.797693134862315e+308, hi=1.797693134862315e+308); end
+
+    #
+    # Prompt for a real number, in a free-floating window..
     #
-    def FXInputDialog.getReal(initial, owner, caption, label, ic=nil, lo=1.0, hi=0.0); end
+    def FXInputDialog.getReal(initial, owner, caption, label, ic=nil, lo=-1.797693134862315e+308, hi=1.797693134862315e+308); end
   end
 end
 

data/rdoc-sources/FXJPGIcon.rb

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

data/rdoc-sources/FXJPGImage.rb

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

data/rdoc-sources/FXKnob.rb

@@ -0,0 +1,76 @@
+module Fox
+  #
+  # The knob widget is a valuator widget which provides simple linear value range.
+  # While being moved, the knob sends +SEL_CHANGED+ messages to its target;
+  # at the end of the interaction, a final +SEL_COMMAND+ message is sent.
+  # The message data represents the current knob value (an integer).
+  #
+  # === Events
+  #
+  # The following messages are sent by FXKnob 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 knob move; the message data is the new value of the knob.
+  # +SEL_CHANGED+::
+  #   sent continuously while the knob is being moved; the message data is an integer indicating
+  #   the current knob value.
+  #
+  # === Knob Control styles
+  #
+  # +KNOB_NEEDLE+::	Use a needle as indicator
+  # +KNOB_DOT+::	Use a dot as indicator
+  # +KNOB_TICKS+::	Show ticks around the knob
+  # +KNOB_INDICATOR+::	Show only the indicator (like a speedometer)
+  # +KNOB_NORMAL+::	Normal knob looks
+  #
+  class FXKnob < FXFrame
+
+    # Knob value [Integer]
+    attr_accessor :value
+    
+    # Knob range [Range]
+    attr_accessor :range
+    
+    # Knob style [Integer]
+    attr_accessor :knobStyle
+    
+    # Knob auto-increment/decrement value [Integer]
+    attr_accessor :increment
+    
+    # Delta between ticks [Integer]
+    attr_accessor :tickDelta
+    
+    # Indicator needle color [FXColor]
+    attr_accessor :lineColor
+    
+    # Help text displayed on the status line [String]
+    attr_accessor :helpText
+    
+    # Tooltip text value [String]
+    attr_accessor :tipText
+    
+    #
+    # Return a new FXKnob instance.
+    #
+    def initialize(p, tgt=nil, sel=0, opts=KNOB_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theKnob
+    end
+
+    # 
+    # Change the knob's movement limits (start and ending angles)
+    # Accept values in degrees from 0 (south) to 360.
+    #
+    def setLimits(start_angle, end_angle, notify=false); end
+
+    #
+    # Return the knob's current limits as a two-element array.
+    #
+    def getLimits(); end
+  end
+end
+

data/rdoc-sources/FXList.rb

@@ -243,6 +243,14 @@ module Fox
     # Raises IndexError if either _oldIndex_ or _newIndex_ is out of bounds.
     #
     def moveItem(newIndex, oldIndex, notify=false); end
+    
+    #
+    # Extract item from list and return a reference to the item.
+    # If _notify_ is  +true+, a +SEL_DELETED+ message is sent to the list's
+    # message target before the item is extracted from the list.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def extractItem(index, notify=false); end
 
     # Remove item at _index_ from list.
     # If _notify_ is  +true+, a +SEL_DELETED+ message is sent to the list's message target

data/rdoc-sources/FXListBox.rb

@@ -15,7 +15,7 @@ module Fox
   # +SEL_COMMAND+::
   #   sent when a new list item is clicked; the message data is the index of the selected item.
   # +SEL_CHANGED+::
-  #   sent when a new list item is clicked; the message data is the index of the selected item.
+  #   sent when a new list item is clicked.
   #
   # === List Box styles
   #
@@ -108,6 +108,12 @@ module Fox
     #
     def moveItem(newIndex, oldIndex); end
 
+    #
+    # Extract item from list and return a reference to the item.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def extractItem(index); end
+
     #
     # Remove this item from the list.
     # Raises IndexError if _index_ is out of bounds.

data/rdoc-sources/FXMenuCaption.rb

@@ -36,6 +36,9 @@ module Fox
     
     # Status line help text for this menu [String]
     attr_accessor :helpText
+    
+    # Tool tip message for this menu [String]
+    attr_accessor :tipText
 
     #
     # Construct a new menu caption

data/rdoc-sources/FXMenuCheck.rb

@@ -3,13 +3,13 @@ module Fox
   # The FXMenuCheck widget is used to change a state in the application from a menu.
   # Menu checks may reflect the state of the application by graying out, becoming
   # hidden, or by a check mark.
+  # When activated, a menu check sends a +SEL_COMMAND+ message to its target;
+  # the message data contains the new state (one of +TRUE+, +FALSE+ or +MAYBE+).
   #
   # === Events
   #
   # The following messages are sent by FXMenuCheck 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 FXMenuCheck < FXMenuCommand