fxruby 1.2.6 → 1.4.0

data/rdoc-sources/FXRGBIcon.rb

@@ -3,6 +3,11 @@ module Fox
   # Iris RGB Icon
   #
   class FXRGBIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("rgb").
+    #
+    def FXRGBIcon.fileExt; end
+
     #
     # Return an initialized FXRGBIcon instance.
     #
@@ -29,7 +34,7 @@ module Fox
   #
   # +store+::	stream from which to read the file data [FXStream]
   #
-  def fxloadRGB(store); end
+  def Fox.fxloadRGB(store); end
 
   #
   # Save a RGB image to a stream.
@@ -44,6 +49,11 @@ module Fox
   # +width+::	width [Integer]
   # +height+::	height [Integer]
   #
-  def fxsavePNG(store, data, transp, width, height); end
+  def Fox.fxsaveRGB(store, data, transp, width, height); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a RGB image.
+  #
+  def Fox.fxcheckRGB(store); end
 end
 

data/rdoc-sources/FXRGBImage.rb

@@ -3,6 +3,11 @@ module Fox
   # Iris RGB Image
   #
   class FXRGBImage < FXImage
+    #
+    # Return the suggested file extension for this image type ("rgb").
+    #
+    def FXRGBImage.fileExt; end
+
     #
     # Return an initialized FXRGBImage instance.
     #

data/rdoc-sources/FXRegistry.rb

@@ -1,7 +1,24 @@
 module Fox
   #
-  # The registry maintains a database of persistent settings for an application,
-  # or suite of applications.
+  # The registry maintains a database of persistent settings for an application.
+  # The settings database is organized in two groups of three layers each.  The
+  # system-wide settings group contains settings information pertaining to all
+  # users on a system.  The per-user settings group contains settings affecting
+  # that user only.
+  # Each settings group contains a desktop layer, which comprises the settings
+  # which affect all FOX programs, a vendor layer which holds settings that
+  # affect all applications from that vendor (e.g. a application-suite), and
+  # an application layer which holds settings only for a single application.
+  # The vendor-key and application-key determine which files these layers come
+  # from, while the "Desktop" key is used for all FOX applications.
+  # Settings in the system-wide group are overwritten by the per-user group,
+  # and settings from the "Desktop" layer are overwritten by the vendor-layer;
+  # vendor-layer settings are overwritten by the application-layer settings.
+  # Only the per-user, per-application settings ever gets written; the layers
+  # in the system-group only get written during installation and configuration
+  # of the application.
+  # The registry is read when FXApp::init() is called, and written back to the
+  # system when FXApp::exit() is called.
   #
   class FXRegistry < FXSettings
 

data/rdoc-sources/FXRuler.rb

@@ -1,13 +1,16 @@
 module Fox
   #
-  # An FXRuler widget can be placed alongside a document to measure position
-  # and size of entities within the document.
+  # The ruler widget is placed alongside a document to measure position
+  # and size of entities within the document, such as margins, paragraph
+  # indents, and tickmarks.
+  # The ruler widget sends a +SEL_CHANGED+ message when the indentation or margins
+  # are interactively changed by the user.
   #
   # === Events
   #
   # The following messages are sent by FXRuler to its target:
   #
-  # +SEL_LEFTBUTTONPRESS+::		sent when the left mouse button goes down; 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.
   #
   # === Ruler options
@@ -22,17 +25,56 @@ module Fox
   # +RULER_TICKS_RIGHT+::	Ticks on the right (if vertical)
   # +RULER_TICKS_CENTER+::	Tickmarks centered
   # +RULER_NUMBERS+::		Show numbers
-  # +RULER_ARROW+::			Draw small arrow for cursor position
+  # +RULER_ARROW+::		Draw small arrow for cursor position
   # +RULER_MARKERS+::		Draw markers for indentation settings
   # +RULER_METRIC+::		Metric subdivision (default)
   # +RULER_ENGLISH+::		English subdivision
   #
   # === Message identifiers:
   #
-  # +ID_ARROW+::			write me
+  # +ID_ARROW+::		write me
   #
   class FXRuler < FXFrame
   
+    # Current position [Integer]
+    attr_accessor :position
+    
+    # Document size [Integer]
+    attr_accessor :documentSize
+  
+    # Document size [Integer]
+    attr_accessor :edgeSpacing
+    
+    # Lower document margin [Integer]
+    attr_accessor :marginLower
+
+    # Upper document margin [Integer]
+    attr_accessor :marginUpper
+    
+    # First line indent [Integer]
+    attr_accessor :indentFirst
+    
+    # Lower indent [Integer]
+    attr_accessor :indentLower
+    
+    # Upper indent [Integer]
+    attr_accessor :indentUpper
+    
+    # Document number placement [Integer]
+    attr_accessor :numberTicks
+
+    # Document major ticks [Integer]
+    attr_accessor :majorTicks
+
+    # Document minor ticks [Integer]
+    attr_accessor :minorTicks
+
+    # Document tiny ticks [Integer]
+    attr_accessor :tinyTicks
+
+    # Pixels per tick spacing [Float]
+    attr_accessor :pixelsPerTick
+    
     # The text font [FXFont]
     attr_accessor :font
     

data/rdoc-sources/FXScrollArea.rb

@@ -44,11 +44,11 @@ module Fox
     # Scroll style [Integer]
     attr_accessor :scrollStyle
     
-    # Horizontal scrollbar [FXScrollBar]
-    attr_reader	:horizontalScrollBar
+    # Horizontal scrollbar [FXScrollbar]
+    attr_reader	:horizontalScrollbar
     
-    # Vertical scrollbar [FXScrollBar]
-    attr_reader	:verticalScrollBar
+    # Vertical scrollbar [FXScrollbar]
+    attr_reader	:verticalScrollbar
     
     # Current x-position [Integer]
     attr_reader	:xPosition

data/rdoc-sources/FXScrollPane.rb

@@ -1,6 +1,8 @@
 module Fox
   #
-  # Scrolling menu pane.
+  # A Scroll Pane is a menu pane which provides scrolling of menu entries.
+  # It is useful when menus are populated programmatically and it is not
+  # known in advance how many entries will be added.
   #
   class FXScrollPane < FXMenuPane
 

data/rdoc-sources/FXSeparator.rb

@@ -1,6 +1,10 @@
 module Fox
   #
-  # Horizontal separator
+  # A Separator widget is used to draw a horizontal or vertical divider between
+  # groups of controls.  It is purely decorative.  The separator may be drawn
+  # in various styles as determined by the SEPARATOR_NONE, SEPARATOR_GROOVE,
+  # SEPARATOR_RIDGE, and SEPARATOR_LINE options.  Since its derived from Frame,
+  # it can also have the frame's border styles.
   #
   # === Separator options
   #
@@ -9,7 +13,20 @@ module Fox
   # +SEPARATOR_RIDGE+::		Embossed looking ridge
   # +SEPARATOR_LINE+::		Simple line
   #
-  class FXHorizontalSeparator < FXFrame
+  class FXSeparator < FXFrame
+
+    # Separator style, one of SEPARATOR_NONE, SEPARATOR_GROOVE, SEPARATOR_RIDGE or SEPARATOR_LINE [Integer]
+    attr_accessor :separatorStyle
+
+    # Return an initialized FXSeparator instance.
+    def initialize(p, opts=SEPARATOR_GROOVE|LAYOUT_FILL_X, x=0, y=0, w=0, h=0, pl=0, pr=0, pt=0, pb=0) # :yields: theSeparator
+    end
+  end
+    
+  #
+  # Horizontal separator
+  #
+  class FXHorizontalSeparator < FXSeparator
     #
     # Return an initialized FXHorizontalSeparator instance.
     #
@@ -33,14 +50,7 @@ module Fox
   #
   # Vertical separator
   #
-  # === Separator options
-  #
-  # +SEPARATOR_NONE+::		Nothing visible
-  # +SEPARATOR_GROOVE+::	Etched-in looking groove
-  # +SEPARATOR_RIDGE+::		Embossed looking ridge
-  # +SEPARATOR_LINE+::		Simple line
-  #
-  class FXVerticalSeparator < FXFrame
+  class FXVerticalSeparator < FXSeparator
     #
     # Return an initialized FXVerticalSeparator instance.
     #

data/rdoc-sources/FXSettings.rb

@@ -1,8 +1,8 @@
 module Fox
   #
-  # FXSettings is a key-value database.  This is normally used as
-  # part of FXRegistry, but can also be used separately in application
-  # that need to maintain a key-value database of their own.
+  # 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.
   #
   class FXSettings < FXDict
     #

data/rdoc-sources/FXShell.rb

@@ -1,6 +1,7 @@
 module Fox
   #
-  # A child of the root window
+  # The Shell widget is used as the base class for top level windows, i.e.
+  # windows which are direct children of the root window.
   #
   class FXShell < FXComposite
   end

data/rdoc-sources/FXShutter.rb

@@ -1,6 +1,9 @@
 module Fox
   #
-  # Shutter item
+  # A Shutter Item is a panel which is embedded inside a Shutter Widget.
+  # It can contain other user interface widgets which can be added under
+  # the content widget.  The content widget is itself embedded in a scroll
+  # window to allow unlimited room for all the contents.
   #
   # === Message identifiers
   #
@@ -46,7 +49,9 @@ module Fox
   end
 
   #
-  # Shutter control
+  # The Shutter widget provides a set of foldable sub panels.  Each subpanel
+  # consists of a Shutter Item which contains a button and some contents.
+  # A sub panel can be unfolded by pressing on that panel's button.
   #
   # === Events
   #

data/rdoc-sources/FXSphered.rb

@@ -1,4 +1,7 @@
 module Fox
+  #
+  # Spherical bounds
+  #
   class FXSphered
     # Sphere center [FXVec3d]
     attr_accessor :center
@@ -13,10 +16,10 @@ module Fox
     def initialize(otherSphere); end
     
     # Initialize from center and radius
-    def initialize(cen, rad); end
+    def initialize(cen, rad=0.0); end
     
     # Initialize from center (_x_, _y_, _z_) and radius (_rad_).
-    def initialize(x, y, z, rad); end
+    def initialize(x, y, z, rad=0.0); end
     
     # Initialize sphere to fully contain the given bounding box (an FXRanged instance).
     def initialize(bounds); end

data/rdoc-sources/FXSpheref.rb

@@ -1,4 +1,7 @@
 module Fox
+  #
+  # Spherical bounds
+  #
   class FXSpheref
     # Sphere center [FXVec3f]
     attr_accessor :center
@@ -13,10 +16,10 @@ module Fox
     def initialize(otherSphere); end
     
     # Initialize from center and radius
-    def initialize(cen, rad); end
+    def initialize(cen, rad=0.0); end
     
     # Initialize from center (_x_, _y_, _z_) and radius (_rad_).
-    def initialize(x, y, z, rad); end
+    def initialize(x, y, z, rad=0.0); end
     
     # Initialize sphere to fully contain the given bounding box (an FXRangef instance).
     def initialize(bounds); end

data/rdoc-sources/FXSplashWindow.rb

@@ -0,0 +1,31 @@
+module Fox
+  #
+  # The Splash Window is a window typically shown during startup
+  # of an application.  It comprises a large icon, which is also
+  # used as the shape of the window if +SPLASH_SHAPED+ is passed;
+  # with the +SPLASH_SIMPLE+ option the window will be simply rectangular.
+  #
+  # === Splash window options
+  #
+  # +SPLASH_SIMPLE+::		Simple rectangular splash window
+  # +SPLASH_SHAPED+::		Shaped splash window
+  # +SPLASH_OWNS_ICON+::	Splash window will own the icon and destroy it
+  # +SPLASH_DESTROY+::		Splash window will destroy itself when timer expires
+  #
+  class FXSplashWindow < FXTopWindow
+    # The splash window's icon [FXIcon]
+    attr_accessor :icon
+    
+    # The delay before hiding the splash window, in milliseconds [Integer]
+    attr_accessor :delay
+
+    # Construct splash window
+    def initialize(app, ic, opts=SPLASH_SIMPLE, ms=5000) # :yields: theSplashWindow
+    end
+
+    # Construct splash window
+    def initialize(ow, ic, opts=SPLASH_SIMPLE, ms=5000) # :yields: theSplashWindow
+    end
+  end
+end
+

data/rdoc-sources/FXSplitter.rb

@@ -2,7 +2,8 @@ module Fox
   #
   # A splitter window is used to interactively repartition
   # two or more subpanels.
-  # The space may be subdivided horizontally or vertically.
+  # Space may be subdivided horizontally (+SPLITTER_HORIZONTAL+, which
+  # the default) or vertically (+SPLITTER_VERTICAL+ option).
   # When the splitter is itself resized, the right-most (or bottom-most)
   # child window will be resized unless the splitter window is _reversed_;
   # if the splitter is reversed, the left-most (or top-most) child window

data/rdoc-sources/FXStream.rb

@@ -108,8 +108,17 @@ module Fox
     # Returns +true+ if bytes are swapped for this stream
     def bytesSwapped?; end
   
-    # Returns +true+ if little-endian architecture
-    def FXStream.littleEndian?; end
+    #
+    # Set stream to big endian mode if +true+. Byte swapping will
+    # be enabled if the machine native byte order is not equal to
+    # the desired byte order.
+    #
+    def bigEndian=(big); end
+
+    #
+    # Return +true+ if big endian mode.
+    #
+    def bigEndian?; end
   end
 end
 

data/rdoc-sources/FXTGAIcon.rb

@@ -3,6 +3,11 @@ module Fox
   # Targa Icon
   #
   class FXTGAIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("tga").
+    #
+    def FXTGAIcon.fileExt; end
+
     #
     # Return an initialized FXTGAIcon instance.
     #
@@ -29,7 +34,7 @@ module Fox
   #
   # +store+::	stream from which to read the file data [FXStream]
   #
-  def fxloadTGA(store); end
+  def Fox.fxloadTGA(store); end
 
   #
   # Save a Targa image to a stream.
@@ -43,6 +48,11 @@ module Fox
   # +width+::		width [Integer]
   # +height+::		height [Integer]
   #
-  def fxsaveTGA(store, data, channels, width, height); end
+  def Fox.fxsaveTGA(store, data, channels, width, height); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a TGA image.
+  #
+  def Fox.fxcheckTGA(store); end
 end
 

data/rdoc-sources/FXTGAImage.rb

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

data/rdoc-sources/FXTIFIcon.rb

@@ -3,6 +3,14 @@ module Fox
   # Tagged Image File Format (TIFF) Icon
   #
   class FXTIFIcon < FXIcon
+    #
+    # Return the suggested file extension for this image type ("tif").
+    #
+    def FXTIFIcon.fileExt; end
+
+    # Return +true+ if TIF image file format is supported.
+    def FXTIFIcon.supported? ; end
+
     # Codec setting [Integer]
     attr_accessor :codec
 
@@ -32,7 +40,7 @@ module Fox
   #
   # +store+::	stream from which to read the file data [FXStream]
   #
-  def fxloadTIF(store); end
+  def Fox.fxloadTIF(store); end
 
   #
   # Save a TIFF image to a stream.
@@ -47,6 +55,11 @@ module Fox
   # +height+::	height [Integer]
   # +codec+::	codec setting [Integer]
   #
-  def fxsaveTIF(store, data, transp, width, height, codec); end
+  def Fox.fxsaveTIF(store, data, transp, width, height, codec); end
+  
+  #
+  # Return +true+ if _store_ (an FXStream instance) contains a TIFF image.
+  #
+  def Fox.fxcheckTIF(store); end
 end