fxruby 1.2.6 → 1.4.0

data/rdoc-sources/FXTreeListBox.rb

@@ -1,6 +1,10 @@
 module Fox
   #
-  # Tree list box.
+  # The Tree List Box behaves very much like a List Box, except that
+  # it supports a hierarchical, tree structured display of the items.
+  # When an item is selected it issues a +SEL_COMMAND+ message with the
+  # pointer to the item. While manipulating the tree list, it may send
+  # +SEL_CHANGED+ messages to indicate which item the cursor is hovering over.
   #
   # === Tree list box styles
   #
@@ -61,54 +65,50 @@ module Fox
     def initialize(p, tgt=nil, sel=0, opts=FRAME_SUNKEN|FRAME_THICK|TREELISTBOX_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theTreeListBox
     end
 
-    # Prepend a new (possibly subclassed) _item_ as first child of _parentItem_.
-    # Returns a reference to the newly added item (an FXTreeItem instance).
-    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
-    # target after the item is added.
-    def addItemFirst(parentItem, item, notify=false); end
-  
-    # Prepend a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_, as first child of _parentItem_.
+    #
+    # Fill tree list box by appending items from array of strings and return the
+    # number of items added.
+    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list box's
+    # message target after each item is added.
+    #
+    def fillItems(father, strings, oi=nil, ci=nil, ptr=nil); end
+
+    # Insert a new (possibly subclassed) _item_ under _father_ before _other_ item.
     # Returns a reference to the newly added item (an FXTreeItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemFirst(parentItem, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+    def insertItem(other, father, item, notify=false); end
   
-    # Append a new (possibly subclassed) _item_ as last child of _parentItem_.
+    # Insert item with given text and optional icons, and user-data pointer under _father_ before _other_ item. 
     # Returns a reference to the newly added item (an FXTreeItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemLast(parentItem, item, notify=false); end
-  
-    # Append a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_, as last child of _parentItem_.
+    def insertItem(other, father, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+
+    # Append a new (possibly subclassed) _item_ as last child of _father_.
     # Returns a reference to the newly added item (an FXTreeItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemLast(parentItem, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+    def appendItem(father, item, notify=false); end
   
-    # Append a new (possibly subclassed) _item_ after _otherItem_. 
+    # Append item with given text and optional icons, and user-data pointer as last child of _father_.
     # Returns a reference to the newly added item (an FXTreeItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemAfter(otherItem, item, notify=false); end
+    def appendItem(father, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
   
-    # Append a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_ after _otherItem_. 
+    # Prepend a new (possibly subclassed) _item_ as first child of _father_.
     # Returns a reference to the newly added item (an FXTreeItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemAfter(otherItem, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+    def prependItem(father, item, notify=false); end
   
-    # Prepend a new (possibly subclassed) _item_ prior to _otherItem_. 
+    # Prepend item with given text and optional icons, and user-data pointer as first child of _father_.
     # Returns a reference to the newly added item (an FXTreeItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemBefore(otherItem, item, notify=false); end
+    def prependItem(father, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
   
-    # Prepend a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_ prior to _otherItem_. 
-    # Returns a reference to the newly added item (an FXTreeItem instance).
-    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
-    # target after the item is added.
-    def addItemBefore(otherItem, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
-
     # Remove item.
     # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message
     # target before the item is removed.
@@ -124,10 +124,29 @@ module Fox
     # target before each item is removed.
     def clearItems(notify=false); end
 
-    # Search items for item by _text_, starting from _startItem_; the
-    # _flags_ argument controls the search direction, and case sensitivity.
-    # Returns a reference to the matching item, or +nil+ if no match is found.
-    def findItem(text, startItem=nil, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+    #
+    # Search items by name, beginning from item _start_.  If the
+    # start item is +nil+ the search will start at the first, top-most 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 +nil+ if no matching item is found.
+    #
+    def findItem(text, start=nil, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+
+    #
+    # Search items by associated user data, beginning from item _start_.  If the
+    # start item is +nil+ the search will start at the first, top-most 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 +nil+ if no matching item is found.
+    #
+    def findItemByData(ptr, start=nil, flags=SEARCH_FORWARD|SEARCH_WRAP); end
 
     # Return +true+ if item is current
     def itemCurrent?(item); end

data/rdoc-sources/FXWindow.rb

@@ -79,6 +79,8 @@ module Fox
   # +LAYOUT_FILL_X+::       Stretch or shrink horizontally
   # +LAYOUT_FILL_Y+::       Stretch or shrink vertically
   # +LAYOUT_EXPLICIT+::     Explicit placement
+  # +LAYOUT_DOCK_SAME+::    Dock on same galley, if it fits
+  # +LAYOUT_DOCK_NEXT+::    Dock on next galley
   #
   # === Frame border appearance styles (for subclasses)
   #
@@ -108,6 +110,7 @@ module Fox
   # +ID_DELETE+::               x
   # +ID_DISABLE+::              x
   # +ID_ENABLE+::               x
+  # +ID_TOGGLEENABLED+::        x
   # +ID_UNCHECK+::              x
   # +ID_CHECK+::                x
   # +ID_UNKNOWN+::              x
@@ -126,8 +129,6 @@ module Fox
   # +ID_GETSTRINGVALUE+::       x
   # +ID_GETINTRANGE+::          x
   # +ID_GETREALRANGE+::         x
-  # +ID_QUERY_TIP+::            x
-  # +ID_QUERY_HELP+::           x
   # +ID_QUERY_MENU+::           x
   # +ID_HOTKEY+::               x
   # +ID_ACCEL+::                x
@@ -361,6 +362,12 @@ module Fox
     # Return the common ancestor of window _a_ and window _b_.
     def FXWindow.commonAncestor(a, b); end
 
+    # Return +true+ if sibling _a_ comes before sibling _b_.
+    def FXWindow.before?(a, b); end
+
+    # Return +true+ if sibling _a_ comes after sibling _b_.
+    def FXWindow.after?(a, b); end
+
     # Return the number of existing windows.
     def FXWindow.windowCount; end
   
@@ -381,6 +388,9 @@ module Fox
   
     # Return +true+ if this window has the focus.
     def hasFocus?() ; end
+    
+    # Return +true+ if this window is in the focus chain.
+    def inFocusChain? ; end
   
     # Move the focus to this window.
     def setFocus(); end
@@ -388,6 +398,9 @@ module Fox
     # Remove the focus from this window.
     def killFocus(); end
   
+    # Notification that focus moved to a new child window.
+    def changeFocus(child); end
+
     # This changes the default window which responds to the *Enter*
     # key in a dialog. If _enable_ is +true+, this window becomes the default 
     # window; when _enable_ is +false+, this window will no longer be the
@@ -419,6 +432,15 @@ module Fox
     # Destroy the server-side resources for this window.
     def destroy(); end
   
+    #
+    # Set window shape, where _shape_ is either an FXRegion, FXBitmap or
+    # FXIcon instance.
+    #
+    def setShape(shape); end
+
+    # Clear window shape
+    def clearShape(); end
+
     # Raise this window to the top of the stacking order.
     def raiseWindow(); end
   
@@ -443,8 +465,8 @@ module Fox
     # Force a GUI update of this window and its children 
     def forceRefresh(); end
   
-    # Change the parent for this window to _newParent_.
-    def reparent(newParent); end
+    # Reparent this window under new _father_ window, after _other_ sibling..
+    def reparent(father, other); end
   
     # Scroll rectangle (_x_, _y_, _w_, _h_) by a shift of (_dx_, _dy_)
     def scroll(x, y, w, h, dx, dy); end
@@ -550,7 +572,10 @@ module Fox
 
     def handleDrag(x, y, action=DRAG_COPY) ; end
     
-    # Terminate the drag operation with or without actually dropping the data
+    #
+    # Terminate the drag operation with or without actually dropping the data.
+    # Return the action performed by the target.
+    #
     def endDrag(drop=true); end
     
     # Return +true+ if this window is the target of a drop
@@ -621,12 +646,6 @@ module Fox
     # coordinates in _toWindow_'s coordinate system.
     def translateCoordinatesTo(toWindow, fromX, fromY) ; end
  
-    # Relink this window before _sibling_ in the parent's window list.
-    def linkBefore(sibling) ; end
-    
-    # Relink this window after _sibling_ in the parent' window list.
-    def linkAfter(sibling) ; end
-    
     # Return +true+ if this window does save-unders.
     def doesSaveUnder?() ; end
   end

data/rdoc-sources/FXXBMIcon.rb

@@ -3,6 +3,11 @@ module Fox
   # X Bitmap (XBM) Icon
   #
   class FXXBMIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("xbm").
+    #
+    def FXXBMIcon.fileExt; end
+
     #
     # Return an initialized FXXBMIcon instance.
     #
@@ -19,4 +24,9 @@ module Fox
     def initialize(a, pixels=nil, mask=nil, clr=0, opts=0, w=1, h=1) # :yields: theXBMIcon
     end
   end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains an XBM image.
+  #
+  def Fox.fxcheckXBM(store); end
 end

data/rdoc-sources/FXXBMImage.rb

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

data/rdoc-sources/FXXPMIcon.rb

@@ -3,6 +3,11 @@ module Fox
   # X Pixmap (XPM) Icon
   #
   class FXXPMIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("xpm").
+    #
+    def FXXPMIcon.fileExt; end
+
     #
     # Return an initialized FXXPMIcon instance.
     #
@@ -30,7 +35,7 @@ module Fox
   #
   # +store+::	stream from which to read the file data [FXStream]
   #
-  def fxloadXPM(store); end
+  def Fox.fxloadXPM(store); end
 
   #
   # Save an XPM image to _store_ (an FXStream instance).
@@ -46,5 +51,10 @@ module Fox
   # +fast+::	if +true+, use fast something
   #
   def fxsaveXPM(store, data, transp, width, height, fast=true); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains an XPM image.
+  #
+  def Fox.fxcheckXPM(store); end
 end
 

data/rdoc-sources/FXXPMImage.rb

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

data/rdoc-sources/README.rdoc

@@ -1,6 +1,6 @@
 = Introduction
 
-<b>This is the RDoc-generated API documentation for FXRuby version 1.2.</b>
+<b>This is the RDoc-generated API documentation for FXRuby version 1.4.</b>
 If you have some constructive comments about the content, format or
 presentation, please do send those to me (at mailto:lyle@rubyforge.org).
 

data/tests/TC_FXBMPIcon.rb

@@ -0,0 +1,15 @@
+require 'fox12'
+require 'test/unit'
+require 'testcase'
+
+include Fox
+
+class TC_FXBMPIcon < TestCase
+  def setup
+    super(self.class.name)
+  end
+
+  def test_fileExt
+    assert_equal("bmp", FXBMPIcon.fileExt)
+  end
+end

data/tests/TC_FXBMPImage.rb

@@ -0,0 +1,15 @@
+require 'fox12'
+require 'test/unit'
+require 'testcase'
+
+include Fox
+
+class TC_FXBMPImage < TestCase
+  def setup
+    super(self.class.name)
+  end
+
+  def test_fileExt
+    assert_equal("bmp", FXBMPImage.fileExt)
+  end
+end

data/tests/TC_FXFont.rb

@@ -56,14 +56,4 @@ class TC_FXFont < Test::Unit::TestCase
     assert_instance_of(Array, fonts)
     assert(fonts.length > 0)
   end
-  
-  def test_hasChar?
-    @app.normalFont.create
-    assert(@app.normalFont.hasChar('a'))
-    assert(@app.normalFont.hasChar(?a))
-    assert(@app.normalFont.hasChar?('a'))
-    assert(@app.normalFont.hasChar?(?a))
-    assert_raises(ArgumentError) { @app.normalFont.hasChar? "" }
-    assert_raises(ArgumentError) { @app.normalFont.hasChar? "ab" }
-  end
 end

data/tests/TC_FXXBMIcon.rb

@@ -0,0 +1,15 @@
+require 'fox12'
+require 'test/unit'
+require 'testcase'
+
+include Fox
+
+class TC_FXXBMIcon < TestCase
+  def setup
+    super(self.class.name)
+  end
+
+  def test_fileExt
+    assert_equal("xbm", FXXBMIcon.fileExt)
+  end
+end

data/tests/TC_FXXBMImage.rb

@@ -0,0 +1,15 @@
+require 'fox12'
+require 'test/unit'
+require 'testcase'
+
+include Fox
+
+class TC_FXXBMImage < TestCase
+  def setup
+    super(self.class.name)
+  end
+
+  def test_fileExt
+    assert_equal("xbm", FXXBMImage.fileExt)
+  end
+end

data/tests/TC_FXXPMIcon.rb

@@ -0,0 +1,15 @@
+require 'fox12'
+require 'test/unit'
+require 'testcase'
+
+include Fox
+
+class TC_FXXPMIcon < TestCase
+  def setup
+    super(self.class.name)
+  end
+
+  def test_fileExt
+    assert_equal("xpm", FXXPMIcon.fileExt)
+  end
+end

data/tests/TC_FXXPMImage.rb

@@ -0,0 +1,15 @@
+require 'fox12'
+require 'test/unit'
+require 'testcase'
+
+include Fox
+
+class TC_FXXPMImage < TestCase
+  def setup
+    super(self.class.name)
+  end
+
+  def test_fileExt
+    assert_equal("xpm", FXXPMImage.fileExt)
+  end
+end

data/web/downloads.html

@@ -20,7 +20,9 @@ project page</a>. The RubyForge releases should always have accompanying
 release notes describing the changes for that release. A cumulative
 <tt>ChangeLog</tt> file is also included in the FXRuby source code distribution.
 
-As of the FOX 1.0 release, any FXRuby version 1.0.x release should be compatible with any FOX 1.0.x release. Similarly, any FXRuby 1.2.x release should be compatible with any FOX 1.2.x release.<p>
+As of the FOX 1.0 release, any FXRuby version 1.0.x release should be compatible with any FOX 1.0.x release.
+Similarly, any FXRuby 1.2.x release should be compatible with any FOX 1.2.x release, and
+any FXRuby 1.4.x release should be compatible with any FOX 1.4.x release.<p>
 </blockquote>
 
 <!--- TOPIC TITLE -->

data/web/home.html

@@ -30,7 +30,9 @@ Versions
 </p>
 <!--- TOPIC TITLE -->
 <blockquote>
-As of the FOX 1.0 release, any FXRuby version 1.0.x release should be compatible with any FOX 1.0.x release. Similarly, any FXRuby version 1.2.x release should be compatible with any FOX 1.2.x release.<p>
+As of the FOX 1.0 release, any FXRuby version 1.0.x release should be compatible with any FOX 1.0.x release.
+Similarly, any FXRuby version 1.2.x release should be compatible with any FOX 1.2.x release,
+and any FXRuby version 1.4.x release should be compatible with any FOX 1.4.x release.<p>
 </blockquote>