fxruby 1.4.7 → 1.6.0

data/rdoc-sources/FXScrollBar.rb

@@ -4,9 +4,12 @@ module Fox
   # visible.  The range is the total size of the document, the page is the part
   # of the document which is visible.  The size of the scrollbar thumb is adjusted
   # to give feedback of the relative sizes of each.
-  # The scroll bar may be manipulated by the left mouse (normal scrolling), right
-  # mouse (vernier or fine-scrolling), or middle mouse (same as the left mouse only
-  # the scroll position can hop to the place where the click is made).
+  # The scroll bar may be manipulated by the left mouse button (normal scrolling), by the
+  # middle mouse button (same as the left mouse only the scroll position can jump to the 
+  # place where the click is made), or by the right mouse button (vernier- or fine-scrolling).
+  # Holding down the control key while scrolling with the left or middle mouse button also 
+  # enables vernier-scrolling mode.  The vernier-scrolling mode is very useful for accurate
+  # positioning in large documents.
   # Finally, if the mouse sports a wheel, the scroll bar can be manipulated by means
   # of the mouse wheel as well.  Holding down the Control-key during wheel motion
   # will cause the scrolling to go faster than normal.
@@ -67,6 +70,9 @@ module Fox
 
     # Scroll bar style [Integer]
     attr_accessor :scrollbarStyle
+    
+    # Bar size [Integer]
+    attr_accessor :barSize
 
     #
     # Return an initialized FXScrollBar instance.

data/rdoc-sources/FXScrollPane.rb

@@ -8,6 +8,9 @@ module Fox
 
     # Index of top-most menu item [Integer]
     attr_accessor :topItem
+    
+    # Number of visible items [Integer]
+    attr_accessor :numVisible
 
     #
     # Return an initialized FXScrollPane instance.

data/rdoc-sources/FXSettings.rb

@@ -3,6 +3,8 @@ module Fox
   # The Settings class manages a key-value database.  This is normally used as
   # part of Registry, but can also be used separately in applications that need
   # to maintain a key-value database in a file of their own.
+  # String values can contain any character, and will be escaped when written
+  # to the file.
   #
   class FXSettings < FXDict
     #
@@ -109,6 +111,18 @@ module Fox
     #
     def readColorEntry(section, key, default=0) ; end
 
+    #
+    # Read a boolean valued registry entry from the specified _section_ and _key_.
+    # If no value is found, the _default_ value is returned.
+    #
+    # ==== Parameters:
+    #
+    # +section+::	the section name [String]
+    # +key+::		the key for the setting of interest [String]
+    # +default+::	the default value to return if _key_ is not found [true or false]
+    #
+    def readBoolEntry(section, key, default=false) ; end
+
     #
     # Write a string registry _value_ to the specified _section_ and _key_.
     # Returns true on success, false otherwise.
@@ -169,6 +183,18 @@ module Fox
     #
     def writeColorEntry(section, key, value) ; end
 
+    #
+    # Write a boolean registry _value_ to the specified _section_ and _key_.
+    # Returns true on success, false otherwise.
+    #
+    # ==== Parameters:
+    #
+    # +section+::	the section name [String]
+    # +key+::		the key for this setting [String]
+    # +value+::		the value for this setting [true or false]
+    #
+    def writeBoolEntry(section, key, value) ; end
+
     #
     # Delete the registry entry for the specified _section_ and _key_.
     # Returns true on success, false otherwise.

data/rdoc-sources/FXSize.rb

@@ -25,6 +25,71 @@ module Fox
     # _hh_ are the initial width and height.
     #
     def initialize(ww, hh); end
+    
+    # Return +true+ if width or height is less than or equal to zero.
+    def empty?; end
+    
+    #
+    # Grow the rectangle by some amount and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +margin+::	number of units to grow on each side [Integer]
+    #
+    def grow!(margin); end
+
+    #
+    # Grow the rectangle by some amount and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +hormargin+::	number of units to grow on the left and right sides [Integer]
+    # +vermargin+::	number of units to grow on the top and bottom sides [Integer]
+    #
+    def grow!(hormargin, vermargin); end
+
+    #
+    # Grow the rectangle by some amount and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +leftmargin+::	number of units to grow on the left side [Integer]
+    # +rightmargin+::	number of units to grow on the right side [Integer]
+    # +topmargin+::	number of units to grow on the top side [Integer]
+    # +bottommargin+::	number of units to grow on the bottom side [Integer]
+    #
+    def grow!(leftmargin, rightmargin, topmargin, bottommargin); end
+  
+    #
+    # Shrink the rectangle by _margin_ units, and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +margin+::	number of units to shrink on each side [Integer]
+    #
+    def shrink!(margin); end
+
+    #
+    # Shrink the rectangle by some amount, and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +hormargin+::	number of units to shrink on the left and right sides [Integer]
+    # +vermargin+::	number of units to shrink on the top and bottom sides [Integer]
+    #
+    def shrink!(hormargin, vermargin); end
+
+    #
+    # Shrink the rectangle by some amount, and return a reference to the rectangle.
+    #
+    # ==== Parameters:
+    #
+    # +leftmargin+::	number of units to shrink on the left side [Integer]
+    # +rightmargin+::	number of units to shrink on the right side [Integer]
+    # +topmargin+::	number of units to shrink on the top side [Integer]
+    # +bottommargin+::	number of units to shrink on the bottom side [Integer]
+    #
+    def shrink!(leftmargin, rightmargin, topmargin, bottommargin); end
   end
 end
 

data/rdoc-sources/FXSlider.rb

@@ -9,6 +9,8 @@ module Fox
   #
   # The following messages are sent by FXSlider 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.

data/rdoc-sources/FXSphered.rb

@@ -45,9 +45,18 @@ module Fox
     # Include the point _p_ (an FXVec3d instance) and return a reference to self.
     def include!(p); end
     
+    # Expand radius to include point and return a reference to self.
+    def includeInRadius!(x, y, z); end
+
+    # Expand radius to include point (an FXVec3d instance) and return a reference to self.
+    def includeInRadius!(p); end
+    
     # Include the range _box_ (an FXRanged instance) into this sphere and return self.
     def include!(box); end
     
+    # Expand radius to include box (an FXRanged instance) and return a reference to self.
+    def includeInRadius!(box);
+
     # Include the sphere _sphere_ (an FXSphered instance) into this sphere and return self.
     def include!(sphere); end
     
@@ -55,6 +64,9 @@ module Fox
     # Here, _plane_ is an FXVec4d instance describing the plane.
     def intersect(plane); end
     
+    # Expand radius to include sphere (an FXSphered instance) and return self.
+    def includeInRadius!(sphere); end
+    
     # Return +true+ if this sphere intersects the ray between points _u_ and _v_
     # (both FXVec3d instances).
     def intersects?(u, v); end

data/rdoc-sources/FXSpheref.rb

@@ -45,12 +45,24 @@ module Fox
     # Include the point _p_ (an FXVec3f instance) and return a reference to self.
     def include!(p); end
     
+    # Expand radius to include point and return a reference to self.
+    def includeInRadius!(x, y, z); end
+
+    # Expand radius to include point (an FXVec3f instance) and return a reference to self.
+    def includeInRadius!(p); end
+
     # Include the range _box_ (an FXRangef instance) into this sphere and return self.
     def include!(box); end
     
+    # Expand radius to include box (an FXRangef instance) and return a reference to self.
+    def includeInRadius!(box);
+
     # Include the sphere _sphere_ (an FXSpheref instance) into this sphere and return self.
     def include!(sphere); end
     
+    # Expand radius to include sphere (an FXSpheref instance) and return self.
+    def includeInRadius!(sphere); end
+    
     # Intersect this sphere with the plane <em>ax+by+cz+w</em> and return -1, 0 or +1.
     # Here, _plane_ is an FXVec4f instance describing the plane.
     def intersect(plane); end

data/rdoc-sources/FXSpinner.rb

@@ -8,8 +8,6 @@ module Fox
   #
   # +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_COMMAND+::
   #   sent whenever the spinner's value changes; the message data is an integer
   #   indicating the new spinner value.
@@ -94,10 +92,16 @@ module Fox
     end
   
     # Increment spinner
-    def increment(); end
+    def increment(notify=FALSE); end
+    
+    # Increment spinner by certain amount
+    def incrementByAmount(amt, notify=false); end
   
     # Decrement spinner
-    def decrement(); end
+    def decrement(notify=FALSE); end
+    
+    # Decrement spinner by certain amount
+    def decrementByAmount(amt, notify=false); end
   
     # Return +true+ if the spinner is in cyclic mode.
     def cyclic?; end

data/rdoc-sources/FXTGAIcon.rb

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

data/rdoc-sources/FXTGAImage.rb

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

data/rdoc-sources/FXTIFIcon.rb

@@ -8,6 +8,11 @@ module Fox
     #
     def FXTIFIcon.fileExt; end
 
+    #
+    # Return the MIME type for this image type
+    #
+    def FXTIFIcon.mimeType; end
+
     # Return +true+ if TIF image file format is supported.
     def FXTIFIcon.supported? ; end
 

data/rdoc-sources/FXTIFImage.rb

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

data/rdoc-sources/FXTabBar.rb

@@ -5,6 +5,9 @@ module Fox
   # In a the horizontal arrangement, the tab bar can have the tab
   # items on the top or on the bottom.  In the vertical arrangement,
   # the tabs can be on the left or on the right.
+  # When one of the tab items is pressed, the tab bar's #setCurrent()
+  # method is called with _notify_ of +true+. This in turn causes the tab bar
+  # to send a +SEL_COMMAND+ message to its target.
   #
   # === Events
   #
@@ -67,7 +70,8 @@ module Fox
     end
 
     #
-    # Set the current tab item to the one at _index_.
+    # Change currently active tab item; this raises the active tab item 
+    # slightly above the neighboring tab items.
     # If _notify_ is +true+, a +SEL_COMMAND+ message is sent to the tab bar's message target
     #
     def setCurrent(index, notify=false); end

data/rdoc-sources/FXTabBook.rb

@@ -11,6 +11,9 @@ module Fox
   # Thus, a tab book can be used to present many GUI controls
   # in a small space by placing several panels on top of each
   # other and using tab items to select the desired panel.
+  # When one of the tab items is pressed, the tab book's #setCurrent method
+  # is called with _notify+=true. This causes the tab book to send a
+  # +SEL_COMMAND+ message to its target.
   #
   class FXTabBook < FXTabBar
     #

data/rdoc-sources/FXTabItem.rb

@@ -7,6 +7,13 @@ module Fox
   # In the tab book, activating a tab item also causes
   # the corresponding panel to be raised to the top.
   #
+  # === Events
+  #
+  # The following messages are sent by FXTabItem 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.
+  #
   # === Tab item orientations (which affect border)
   #
   # +TAB_TOP+::			Top side tabs

data/rdoc-sources/FXTable.rb

@@ -185,6 +185,8 @@ module Fox
   # +TABLE_NO_COLSELECT+::	Disallow column selections
   # +TABLE_NO_ROWSELECT+::	Disallow row selections
   # +TABLE_READONLY+::		Table is not editable
+  # +TABLE_COL_RENUMBER+::	Renumber columns
+  # +TABLE_ROW_RENUMBER+::	Renumber rows
   #
   # === Message identifiers
   #
@@ -224,6 +226,9 @@ module Fox
 
   class FXTable < FXScrollArea
 
+    # Button in the upper left corner [FXButton]
+    attr_reader :cornerButton
+    
     # Column header control [FXHeader]
     attr_reader :columnHeader
     
@@ -269,6 +274,12 @@ module Fox
     # attribute.
     attr_accessor	:rowHeaderMode
     
+    # Row header font [FXFont]
+    attr_accessor	:rowHeaderFont
+    
+    # Column header font [FXFont]
+    attr_accessor	:columnHeaderFont
+    
     # The fixed column header height, if _columnHeaderMode_ is +LAYOUT_FIX_HEIGHT+.
     attr_accessor	:columnHeaderHeight
     
@@ -506,6 +517,14 @@ module Fox
     #
     def removeColumns(column, nc=1, notify=false) ; end
     
+    #
+    # Extract item from table and return a reference to it.
+    # If _notify_ is +true+, a +SEL_REPLACED+ message is sent to the table's
+    # message target before this cell is removed.
+    # Raises IndexError if either _row_ or _col_ is out of bounds.
+    #
+    def extractItem(r, c, notify=false); end
+    
     #
     # Remove item at (_row_, _col_), replacing it with +nil+.
     # If _notify_ is +true+, a +SEL_REPLACED+ message is sent to the table's
@@ -530,14 +549,8 @@ module Fox
     #
     def clearItems(notify=false); end
 
-    #
     # Scroll to make cell at (_row_, _column_) fully visible.
-    # If the input value for _row_ is out of bounds (i.e. is less than zero,
-    # or greater than or equal to the numbers of rows), the call to
-    # #makePositionVisible will have no effect on the horizontal position.
-    # Likewise, if the input value for _column_ is out of bounds,
-    # the call will have no effect on the vertical position.
-    #
+    # Raises IndexError if either _row_ or _column_ is out of bounds.
     def makePositionVisible(row, column) ; end
   
     # Returns +true+ if the cell at position (_row_, _column_) is visible.
@@ -607,18 +620,62 @@ module Fox
     
     # Return text of row header at _index_.
     def getRowText(index); end
+
+    # Change column header icon
+    def setColumnIcon(FXint index,FXIcon* icon);
+
+    # Return icon of column header at index
+    def getColumnIcon(index); end
+
+    # Change row header icon
+    def setRowIcon(index, icon); end
     
-    # Modify cell text for item at specified _row_ and _column_.
-    # Raises IndexError if either _row_ or _column_ is out of bounds.
-    def setItemText(row, column, text) ; end
+    # Return icon of row header at index
+    def getRowIcon(index); end
+
+    # Change column header icon position, e.g. FXHeaderItem::BEFORE, etc.
+    def setColumnIconPosition(index, mode); end
+
+    # Return icon position of column header at index
+    def getColumnIconPosition(index); end
+
+    # Change row header icon position, e.g. FXHeaderItem::BEFORE, etc.
+    def setRowIconPosition(index, mode); end
+
+    # Return icon position of row header at index
+    def getRowIconPosition(index); end
+    
+    # Change column header justify, e.g. FXHeaderItem::RIGHT, etc.
+    def setColumnJustify(index, justify); end
+
+    # Return justify of column header at index
+    def getColumnJustify(index); end
+
+    # Change row header justify, e.g. FXHeaderItem::RIGHT, etc.
+    def setRowJustify(index, justify); end
+
+    # Return justify of row header at index
+    def getRowJustify(index); end
+    
+    #
+    # Modify cell text for item at specified _row_ and _col_.
+    # If _notify_ is +true+, a +SEL_REPLACED+ message is sent to the table's
+    # message target before the item's text is changed..
+    # Raises IndexError if either _row_ or _col_ is out of bounds.
+    #
+    def setItemText(row, col, text, notify=false) ; end
 
     # Return cell text for item at specified _row_ and _column_.
     # Raises IndexError if either _row_ or _column_ is out of bounds.
     def getItemText(row, column) ; end
 
+    #
     # Modify cell icon, deleting the old icon if it was owned.
-    # Raises IndexError if either _row_ or _column_ is out of bounds.
-    def setItemIcon(row, column, icon) ; end
+    # If _notify_ is +true+, a +SEL_REPLACED+ message is sent to the table's
+    # message target before the item's icon is changed..
+    # Raises IndexError if either _row_ or _col_ is out of bounds.
+    #
+    def setItemIcon(row, col, icon, notify=false) ; end
 
     # Return item icon.
     # Raises IndexError if either _row_ or _column_ is out of bounds.
@@ -636,8 +693,8 @@ module Fox
     # Extract the text from all the cells in the specified range and
     # return the result as a string.
     # Within the result string, each column's text is delimited by
-    # the character specified by _cs_, and each row is delimited by
-    # the character specified by _rs_.
+    # the string specified by _cs_, and each row is delimited by
+    # the string specified by _rs_.
     # To reverse this operation (i.e. set the table cells' text
     # from a string), see #overlayText.
     # Raises IndexError if any of _startrow_, _endrow_, _startcol_
@@ -649,10 +706,10 @@ module Fox
     # +endrow+::	the ending row for the range [Integer]
     # +startcol+::	the starting column for the range [Integer]
     # +endcol+::	the ending column for the range [Integer]
-    # +cs+::		the character to insert at each column break [String]
-    # +rs+::		the character to insert at each row break [String]
+    # +cs+::		the string to insert at each column break [String]
+    # +rs+::		the string to insert at each row break [String]
     #
-    def extractText(startrow, endrow, startcol, endcol, cs='\t', rs='\n'); end
+    def extractText(startrow, endrow, startcol, endcol, cs="\t", rs="\n"); end
     
     #
     # Overlay the text for the cells in the specified range with
@@ -675,8 +732,17 @@ module Fox
     # +cs+::		the character to insert at each column break [String]
     # +rs+::		the character to insert at each row break [String]
     #
-    def overlayText(startrow, endrow, startcol, endcol, text, cs='\t', rs='\n'); end
+    def overlayText(startrow, endrow, startcol, endcol, text, cs="\t", rs="\n", notify=false); end
     
+    #
+    # Determine the number of rows and columns in a block of text
+    # where columns are separated by characters from the set _cs_, and rows
+    # are separated by characters from the set _rs_.
+    # Return a two-element array containing the number of rows and
+    # columns, respectively.
+    #
+    def countText(text, cs="\t,", rs="\n"); end
+
     # Return +true+ if the cell at position (_r_, _c_) is a spanning cell.
     # Raises IndexError if either _r_ or _c_ is out of bounds.
     def itemSpanning?(r, c); end
@@ -849,6 +915,18 @@ module Fox
     
     # Draw a range of cells
     def drawRange(dc, xlo, xhi, ylo, yhi, xoff, yoff, rlo, rhi, clo, chi) ; end
+    
+    # Set column renumbering to +true+ or +false+.
+    def columnRenumbering=(renumber); end
+    
+    # Get column renumbering
+    def columnRenumbering? ; end
+    
+    # Set row renumbering to +true+ or +false+.
+    def rowRenumbering=(renumber); end
+    
+    # Get row renumbering
+    def rowRenumbering? ; end
   end
 end