fxruby 1.6.13-mswin32

data/rdoc-sources/FXSettings.rb

@@ -0,0 +1,248 @@
+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
+    #
+    # Return an initialized FXSettings instance.
+    #
+    def initialize # :yields: theSettings
+    end
+
+    #
+    # Parse a file containing a settings database.
+    # Returns true on success, false otherwise.
+    #
+    def parseFile(filename, mark); end
+
+    #
+    # Unparse settings database into given file.
+    # Returns true on success, false otherwise.
+    #
+    def unparseFile(filename) ; end
+
+    #
+    # Obtain the string dictionary (an FXStringDict instance) for the requested section number.
+    #
+    # ==== Parameters:
+    #
+    # +pos+::	the section number of interest [Integer]
+    #
+    def data(pos) ; end
+
+    #
+    # Find a section given its name.
+    # Returns the section (an FXStringDict instance) if found,
+    # otherwise returns nil.
+    #
+    # ==== Parameters:
+    #
+    # +section+::	the section name of interest [String]
+    #
+    def find(section) ; end
+
+    #
+    # Iterate over sections (where each section is a dictionary).
+    #
+    def each_section # :yields: aStringDict
+    end
+    
+    #
+    # Read a string 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 [String]
+    #
+    def readStringEntry(section, key, default="") ; end
+
+    #
+    # Read an integer 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 [Integer]
+    #
+    def readIntEntry(section, key, default=0) ; end
+
+    #
+    # Read an unsigned integer 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 [Integer]
+    #
+    def readUnsignedEntry(section, key, default=0) ; end
+
+    #
+    # Read a double-precision floating point 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 [Float]
+    #
+    def readRealEntry(section, key, default=0.0) ; end
+
+    #
+    # Read a color value 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 [FXColor]
+    #
+    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.
+    #
+    # ==== Parameters:
+    #
+    # +section+::	the section name [String]
+    # +key+::		the key for this setting [String]
+    # +value+::		the value for this setting [String]
+    #
+    def writeStringEntry(section, key, value) ; end
+
+    #
+    # Write an integer 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 [Integer]
+    #
+    def writeIntEntry(section, key, value) ; end
+
+    #
+    # Write an unsigned integer 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 [Integer]
+    #
+    def writeUnsignedEntry(section, key, value) ; end
+
+    #
+    # Write a double-precision floating point 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 [Float]
+    #
+    def writeRealEntry(section, key, value) ; end
+
+    #
+    # Write a color 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 [FXColor]
+    #
+    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.
+    #
+    # ==== Parameters:
+    #
+    # +section+::	the section containing the key to be deleted [String]
+    # +key+::		the key to be deleted [String]
+    #
+    def deleteEntry(section, key) ; end
+
+    #
+    # Returns +true+ if a registry entry exists for the specified _section_ and _key_.
+    #
+    # ==== Parameters:
+    #
+    # +section+::	the section containing the key of interest [String]
+    # +key+::		the key of interest [String]
+    #
+    def existingEntry?(section, key) ; end
+
+    #
+    # Delete an entire section from this settings database.
+    # Returns true on success, false otherwise.
+    #
+    # ==== Parameters:
+    #
+    # +section+::	the name of the section to be deleted [String]
+    #
+    def deleteSection(section) ; end
+
+    #
+    # Returns +true+ if the named _section_ exists.
+    #
+    # ==== Parameters:
+    #
+    # +section+::	the name of the section of interest [String]
+    #
+    def existingSection?(section) ; end
+
+    #
+    # Mark as changed.
+    #
+    def modified=(mdfy=true) ; end
+
+    #
+    # Returns +true+ if this settings object has been modified.
+    #
+    def modified? ; end
+  end
+end

data/rdoc-sources/FXShell.rb

@@ -0,0 +1,8 @@
+module Fox
+  #
+  # 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
+end

data/rdoc-sources/FXShutter.rb

@@ -0,0 +1,102 @@
+module Fox
+  #
+  # 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
+  #
+  # +ID_SHUTTERITEM_BUTTON+::	x
+  #
+  class FXShutterItem < FXVerticalFrame
+    #
+    # The button for this shutter item [FXButton]
+    #
+    attr_reader :button
+    
+    # The contents for this shutter item [FXVerticalFrame]
+    attr_reader :content
+    
+    # Status line help text for this shutter item [String]
+    attr_accessor :helpText
+
+    # Tool tip message for this shutter item [String]
+    attr_accessor :tipText
+
+    #
+    # Return an initialized FXShutterItem instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent shutter for this shutter item [FXShutter]
+    # +text+::	the text, if any [String]
+    # +icon+::	the icon, if any [FXIcon]
+    # +opts+::	options [Integer]
+    # +x+::	initial x-position, when the +LAYOUT_FIX_X+ layout hint is in effect [Integer]
+    # +y+::	initial y-position, when the +LAYOUT_FIX_Y+ layout hint is in effect [Integer]
+    # +width+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +height+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    # +padLeft+::	internal padding on the left side, in pixels [Integer]
+    # +padRight+::	internal padding on the right side, in pixels [Integer]
+    # +padTop+::	internal padding on the top side, in pixels [Integer]
+    # +padBottom+::	internal padding on the bottom side, in pixels [Integer]
+    # +hSpacing+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vSpacing+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, text="", icon=nil, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theShutterItem
+    end
+  end
+
+  #
+  # 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
+  #
+  # The following messages are sent by FXShutter to its target:
+  #
+  # +SEL_COMMAND+::
+  #   sent whenever a new shutter item is opened; the message data is an integer
+  #   indicating the new currently displayed shutter item.
+  #
+  # === Message identifiers
+  #
+  # +ID_SHUTTER_TIMEOUT+::	x
+  # +ID_OPEN_SHUTTERITEM+::	x
+  # +ID_OPEN_FIRST+::		x
+  # +ID_OPEN_LAST+::		x
+  #
+  class FXShutter < FXVerticalFrame
+  
+    #
+    # The currently displayed shutter item (a zero-based index) [Integer]
+    #
+    attr_accessor :current
+
+    #
+    # Return an initialized FXShutter instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this shutter [FXComposite]
+    # +target+::	the message target, if any, for this shutter [FXObject]
+    # +selector+::	the message identifier for this shutter [Integer]
+    # +opts+::	shutter options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +width+::	initial width [Integer]
+    # +height+::	initial height [Integer]
+    # +padLeft+::	internal padding on the left side, in pixels [Integer]
+    # +padRight+::	internal padding on the right side, in pixels [Integer]
+    # +padTop+::	internal padding on the top side, in pixels [Integer]
+    # +padBottom+::	internal padding on the bottom side, in pixels [Integer]
+    # +hSpacing+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vSpacing+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0, padLeft=DEFAULT_SPACING, padRight=DEFAULT_SPACING, padTop=DEFAULT_SPACING, padBottom=DEFAULT_SPACING, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theShutter
+    end
+  end
+end
+

data/rdoc-sources/FXSize.rb

@@ -0,0 +1,95 @@
+module Fox
+  #
+  # Size
+  #
+  class FXSize
+    # Width [Integer]
+    attr_accessor :w
+    
+    # Height [Integer]
+    attr_accessor :h
+
+    #
+    # Return an uninitialized FXSize instance.
+    #
+    def initialize; end
+
+    #
+    # Return an initialized FXSize instance which is a copy
+    # of the input size _s_ (an FXSize instance).
+    #
+    def initialize(s); end
+
+    #
+    # Return an initialized FXSize instance, where _ww_ and
+    # _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
+