fxruby 1.2.6 → 1.4.0

data/rdoc-sources/FXInputDialog.rb

@@ -25,6 +25,12 @@ module Fox
     def initialize(owner, caption, label, ic=nil, opts=INPUTDIALOG_STRING, x=0, y=0, w=0, h=0) # :yields: theInputDialog
     end
   
+    #
+    # Construct free-floating input dialog box with given caption, icon, and prompt text.
+    #
+    def initialize(anApp, caption, label, ic=nil, opts=INPUTDIALOG_STRING, x=0, y=0, w=0, h=0) # :yields: theInputDialog
+    end
+
     #
     # Change limits (where _lo_ and _hi_ are numbers).
     #

data/rdoc-sources/FXJPGIcon.rb

@@ -4,6 +4,14 @@ module Fox
   #
   class FXJPGIcon < FXIcon
   
+    #
+    # Return the suggested file extension for this image type ("jpg").
+    #
+    def FXJPGIcon.fileExt; end
+    
+    # Return +true+ if JPEG image file format is supported.
+    def FXJPGIcon.supported? ; end
+
     # Image quality setting [Integer]
     attr_accessor :quality
 
@@ -48,5 +56,10 @@ module Fox
   # +quality+::	image quality [Integer]
   #
   def Fox.fxsaveJPG(store, data, transp, width, height, quality); end
+
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a JPEG image.
+  #
+  def Fox.fxcheckJPG(store); end
 end
 

data/rdoc-sources/FXJPGImage.rb

@@ -4,6 +4,14 @@ module Fox
   #
   class FXJPGImage < FXImage
   
+    #
+    # Return the suggested file extension for this image type ("jpg").
+    #
+    def FXJPGImage.fileExt; end
+
+    # Return +true+ if JPEG image file format is supported.
+    def FXJPGImage.supported? ; end
+
     # Image quality
     attr_accessor :quality
 

data/rdoc-sources/FXLabel.rb

@@ -2,7 +2,10 @@ module Fox
   #
   # A label widget can be used to place a text and/or icon for
   # explanation purposes. The text label may have an optional tooltip
-  # and/or help string.
+  # and/or help string.  Icon and label are placed relative to the widget
+  # using the justfication options, and relative to each other as determined
+  # by the icon relationship options.  A large number of arrangements is
+  # possible.
   #
   # === Justification modes
   #

data/rdoc-sources/FXList.rb

@@ -25,9 +25,6 @@ module Fox
     # Indicates whether this item is draggable [Boolean]
     attr_writer :draggable
     
-    # Indicates whether this item owns its icons [Boolean]
-    attr_writer :iconOwned
-    
     # Initialize
     def initialize(text, icon=nil, data=nil) # :yields: theListItem
     end
@@ -44,9 +41,6 @@ module Fox
     # Return +true+ if this item is draggable
     def draggable?() ; end
     
-    # Return +true+ if this icon is owned
-    def iconOwned?() ; end
-    
     # Return the width of this item for a specified list
     def getWidth(list) ; end
     
@@ -174,6 +168,14 @@ module Fox
     # Returns the integer index of the replaced item.
     def setItem(index, text, icon=nil, data=nil, notify=false) ; end
 
+    #
+    # Fill list by appending items from array of strings, and return the number
+    # items added.
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's
+    # message target after the item is added.
+    #
+    def fillItems(strings, icon=nil, ptr=nil, notify=false); end
+
     # Insert a new (possibly subclassed) _item_ at the given _index_, e.g.
     #
     #   list.insertItem(1, FXListItem.new("blinky"))
@@ -265,8 +267,16 @@ module Fox
     # Return item hit code: 0 no hit; 1 hit the icon; 2 hit the text
     def hitItem(index, x, y) ; end
 
-    # Search items for item by name, starting from start item; the
-    # flags argument controls the search direction, and case sensitivity.
+    #
+    # Search items by name, beginning from item start.  If the start
+    # item is -1 the search will start at the first item in the list.
+    # Flags may be SEARCH_FORWARD or SEARCH_BACKWARD to control the
+    # search direction; this can be combined with SEARCH_NOWRAP or SEARCH_WRAP
+    # to control whether the search wraps at the start or end of the list.
+    # The option SEARCH_IGNORECASE causes a case-insensitive match.  Finally,
+    # passing SEARCH_PREFIX causes searching for a prefix of the item name.
+    # Return -1 if no matching item is found.
+    #
     def findItem(text, start=-1, flags=SEARCH_FORWARD|SEARCH_WRAP) ; end
 
     #
@@ -305,7 +315,7 @@ module Fox
     #
     # Raises IndexError if _index_ is out of bounds.
     #
-    def setItemIcon(index, icon) ; end
+    def setItemIcon(index, icon, owned=false) ; end
 
     #
     # Return item icon, if any. This is equivalent to:

data/rdoc-sources/FXListBox.rb

@@ -1,6 +1,12 @@
 module Fox
   #
-  # List Box
+  # The List Box is a control to select one of a list of options.  It looks
+  # similar to a Combo Box except that List Box yields integer numbers only.
+  # When an option is selected, List Box will send an SEL_COMMAND with the
+  # index of the opton.  While manipulating the list, it may send SEL_CHANGED
+  # messages to indicate which option the cursor is hovering over.
+  # The List Box is able to receive ID_GETINTVALUE and ID_SETINTVALUE which
+  # will retrieve the current option or change the selected option.
   #
   # === Events
   #
@@ -77,6 +83,12 @@ module Fox
     #
     def setItem(index, text, icon=nil, ptr=nil); end
   
+    #
+    # Fill list by appending items from array of strings, and return the number
+    # items added.
+    #
+    def fillItems(strings, icon=nil, ptr=nil); end
+
     #
     # Insert a new item at index.
     # Raises IndexError if _index_ is out of bounds.
@@ -106,8 +118,14 @@ module Fox
     def clearItems(); end
   
     #
-    # Search items for item by name, starting from _start_ item; the
-    # _flags_ argument controls the search direction, and case sensitivity.
+    # Search items by name, beginning from item start.  If the start
+    # item is -1 the search will start at the first item in the list.
+    # Flags may be SEARCH_FORWARD or SEARCH_BACKWARD to control the
+    # search direction; this can be combined with SEARCH_NOWRAP or SEARCH_WRAP
+    # to control whether the search wraps at the start or end of the list.
+    # The option SEARCH_IGNORECASE causes a case-insensitive match.  Finally,
+    # passing SEARCH_PREFIX causes searching for a prefix of the item name.
+    # Return -1 if no matching item is found.
     #
     def findItem(text, start=-1, flags=SEARCH_FORWARD|SEARCH_WRAP); end
   
@@ -127,7 +145,7 @@ module Fox
     # Set icon for specified item to _icon_.
     # Raises IndexError if _index_ is out of bounds.
     #
-    def setItemIcon(index, icon); end
+    def setItemIcon(index, icon, owned=false); end
     
     #
     # Return icon for specified item.

data/rdoc-sources/FXMDIChild.rb

@@ -1,7 +1,26 @@
 module Fox
   #
-  # The MDI child window contains the application
-  # work area in a Multiple Document Interface application.
+  # The MDI child window contains the application work area in a Multiple Document
+  # Interface application.  GUI Controls are connected to the MDI child via delegation
+  # through the MDI client, which forwards messages it receives to the active MDI child.
+  # The MDI child itself tries to further delegate messages to its single content window,
+  # and if not handled there, to its target object.
+  # When the MDI child is maximized, it sends a SEL_MAXIMIZE message; when the MDI
+  # child is minimized, it sends a SEL_MINIMIZE message.  When it is restored, it
+  # sends a SEL_RESTORE message to its target.  The MDI child also notifies its
+  # target when it becomes the active MDI child, via the SEL_SELECTED message.
+  # The void* in the SEL_SELECTED message refers to the previously active MDI child,
+  # if any.  When an MDI child ceases to be the active one, a SEL_DESELECTED message
+  # is sent.  The void* in the SEL_DESELECTED message refers to the newly activated
+  # MDI child, if any.  Thus, interception of SEL_SELECTED and SEL_DESELECTED allows
+  # the target object to determine whether the user switched between MDI windows of
+  # the same document (target) or between MDI windows belonging to the same document.
+  # When the MDI child is closed, it sends a SEL_CLOSE message to its target.
+  # The target has an opportunity to object to the closing; if the MDI child should
+  # not be closed, it should return 1 (objection). If the MDI child should be closed,
+  # the target can either just return 0 or simply not handle the SEL_CLOSE message.
+  # The SEL_UPDATE message can be used to modify the MDI child's title (via
+  # ID_SETSTRINGVALUE), and window icon (via ID_SETICONVALUE).
   #
   # === Events
   #

data/rdoc-sources/FXMDIClient.rb

@@ -1,16 +1,20 @@
 module Fox
   #
-  # The MDI client window manages a number of MDI child windows in
-  # a multiple-document interface (MDI) application.
-  # MDI child windows usually receive messages from the GUI through
-  # delegation via the MDI client, i.e. the MDI client window is set as
-  # the target for most GUI commands; the MDI client filters out a few messages
-  # and forwards all other messages to the active MDI child.
-  # MDI client can arrange the MDI child windows in various ways:-
-  # it may maximize one of the MDI child windows, arrange them side-by-side,
-  # cascade them, or iconify them.
-  # MDI child windows are notified about changes in the active MDI child
-  # window by the MDI client.
+  # The MDI client window manages a number of MDI child windows in a multiple-document
+  # interface (MDI) application. MDI child windows usually receive messages from the GUI controls
+  # by delegation via the MDI client.  This is accomplished by making the MDI client window
+  # the target for most GUI controls.  The MDI client filters out messages intented for itself,
+  # and delegates the remaining messages to its currently active MDI child, if any.
+  # If you use the auto-gray or auto-hide feature available in some GUI controls, these
+  # controls can be automatically grayed out or hidden when there is no active MDI child.
+  # When delegating messages via MDI client to MDI child windows of different types, care
+  # should be taken that message ID's do not overlap, so that all message ID's only map to
+  # the intented handlers no matter which MDI child window type is active.
+  # The MDI client sends a SEL_CHANGED message to its target when the active MDI child is
+  # switched, with the void  # pointer refering to the new MDI child.
+  # A MDI Window selection dialog can be brought up through the ID_MDI_OVER_X messages;
+  # a menu button connected to the MDI client with the ID_MDI_OVER_X message will be
+  # automatically grayed out if there are less than X MDI child windows.
   #
   # === Events
   #

data/rdoc-sources/FXMainWindow.rb

@@ -1,6 +1,12 @@
 module Fox
   #
-  # Main application window
+  # The Main Window is usually the central window of an application.  Applications
+  # may have any number of main windows.
+  # When a MainWindow is closed, it sends a SEL_CLOSE message to its target; the target
+  # should return 0 if there is no objection against proceeding with the close, and
+  # return 1 otherwise.
+  # After the SEL_CLOSE message has been sent and no objection was raised, the main
+  # window will delete itself.
   #
   # === Events
   #

data/rdoc-sources/FXMemoryStream.rb

@@ -7,6 +7,8 @@ module Fox
   #
   class FXMemoryStream < FXStream
 
+    attr_reader :position
+
     #
     # Construct a new memory stream with given container object.
     # The container object is an object that will itself not be

data/rdoc-sources/FXMenuBar.rb

@@ -16,7 +16,7 @@ module Fox
     # Construct a non-floatable menubar.
     # The menubar can not be undocked.
     #
-    def initialize(parent, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theMenuBar
+    def initialize(parent, opts, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theMenuBar
     end
   end
 end

data/rdoc-sources/FXMessageBox.rb

@@ -1,15 +1,23 @@
 module Fox
   #
-  # Message box
+  # A Message Box is a convenience class which provides a dialog for
+  # very simple common yes/no type interactions with the user.
+  # The message box has an optional icon, a title string, and the question
+  # which is presented to the user.  It also has up to three buttons which
+  # furnish standard responses to the question.
+  # Message boxes are usually run modally: the question must be answered
+  # before the program may continue.
   #
   # === Message box buttons
   #
-  # +MBOX_OK+::			Message box has a only an *Ok* button
-  # +MBOX_OK_CANCEL+::		Message box has *Ok* and *Cancel* buttons
-  # +MBOX_YES_NO+::		Message box has *Yes* and *No* buttons
-  # +MBOX_YES_NO_CANCEL+::	Message box has *Yes*, *No*, and *Cancel* buttons
-  # +MBOX_QUIT_CANCEL+::	Message box has *Quit* and *Cancel* buttons
-  # +MBOX_QUIT_SAVE_CANCEL+::	Message box has *Quit*, *Save*, and *Cancel* buttons
+  # +MBOX_OK+::				Message box has a only an *Ok* button
+  # +MBOX_OK_CANCEL+::			Message box has *Ok* and *Cancel* buttons
+  # +MBOX_YES_NO+::			Message box has *Yes* and *No* buttons
+  # +MBOX_YES_NO_CANCEL+::		Message box has *Yes*, *No*, and *Cancel* buttons
+  # +MBOX_QUIT_CANCEL+::		Message box has *Quit* and *Cancel* buttons
+  # +MBOX_QUIT_SAVE_CANCEL+::		Message box has *Quit*, *Save*, and *Cancel* buttons
+  # +MBOX_SKIP_SKIPALL_CANCEL+::	Message box has *Skip*, *Skip All* and *Cancel* buttons
+  # +MBOX_SAVE_CANCEL_DONTSAVE+::	Message box has *Don't Save*, *Cancel* and *Save* buttons
   #
   # === Return values
   #
@@ -19,6 +27,8 @@ module Fox
   # +MBOX_CLICKED_CANCEL+::	The *Cancel* button was clicked
   # +MBOX_CLICKED_QUIT+::	The *Quit* button was clicked
   # +MBOX_CLICKED_SAVE+::	The *Save* button was clicked
+  # +MBOX_CLICKED_SKIP+::	The *Skip* button was clicked
+  # +MBOX_CLICKED_SKIPALL+::	The *Skip All* button was clicked
   #
   class FXMessageBox < FXDialogBox
     #

data/rdoc-sources/FXObject.rb

@@ -1,6 +1,12 @@
 module Fox
   #
-  # Base class for all FOX objects.
+  # FXObject is the base class for all objects in FOX; in order to receive
+  # messages from the user interface, your class must derive from FXObject.
+  # The FXObject class also provides serialization facilities, with which
+  # you can save and restore the object's state.  If you've subclassed
+  # from FXObject, you can save your subclasses' state by overloading the
+  # save() and load() functions and use the stream API to serialize its
+  # member data.
   #
   class FXObject
     #

data/rdoc-sources/FXPCXIcon.rb

@@ -3,6 +3,11 @@ module Fox
   # PCX icon
   #
   class FXPCXIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("pcx").
+    #
+    def FXPCXIcon.fileExt; end
+
     #
     # Return an initialized FXPCXIcon instance.
     #
@@ -44,5 +49,10 @@ module Fox
   # +height+::	height [Integer]
   #
   def Fox.fxsavePCX(store, data, transp, width, height); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a PCX image.
+  #
+  def Fox.fxcheckPCX(store); end
 end
 

data/rdoc-sources/FXPCXImage.rb

@@ -3,6 +3,11 @@ module Fox
   # PCX graphics file
   #
   class FXPCXImage < FXImage
+    #
+    # Return the suggested file extension for this image type ("pcx").
+    #
+    def FXPCXImage.fileExt; end
+
     #
     # Return an initialized FXPCXImage instance.
     #

data/rdoc-sources/FXPNGIcon.rb

@@ -3,6 +3,14 @@ module Fox
   # Portable Network Graphics (PNG) Icon
   #
   class FXPNGIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("png").
+    #
+    def FXPNGIcon.fileExt; end
+
+    # Return +true+ if PNG image file format is supported.
+    def FXPNGIcon.supported? ; end
+
     #
     # Return an initialized FXPNGIcon instance.
     #
@@ -29,7 +37,7 @@ module Fox
   #
   # +store+::	stream from which to read the file data [FXStream]
   #
-  def fxloadPNG(store); end
+  def Fox.fxloadPNG(store); end
 
   #
   # Save a PNG image to a stream.
@@ -43,6 +51,11 @@ module Fox
   # +width+::	width [Integer]
   # +height+::	height [Integer]
   #
-  def fxsavePNG(store, data, transp, width, height); end
+  def Fox.fxsavePNG(store, data, transp, width, height); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a PNG image.
+  #
+  def Fox.fxcheckPNG(store); end
 end
 

data/rdoc-sources/FXPNGImage.rb

@@ -3,6 +3,14 @@ module Fox
   # Portable Network Graphics (PNG) Image
   #
   class FXPNGImage < FXImage
+    #
+    # Return the suggested file extension for this image type ("png").
+    #
+    def FXPNGImage.fileExt; end
+
+    # Return +true+ if PNG image file format is supported.
+    def FXPNGImage.supported? ; end
+
     #
     # Return an initialized FXPNGImage instance.
     #

data/rdoc-sources/FXPPMIcon.rb

@@ -3,6 +3,11 @@ module Fox
   # Portable Pixmap (PPM) icon class.
   #
   class FXPPMIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("ppm").
+    #
+    def FXPPMIcon.fileExt; end
+
     #
     # Return an initialized FXPPMIcon instance.
     #
@@ -18,4 +23,9 @@ module Fox
     def initialize(a, pix=nil, clr=0, opts=0, w=1, h=1) # :yields: thePPMIcon
     end
   end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a PPM image.
+  #
+  def Fox.fxcheckPPM(store); end
 end

data/rdoc-sources/FXPPMImage.rb

@@ -3,6 +3,11 @@ module Fox
   # Portable Pixmap (PPM) Image
   #
   class FXPPMImage < FXImage
+    #
+    # Return the suggested file extension for this image type ("ppm").
+    #
+    def FXPPMImage.fileExt; end
+
     #
     # Return an initialized FXPPMImage instance.
     #