fxruby 1.2.6 → 1.4.0

data/rdoc-sources/FXBMPIcon.rb

@@ -1,6 +1,18 @@
 module Fox
-  # Microsoft Bitmap icon
+  #
+  # The BMP Icon class is a convenience class for working with icons in the
+  # Microsoft Bitmap (.bmp) graphics file format.  This makes it possible to
+  # use resources created with Windows development tools inside FOX without
+  # need for graphics file format translators.  The bitmap loaded handles
+  # 1, 4, and 8 bit paletted bitmaps, 16 and 24 bit RGB bitmaps, and
+  # 32 bit RGBA bitmaps.
+  #
   class FXBMPIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("bmp").
+    #
+    def FXBMPIcon.fileExt; end
+    
     #
     # Return an initialized FXBMPIcon instance.
     #
@@ -42,4 +54,9 @@ module Fox
   # +height+::	height [Integer]
   #
   def Fox.fxsaveBMP(store, data, transp, width, height); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a BMP image.
+  #
+  def Fox.fxcheckBMP(store); end
 end

data/rdoc-sources/FXBMPImage.rb

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

data/rdoc-sources/FXBitmap.rb

@@ -48,6 +48,13 @@ module Fox
     #
     def release(); end
 
+    #
+    # Resize both client-side and server-side representations (if any) to the
+    # given width and height.  The new representations typically contain garbage
+    # after this operation and need to be re-filled.
+    #
+    def resize(w, h); end
+
     # Save pixel data only
     def savePixels(stream); end
     
@@ -60,7 +67,10 @@ module Fox
     # Change pixel at (_x_, _y_), where _color_ is either +true+ or +false+.
     def setPixel(x, y, color) ; end
     
-    # Rescale pixels to the specified width and height.
+    #
+    # Rescale pixels image to the specified width and height; this calls
+    # #resize to adjust the client and server side representations.
+    #
     def scale(w, h); end
     
     # Mirror the bitmap horizontally and/or vertically
@@ -69,8 +79,13 @@ module Fox
     # Rotate bitmap by _degrees_ degrees (counter-clockwise)
     def rotate(degrees); end
     
-    # Crop bitmap to given rectangle
-    def crop(x, y, w, h); end
+    #
+    # Crop bitmap to given rectangle; this calls #resize to adjust the client
+    # and server side representations.  The new bitmap may be smaller or larger
+    # than the old one; blank areas are filled with _color_. There must be at
+    # least one pixel of overlap between the old and the new bitmap.
+    #
+    def crop(x, y, w, h, color=false); end
     
     # Fill bitmap with uniform value
     def fill(color); end

data/rdoc-sources/FXBitmapFrame.rb

@@ -1,6 +1,8 @@
 module Fox
   #
-  # An FXBitmapFrame is a simple frame widget that displays an FXBitmap image.
+  # The bitmap frame is a simple frame widget displaying an monochrome bitmap
+  # image; the bitmap is not owned by the bitmap frame so it must be explicitly
+  # deleted elsewhere.
   #
   class FXBitmapFrame < FXFrame
   

data/rdoc-sources/FXBitmapView.rb

@@ -1,6 +1,9 @@
 module Fox
   #
-  # The FXBitmapView widget displays a scrollable view of a bitmap.
+  # The Bitmap View widget display a scrollable view of a monochrome bitmap image;
+  # the bitmap is not owned by the bitmap frame so it must be explicitly deleted
+  # elsewhere.  Thus, a single bitmap image can be displayed inside multiple bitmap
+  # view widgets.
   #
   # === Bitmap alignment styles
   #

data/rdoc-sources/FXButton.rb

@@ -1,5 +1,21 @@
 module Fox
+  #
   # A button provides a push button, with optional icon and/or text label.
+  # When pressed, the button widget sends a <tt>SEL_COMMAND</tt> to its target.
+  # Passing the <tt>BUTTON_TOOLBAR</tt> style option gives buttons a "flat" look, and
+  # causes the edge of the button to be raised when the cursor moves over it.
+  # Passing <tt>BUTTON_DEFAULT</tt> allows the button to become the default button in
+  # a dialog, when the focus moves to it.  The default widget in a dialog
+  # is the widget which will accept the _Return_ key when it is pressed.
+  # The <tt>BUTTON_INITIAL</tt> flag makes the button the default widget when the
+  # focus moves to a widget which can not itself be a default widget.
+  # There should be only a single button in the dialog which is the
+  # initial default; typically this is the _OK_ or _Close_ button.
+  # The option <tt>BUTTON_AUTOGRAY</tt> (<tt>BUTTON_AUTOHIDE</tt>) causes the button to be grayed
+  # out (hidden) if its handler does not respond to the <tt>SEL_UPDATE</tt> message.
+  # This is useful when messages are delegated, for example when using a
+  # multiple document interface, where the ultimaye destination of a message
+  # can be changed.
   #
   # === Events
   #

data/rdoc-sources/FXCheckButton.rb

@@ -1,8 +1,17 @@
 module Fox
-  # A check button is a tri-state button.  Normally, it is either
+  #
+  # A Check button is a tri-state button.  Normally, it is either
   # +TRUE+ or +FALSE+, and toggles between +TRUE+ or +FALSE+ whenever it is pressed.
   # 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 Check Button sends a <tt>SEL_COMMAND</tt> to its target, and the
+  # message data represents the state of the check button.
+  # The option <tt>CHECKBUTTON_AUTOGRAY</tt> (<tt>CHECKBUTTON_AUTOHIDE</tt>) causes the button to be
+  # grayed out (hidden) if its handler does not respond to the <tt>SEL_UPDATE</tt> message.
+  # With the <tt>CHECKBUTTON_PLUS</tt> option, the Check Button will draw a + or - sign instead
+  # of a check. You can use this to make collapsible panels, by hooking up a Check
+  # Button to a layout manager via the <tt>ID_TOGGLE_SHOWN</tt> message. This will give a
+  # similar visual element as collapsing folders in a Tree List.
   #
   # === Events
   #
@@ -38,5 +47,20 @@ 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
+
+    # Return +true+ if the check button state is +TRUE+
+    def checked?
+      self.check == TRUE
+    end
+    
+    # Return +true+ if the check button state is +FALSE+
+    def unchecked?
+      self.check == FALSE
+    end
+    
+    # Return +true+ if the check button state is +MAYBE+
+    def maybe?
+      self.check == MAYBE
+    end
   end
 end

data/rdoc-sources/FXChoiceBox.rb

@@ -0,0 +1,82 @@
+module Fox
+  #
+  # The Choice Box provides a dialog panel to select one item out of a list
+  # of choices.  The choices are provided as a list of text strings.
+  # When the dialog closes, the index of the selected choice is returned,
+  # while a -1 is returned if the dialog was canceled,
+  #
+  class FXChoiceBox < FXDialogBox
+    #
+    # Construct choice box with given caption, icon, message text, and with choices from array of strings.
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		Owner window for this dialog box [FXWindow]
+    # +caption+::	Caption for this dialog box [String]
+    # +text+::		Message text for this dialog box [String]
+    # +icon+::		Icon for this dialog box [FXIcon]
+    # +choices+::	Array of strings containing choices [Array]
+    # +opts+::		Dialog box options [Integer]
+    # +x+::		x-coordinate
+    # +y+::		y-coordinate
+    # +w+::		width
+    # +h+::		height
+    #
+    def initialize(owner, caption, text, icon, choices, opts=0, x=0, y=0, w=0, h=0) # :yields: theChoiceBox
+    end
+
+    #
+    # Construct free floating choice box with given caption, icon, message text, and with choices from array of strings.
+    #
+    # ==== Parameters:
+    #
+    # +app+::		Reference to the application object [FXApp]
+    # +caption+::	Caption for this dialog box [String]
+    # +text+::		Message text for this dialog box [String]
+    # +icon+::		Icon for this dialog box [FXIcon]
+    # +choices+::	Array of strings containing choices [Array]
+    # +opts+::		Dialog box options [Integer]
+    # +x+::		x-coordinate
+    # +y+::		y-coordinate
+    # +w+::		width
+    # +h+::		height
+    #
+    def initialize(app, caption, text, icon, choices, opts=0, x=0, y=0, w=0, h=0) # :yields: theChoiceBox
+    end
+
+    #
+    # Show a modal choice dialog.
+    # Prompt the user using a dialog with given caption, icon,
+    # message text, and choices from array of strings.
+    # Returns -1 if the dialog box is cancelled, otherwise returns the index of the selected choice
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		Owner window for this dialog box [FXWindow]
+    # +opts+::		Dialog box options [Integer]
+    # +caption+::	Caption for this dialog box [String]
+    # +text+::		Message text for this dialog box [String]
+    # +icon+::		Icon for this dialog box [FXIcon]
+    # +choices+::	Array of strings containing choices [Array]
+    #
+    def FXChoiceBox.ask(owner, opts, caption, text, icon, choices); end
+
+    #
+    # Show modal choice message, in free floating window.
+    # Prompt the user using a dialog with given caption, icon,
+    # message text, and with choices from array of strings.
+    # Returns -1 if the dialog box is cancelled, otherwise returns the index of the selected choice
+    #
+    # ==== Parameters:
+    #
+    # +app+::		Reference to the application object [FXApp]
+    # +opts+::		Dialog box options [Integer]
+    # +caption+::	Caption for this dialog box [String]
+    # +text+::		Message text for this dialog box [String]
+    # +icon+::		Icon for this dialog box [FXIcon]
+    # +choices+::	Array of strings containing choices [Array]
+    #
+    def FXChoiceBox.ask(app, opts, caption, text, icon, choices); end
+  end
+end
+

data/rdoc-sources/FXColorBar.rb

@@ -1,6 +1,11 @@
 module Fox
-  # A color bar is a widget which controls the brightness (value) of a
+  #
+  # A Color Bar is a widget which controls the brightness (value) of a
   # color by means of the hue, saturation, value specification system.
+  # It is most useful when used together with the Color Wheel which controls
+  # the hue and saturation.
+  # The options <tt>COLORBAR_HORIZONTAL</tt> and <tt>COLORBAR_VERTICAL</tt> control the orientation
+  # of the bar.
   #
   # === Events
   #

data/rdoc-sources/FXColorDialog.rb

@@ -1,4 +1,5 @@
 module Fox
+  #
   # FXColorDialog is a standard dialog panel used to edit colors.
   # Colors can be edited via RGB (Red, Green, Blue additive color model),
   # via HSV (Hue, Saturation, Value color modal), via CMY (Cyan, Magenta,

data/rdoc-sources/FXColorWell.rb

@@ -1,5 +1,6 @@
 module Fox
-  # A color well is a widget which controls color settings.
+  #
+  # A Color Well is a widget which controls color settings.
   # Colors may be dragged and dropped from one color well to another.
   # A double-click inside a color well will bring up the standard
   # color dialog panel to edit the color well's color.
@@ -11,17 +12,16 @@ module Fox
   #
   # The following messages are sent from FXColorWell to its target:
   #
-  # +SEL_COMMAND+::		sent when a new color is applied
-  # +SEL_CHANGED+::		sent when the color changes
+  # +SEL_COMMAND+::		sent when a new color is applied; the message data is the color value.
+  # +SEL_CHANGED+::		sent when the color changes; the message data is the color value.
   # +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_CLICKED+::		sent when the color well is single-clicked
-  # +SEL_DOUBLECLICKED+::	sent when the color well is double-clicked
-  # +SEL_TRIPLECLICKED+::	sent when the color well is triple-clicked
+  # +SEL_CLICKED+::		sent when the color well is single-clicked; the message data is the color value.
+  # +SEL_DOUBLECLICKED+::	sent when the color well is double-clicked; the message data is the color value.
   #
   # === Color Well Styles
   #
@@ -51,6 +51,14 @@ module Fox
     def initialize(parent, color=0, target=nil, selector=0, opts=COLORWELL_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theColorWell
     end
 
+    # Set the color for this color well to _clr_.
+    # If _notify_ is +true+, a <tt>SEL_COMMAND</tt> message is sent to the color
+    # well's message target after the color is changed.
+    def setRGBA(clr, notify=false); end
+
+    # Return the color for this color well.
+    def getRGBA; end
+
     # Return +true+ if only opaque colors allowed
     def opaqueOnly?() ; end
   end

data/rdoc-sources/FXColorWheel.rb

@@ -1,13 +1,15 @@
 module Fox
-  # A color wheel is a widget which controls a color by means
-  # of the hue, saturation, value color specification system.
+  #
+  # A Color Wheel is a widget which controls the hue and saturation values of a
+  # color. It is most often used together with a Color Bar which controls the
+  # brightness.
   #
   # === Events
   #
   # The following messages are sent by FXColorWheel to its target:
   #
-  # +SEL_CHANGED+::		sent continuously, while the color is changing
-  # +SEL_COMMAND+::		sent when the new color is set
+  # +SEL_CHANGED+::		sent continuously, while the color is changing; the message data is a 3-element array of floats containing the hue, saturation and value.
+  # +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.
 

data/rdoc-sources/FXComboBox.rb

@@ -1,5 +1,18 @@
 module Fox
-  # Combobox
+  #
+  # An FXComboBox provides a way to select a string from a list of strings.
+  # Unless +COMBOBOX_STATIC+ is passed, it also allows the user to enter a new
+  # string into the text field, for example if the desired entry is not in the
+  # list of strings.  Passing +COMBOBOX_REPLACE+, +COMBOBOX_INSERT_BEFORE+, +COMBOBOX_INSERT_AFTER+,
+  # +COMBOBOX_INSERT_FIRST+, or +COMBOBOX_INSERT_LAST+ causes a newly entered text to replace the
+  # current one in the list, or be added before or after the current entry, or to be added at
+  # the beginning or end of the list.
+  # FXComboBox is intended to enter text; if you need to enter a choice from a list of
+  # options, it is recommended that the FXListBox widget is used instead.
+  # When the text in the field is changed, a +SEL_COMMAND+ will be send to the target.
+  # The FXComboBox can also receive +ID_GETSTRINGVALUE+ and +ID_SETSTRINGVALUE+ and so
+  # on, which will behave similar to FXTextField in that they will retrieve or update
+  # the value of the field.
   #
   # === Events
   #
@@ -38,7 +51,7 @@ module Fox
     # Number of items in the list [Integer]
     attr_reader	:numItems
     
-    # Number of visible items [Integer]
+    # Number of visible items in the drop-down list [Integer]
     attr_accessor :numVisible
     
     # Index of current item, or -1 if no current item [Integer]
@@ -69,12 +82,12 @@ module Fox
     attr_accessor :tipText
 
     #
-    # Return an initialized FXComboBox instance.
+    # Return an initialized FXComboBox instance, with room to display _cols_ columns of text.
     #
     # ==== Parameters:
     #
     # +p+::	the parent widget for this combo-box [FXComposite]
-    # +nc+::	number of columns [Integer]
+    # +cols+::	number of columns [Integer]
     # +tgt+::	message target [FXObject]
     # +sel+::	message identifier [Integer]
     # +opts+::	the options [Integer]
@@ -87,7 +100,7 @@ module Fox
     # +pt+::	top-side padding, in pixels [Integer]
     # +pb+::	bottom-side padding, in pixels [Integer]
     #
-    def initialize(p, nc, tgt=nil, sel=0, opts=COMBOBOX_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theComboBox
+    def initialize(p, cols, tgt=nil, sel=0, opts=COMBOBOX_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theComboBox
     end
 
     # Return +true+ if combobox is editable
@@ -105,6 +118,12 @@ module Fox
     # Raises IndexError if _index_ is out of bounds.
     def setItem(index, text, data=nil) ; end
 
+    #
+    # Fill combo box by appending items from _strings_, where _strings_ is
+    # an array of strings. Return the number of items added.
+    #
+    def fillItems(strings); end
+
     # Insert a new item at _index_, with the specified _text_ and user _data_.
     # Raises IndexError if _index_ is out of bounds.
     def insertItem(index, text, data=nil) ; end
@@ -128,6 +147,35 @@ module Fox
     # Remove all items from the list
     def clearItems() ; end
 
+    #
+    # Search for items by name, beginning from the item with index _start_.
+    # If the start item is -1, the search will start at the first item in the
+    # list. The search _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.
+    # Returns the index of the first matching item, or -1 if no matching item
+    # is found.
+    #
+    def findItem(text, start=-1, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+
+    #
+    # Search for items by associated user data, beginning from the item with
+    # index _start_.
+    # If the start item is -1, the search will start at the first item in the
+    # list.
+    # The search _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.
+    # Returns the index of the first matching item, or -1 if no matching item
+    # is found.
+    #
+    def findItemByData(data, start=-1, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+
     # Set text for the item at _index_.
     # Raises IndexError if _index_ is out of bounds.
     def setItemText(index, text) ; end

data/rdoc-sources/FXCursor.rb

@@ -27,10 +27,10 @@ module Fox
     attr_reader	:height
     
     # Hotspot x-coordinate (returns zero for stock cursors) [Integer]
-    attr_reader	:hotX
+    attr_accessor :hotX
     
     # Hotspot y-coordinate (returns zero for stock cursors) [Integer]
-    attr_reader	:hotY
+    attr_accessor :hotY
 
     #
     # Make stock cursor, where _stockCursorId_ is one of the stock cursors