fxruby 1.2.6 → 1.4.0

data/rdoc-sources/FXFont.rb

@@ -278,7 +278,7 @@ module Fox
     # 
     #  For example:
     # 
-    #      "helvetica [bitstream],12,bold,i,normal,iso8859-1,0"
+    #      "helvetica [bitstream],120,bold,i,normal,iso8859-1,0"
     # 
     #  Typically, at least the font name, and size must be given for
     #  normal font matching.  As a special case, raw X11 fonts can also be
@@ -311,14 +311,7 @@ module Fox
     def fontMono? ; end
   
     #
-    # Return +true+ if font has glyph for _ch_. Here, _ch_ can either be an
-    # ordinal value, e.g.
-    #
-    #     aFont.hasChar?(?a)
-    #
-    # or a string of length one (i.e. a single character), e.g.
-    #
-    #     aFont.hasChar?('a')
+    # Return +true+ if font has glyph for _ch_.
     #
     def hasChar?(ch) ; end
 

data/rdoc-sources/FXFrame.rb

@@ -1,6 +1,12 @@
 module Fox
   #
-  # Base frame
+  # The Frame widget provides borders around some contents. Borders may be raised, sunken,
+  # thick, ridged or etched.  They can also be turned off completely.
+  # In addition, a certain amount of padding may be specified between the contents of
+  # the widget and the borders.  The contents may be justified inside the widget using the
+  # justification options. 
+  # The Frame widget is sometimes used by itself as a place holder, but most often is used
+  # as a convenient base class for simple controls.
   #
   # === Constants
   #

data/rdoc-sources/FXGIFCursor.rb

@@ -3,6 +3,11 @@ module Fox
   # GIF Cursor class.
   #
   class FXGIFCursor < FXCursor
+    #
+    # Return the suggested file extension for this image type ("gif").
+    #
+    def FXGIFCursor.fileExt; end
+
     #
     # Return an initialized FXGIFCursor instance.
     #
@@ -11,18 +16,20 @@ module Fox
   end  
   
   #
-  # Save a GIF image to a stream.
+  # Save a GIF (Graphics Interchange Format) image to a stream.
+  # If _fast_ is +true+, the faster Floyd-Steinberg dither method will be used
+  # instead of the slower Wu quantization algorithm.
   # Returns +true+ on success, +false+ on failure.
   #
   # ==== Parameters:
   #
   # +store+::	stream to which to write the image data [FXStream]
-  # +data+::	the image pixel data [String]
-  # +transp+::	transparency color [FXColor]
+  # +data+::	the image pixel data [Array of FXColor]
   # +width+::	width [Integer]
   # +height+::	height [Integer]
+  # +fast+::	if +true+, use faster Floyd-Steinberg algorithm [Boolean]
   #
-  def fxsaveGIF(store, data, transp, width, height); end
+  def Fox.fxsaveGIF(store, data, width, height, fast=true); end
   
   #
   # Load a GIF file from a stream.
@@ -34,5 +41,10 @@ module Fox
   #
   # +store+::	stream from which to read the file data [FXStream]
   #
-  def fxloadGIF(store); end
+  def Fox.fxloadGIF(store); end
+
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a GIF image.
+  #
+  def Fox.fxcheckGIF(store); end
 end

data/rdoc-sources/FXGIFIcon.rb

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

data/rdoc-sources/FXGIFImage.rb

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

data/rdoc-sources/FXHeader.rb

@@ -18,6 +18,13 @@ module Fox
   # +ABOVE+::		Icon above the text
   # +BELOW+::		Icon below the text
   #
+  # === Arrow
+  #
+  # +ARROW_NONE+::	No arrow
+  # +ARROW_UP+::	Arrow pointing up
+  # +ARROW_DOWN+::	Arrow pointing down
+  # +PRESSED+::		Pressed down
+  #
   class FXHeaderItem < FXObject
 
     # Item's text label [String]
@@ -115,6 +122,7 @@ module Fox
   # +HEADER_HORIZONTAL+::	Horizontal header control (default)
   # +HEADER_VERTICAL+::		Vertical header control
   # +HEADER_TRACKING+::		Tracks continuously while moving
+  # +HEADER_RESIZE+::		Allow resizing sections
   # +HEADER_NORMAL+::		Normal options, same as <tt>HEADER_HORIZONTAL|FRAME_NORMAL</tt>
   #
   # === Message identifiers
@@ -183,6 +191,12 @@ module Fox
     #
     def setItem(index, text, icon=nil, size=0, data=nil, notify=false); end
   
+    #
+    # Fill the header by appending items from an array of strings.
+    # Returns the number of items appended.
+    # 
+    def fillItems(strings, icon=nil, size=0, data=nil, notify=false); end
+
     #
     # Insert a new (possibly subclassed) item at the specified _index_ and return the
     # index of the inserted item.
@@ -325,8 +339,11 @@ module Fox
     def getArrowDir(index); end
 
     #
-    # Change item justification for the item at _index_, to one of
-    # +LEFT+, +RIGHT+, +CENTER_X+, +TOP+, +BOTTOM+ or +CENTER_Y+.
+    # Change item justification. Horizontal justification is controlled by passing
+    # FXHeaderItem::RIGHT, FXHeaderItem::LEFT, or FXHeaderItem::CENTER_X.
+    # Vertical justification is controlled by FXHeaderItem::TOP, FXHeaderItem::BOTTOM,
+    # or FXHeaderItem::CENTER_Y.
+    # The default is a combination of FXHeaderItem::LEFT and FXHeaderItem::CENTER_Y.
     # Raises IndexError if _index_ is out of bounds.
     #
     def setItemJustify(index, justify); end
@@ -339,8 +356,11 @@ module Fox
     def getItemJustify(index); end
   
     #
-    # Change relative position of icon and text of the item at _index_
-    # to one of +ABOVE+, +BELOW+, +BEFORE+ or +AFTER+.
+    # Change relative position of icon and text of item.
+    # Passing FXHeaderItem::BEFORE or FXHeaderItem::AFTER places the icon
+    # before or after the text, and passing FXHeaderItem::ABOVE or
+    # FXHeaderItem::BELOW places it above or below the text, respectively.
+    # The default of FXHeaderItem::BEFORE places the icon in front of the text.
     # Raises IndexError if _index_ is out of bounds.
     #
     def setItemIconPosition(index, mode); end

data/rdoc-sources/FXICOIcon.rb

@@ -3,6 +3,11 @@ module Fox
   # ICO icon
   #
   class FXICOIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("ico").
+    #
+    def FXICOIcon.fileExt; end
+
     #
     # Return an initialized FXICOIcon instance.
     #
@@ -46,5 +51,10 @@ module Fox
   # +yspot+::	hotspot y-coordinate [Integer]
   #
   def Fox.fxsaveICO(store, pixels, transp, width, height, xspot=-1, yspot=-1); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a ICO image.
+  #
+  def Fox.fxcheckICO(store); end
 end
 

data/rdoc-sources/FXICOImage.rb

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

data/rdoc-sources/FXIconList.rb

@@ -25,8 +25,6 @@ module Fox
     # Indicates whether this item is draggable or not [Boolean]
     attr_writer	:draggable
     
-    attr_writer	:iconOwned
-
     # Constructor
     def initialize(text, bigIcon=nil, miniIcon=nil, data=nil) # :yields: theIconItem
     end
@@ -46,9 +44,6 @@ module Fox
     # Return +true+ if this item is draggable
     def draggable? ; end
     
-    # Return +true+ if this item owns its icons
-    def iconOwned? ; end
-    
     # Return the width of this item
     def getWidth(iconList); end
     
@@ -191,6 +186,9 @@ module Fox
     def initialize(p, tgt=nil, sel=0, opts=ICONLIST_NORMAL, x=0, y=0, w=0, h=0) # :yields: theIconList
     end
 
+    # Set headers from an array of strings.
+    def setHeaders(strings, size=1); end
+
     # Append header with given _text_ and optional _icon_.
     def appendHeader(text, icon=nil, size=1); end
     
@@ -224,20 +222,26 @@ module Fox
   
     # Return the item at the given _index_.
     # Raises IndexError if _index_ is out of bounds.
-    def retrieveItem(itemIndex); end
+    def getItem(itemIndex); end
   
     # Replace the item at _index_ with a (possibly subclassed) _item_.
     # If _notify_ is +true+, a +SEL_REPLACED+ message is sent to the list's message target
     # before the item is replaced.
     # Raises IndexError if _index_ is out of bounds.
-    def replaceItem(index, item, notify=false); end
+    def setItem(index, item, notify=false); end
 
     # Replace item _text_, _bigIcon_, _miniIcon_ and user _data_ for the item at _index_.
     # If _notify_ is +true+, a +SEL_REPLACED+ message is sent to the list's message target
     # before the item is replaced.
     # Raises IndexError if _index_ is out of bounds.
-    def replaceItem(index, text, bigIcon=nil, miniIcon=nil, data=nil, notify=false); end
+    def setItem(index, text, bigIcon=nil, miniIcon=nil, data=nil, notify=false); end
 
+    #
+    # Fill list by appending items from array of strings, and return the number
+    # of items appended.
+    #
+    def fillItems(strings, big=nil, mini=nil, data=nil, notify=false); end
+  
     # Insert a new (possibly subclassed) _item_ at the given _index_.
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message target
     # after the item is inserted.
@@ -292,12 +296,32 @@ module Fox
     def clearItems(notify=false); end
   
     # Return index of item at (_x_, _y_), or -1 if none
-    def itemAt(x, y); end
+    def getItemAt(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 _text_, 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
   
+    #
+    # Search items by associated user _data_, 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 findItemByData(data, start=-1, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+
     #
     # Scroll to bring item into view. The argument is either a reference to
     # an FXIconItem instance, or the integer index of an item in the list.
@@ -316,7 +340,7 @@ module Fox
     
     # Change big icon for item at _index_.
     # Raises IndexError if _index_ is out of bounds.
-    def setItemBigIcon(index, bigIcon); end
+    def setItemBigIcon(index, bigIcon, owned=false); end
     
     # Return big icon for item at _index_.
     # Raises IndexError if _index_ is out of bounds.
@@ -324,7 +348,7 @@ module Fox
     
     # Change mini icon for item at _index_.
     # Raises IndexError if _index_ is out of bounds.
-    def setItemMiniIcon(index, miniIcon); end
+    def setItemMiniIcon(index, miniIcon, owned=false); end
     
     # Return mini icon for item at _index_.
     # Raises IndexError if _index_ is out of bounds.

data/rdoc-sources/FXIconSource.rb

@@ -0,0 +1,100 @@
+module Fox
+  #
+  # An icon source is an object that loads an icon of any type.
+  # It exists purely for convenience, to make loading icons
+  # simpler by concentrating the knowledge of the supported
+  # icon formats in a single place.
+  # Needless to say, this class is subclassable, allowing users
+  # to add additional icon types and make them available to
+  # all widgets which deal with icons.
+  # Note, the icons are loaded, but _not_ created (realized) yet;
+  # this allows users to manipulate the pixel data prior to
+  # realizing the icons.
+  #
+  class FXIconSource < FXObject
+    #
+    # Construct an icon source, given a reference to the application object.
+    #
+    def initialize(app) # :yields: theIconSource
+    end
+    
+    #
+    # Load an icon from the file _filename_. By default, the file extension is
+    # stripped and used as the icon _type_; if an explicit icon type is forced,
+    # then that type is used and the extension is ignored.
+    # For example, loadIcon("icon", "gif") will try to load a CompuServe GIF
+    # file, since the filename does not give any clue as to the type of the
+    # icon.
+    # Returns a reference to the icon.
+    #
+    def loadIcon(filename, type=nil); end
+
+    #
+    # Load an icon of a given type (e.g. "gif") from reswrapped data.
+    # Returns +nil+ if there's some error loading the icon. (The optional
+    # _type_ parameter is actually mandatory at the time of this writing; future
+    # versions will attempt to inspect the first few bytes of the stream
+    # to divine the icon format if the parameter is omitted).
+    # Returns a reference to the icon.
+    #
+    def loadIcon(pixels, type=nil); end
+
+    #
+    # Load an icon of a given type (e.g. "gif") from an already open stream.
+    # Returns +nil+ if there's some error loading the icon. (The optional
+    # _type_ parameter is actually mandatory at the time of this writing; future
+    # versions will attempt to inspect the first few bytes of the stream
+    # to divine the icon format if the parameter is omitted).
+    # Returns a reference to the icon.
+    #
+    def loadIcon(store, type=nil); end
+
+    #
+    # Load an image from the file filename. By default, the file extension is
+    # stripped and used as the image type; if an explicit image type is forced,
+    # then that type is used and the extension is ignored.
+    # For example, loadImage("image","gif") will try to load a CompuServe GIF
+    # file, since the filename does not give any clue as to the type of the
+    # image.
+    #
+    def loadImage(filename, type=nil); end
+
+    #
+    # Load an image of a given type (e.g. "gif") from reswrapped data.
+    # Returns +nil+ if there's some error loading the icon. (The optional
+    # parameter is actually mandatory at the time of this writing; future
+    # 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
+  
+    #
+    # Load an image of a given type (e.g. "gif") from an already open stream.
+    # Returns +nil+ if there's some error loading the image. (The optional
+    # parameter is actually mandatory at the time of this writing; future
+    # 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
+
+    # Load icon and scale it such that its dimensions do not exceed given size
+    def loadScaledIcon(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
+
+    # Load icon and scale it such that its dimensions do not exceed given size
+    def loadScaledIcon(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
+
+    # Load image and scale it such that its dimensions do not exceed given size
+    def loadScaledImage(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
+  end
+end
+
+

data/rdoc-sources/FXImage.rb

@@ -23,6 +23,8 @@ module Fox
   #   Dither image to look better
   # +IMAGE_NEAREST+::
   #   Turn off dithering and map to nearest color
+  # +IMAGE_ALPHA+::
+  #   Data has alpha channel
   # +IMAGE_OPAQUE+::
   #   Force opaque background
   # +IMAGE_ALPHACOLOR+::
@@ -151,7 +153,10 @@ module Fox
     def rotate(degrees) ; end
   
     #
-    # Crop image to given rectangle
+    # Crop image to given rectangle; this calls resize() to adjust the client
+    # and server side representations.  The new image 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 image.
     #
     # ==== Parameters:
     #
@@ -159,8 +164,9 @@ module Fox
     # +y+::	y-coordinate for top left corner of the clip rectangle [Integer]
     # +w+::	width of the clip rectangle [Integer]
     # +h+::	height of the clip rectangle [Integer]
+    # +color+::	fill color for blank areas after crop [FXColor]
     #
-    def crop(x, y, w, h) ; end
+    def crop(x, y, w, h, color=0) ; end
   
     #
     # Save pixel data to a stream.