fxruby 1.2.2

data/rdoc-sources/FXSettings.rb

@@ -0,0 +1,222 @@
+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.
+  #
+  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
+
+    #
+    # 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
+
+    #
+    # 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,7 @@
+module Fox
+  #
+  # A child of the root window
+  #
+  class FXShell < FXComposite
+  end
+end

data/rdoc-sources/FXShutter.rb

@@ -0,0 +1,97 @@
+module Fox
+  #
+  # Shutter item
+  #
+  # === 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]
+    # +w+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +h+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    # +hs+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vs+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, text="", icon=nil, opts=0, x=0, y=0, w=0, h=0, pl=DEFAULT_SPACING, pr=DEFAULT_SPACING, pt=DEFAULT_SPACING, pb=DEFAULT_SPACING, hs=DEFAULT_SPACING, vs=DEFAULT_SPACING) # :yields: theShutterItem
+    end
+  end
+
+  #
+  # Shutter control
+  #
+  # === 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]
+    # +tgt+::	the message target, if any, for this shutter [FXObject]
+    # +sel+::	the message identifier for this shutter [Integer]
+    # +opts+::	shutter options [Integer]
+    # +x+::	initial x-position [Integer]
+    # +y+::	initial y-position [Integer]
+    # +w+::	initial width [Integer]
+    # +h+::	initial height [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    # +hs+::	horizontal spacing between widgets, in pixels [Integer]
+    # +vs+::	vertical spacing between widgets, in pixels [Integer]
+    #
+    def initialize(p, tgt=nil, sel=0, opts=0, x=0, y=0, w=0, h=0, pl=DEFAULT_SPACING, pr=DEFAULT_SPACING, pt=DEFAULT_SPACING, pb=DEFAULT_SPACING, hs=DEFAULT_SPACING, vs=DEFAULT_SPACING) # :yields: theShutter
+    end
+  end
+end
+

data/rdoc-sources/FXSize.rb

@@ -0,0 +1,30 @@
+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
+  end
+end
+

data/rdoc-sources/FXSlider.rb

@@ -0,0 +1,96 @@
+module Fox
+  #
+  # The slider widget is a valuator widget which provides simple linear value range.
+  # Two visual appearances are supported:- the sunken look, which is enabled with
+  # the SLIDER_INSIDE_BAR option and the regular look.  The latter may have optional
+  # arrows on the slider thumb.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXSlider to its target:
+  #
+  # +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.
+  # +SEL_MIDDLEBUTTONRELEASE+::	sent when the middle mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_COMMAND+::
+  #   sent at the end of a slider move; the message data is the new position of the slider (an Integer).
+  # +SEL_CHANGED+::
+  #   sent continuously while the slider is being moved; the message data is an integer indicating
+  #   the current slider position.
+  #
+  # === Slider control styles
+  #
+  # +SLIDER_HORIZONTAL+::	Slider shown horizontally
+  # +SLIDER_VERTICAL+::		Slider shown vertically
+  # +SLIDER_ARROW_UP+::		Slider has arrow head pointing up
+  # +SLIDER_ARROW_DOWN+::	Slider has arrow head pointing down
+  # +SLIDER_ARROW_LEFT+::	Slider has arrow head pointing left
+  # +SLIDER_ARROW_RIGHT+::	Slider has arrow head pointing right
+  # +SLIDER_INSIDE_BAR+::	Slider is inside the slot rather than overhanging
+  # +SLIDER_TICKS_TOP+::	Ticks on the top of horizontal slider
+  # +SLIDER_TICKS_BOTTOM+::	Ticks on the bottom of horizontal slider
+  # +SLIDER_TICKS_LEFT+::	Ticks on the left of vertical slider
+  # +SLIDER_TICKS_RIGHT+::	Ticks on the right of vertical slider
+  # +SLIDER_NORMAL+::		same as <tt>SLIDER_HORIZONTAL</tt>
+  #
+  # === Message identifiers
+  #
+  # +ID_AUTOINC+::	x
+  # +ID_AUTODEC+::	x
+  #
+  class FXSlider < FXFrame
+
+    # Slider value [Integer]
+    attr_accessor :value
+
+    # Slider range [Range]
+    attr_accessor :range
+
+    # Slider style [Integer]
+    attr_accessor :sliderStyle
+
+    # Slider head size, in pixels [Integer]
+    attr_accessor :headSize
+    
+    # Slider slot size, in pixels [Integer]
+    attr_accessor :slotSize
+    
+    # Slider auto-increment (or decrement) value [Integer]
+    attr_accessor :increment
+    
+    # Delta between ticks [Integer]
+    attr_accessor :tickDelta
+    
+    # Color of the slot that the slider head moves in [FXColor]
+    attr_accessor :slotColor
+    
+    # Status line help text for this slider [String]
+    attr_accessor :helpText
+    
+    # Tool tip text for this slider [String]
+    attr_accessor :tipText
+    
+    #
+    # Return an initialized FXSlider instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this slider [FXComposite]
+    # +tgt+::	the message target, if any, for this slider [FXObject]
+    # +sel+::	the message identifier for this slider [Integer]
+    # +opts+::	slider 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]
+    # +w+::	initial width, when the +LAYOUT_FIX_WIDTH+ layout hint is in effect [Integer]
+    # +h+::	initial height, when the +LAYOUT_FIX_HEIGHT+ layout hint is in effect [Integer]
+    # +pl+::	internal padding on the left side, in pixels [Integer]
+    # +pr+::	internal padding on the right side, in pixels [Integer]
+    # +pt+::	internal padding on the top side, in pixels [Integer]
+    # +pb+::	internal padding on the bottom side, in pixels [Integer]
+    #
+    def initialize(p, tgt=nil, sel=0, opts=SLIDER_NORMAL, x=0, y=0, w=0, h=0, pl=0, pr=0, pt=0, pb=0) # :yields: theSlider
+    end
+  end
+end
+