fxruby 1.6.14-universal-darwin-9

data/rdoc-sources/FXScrollBar.rb

@@ -0,0 +1,107 @@
+module Fox
+  #
+  # The scroll bar is used when a document has a larger content than may be made
+  # 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 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.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXScrollBar 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_RIGHTBUTTONPRESS+::	sent when the right mouse button goes down; the message data is an FXEvent instance.
+  # +SEL_RIGHTBUTTONRELEASE+::	sent when the right mouse button goes up; the message data is an FXEvent instance.
+  # +SEL_CHANGED+::
+  #   sent continuously while the scroll bar is moving; the message data is an integer
+  #   indicating the current position of the scroll bar.
+  # +SEL_COMMAND+::
+  #   sent at the end of a scrolling operation, to signal that the scrolling is complete.
+  #   The message data is an integer indicating the new position of the scroll bar.
+  #
+  # === Scrollbar styles
+  #
+  # +SCROLLBAR_HORIZONTAL+::	Horizontally oriented
+  # +SCROLLBAR_VERTICAL+::	Vertically oriented (the default)
+  #
+  # === Message identifiers
+  #
+  # +ID_TIMEWHEEL+::	x
+  # +ID_AUTOINC_LINE+::	x
+  # +ID_AUTODEC_LINE+::	x
+  # +ID_AUTOINC_PAGE+::	x
+  # +ID_AUTODEC_PAGE+::	x
+  # +ID_AUTOINC_PIX+::	x
+  # +ID_AUTODEC_PIX+::	x
+  #
+  class FXScrollBar < FXWindow
+    # Content size range [Integer]
+    attr_accessor :range
+    
+    # Viewport page size [Integer]
+    attr_accessor :page
+    
+    # Scroll increment for line [Integer]
+    attr_accessor :line
+    
+    # Current scroll position [Integer]
+    attr_accessor :position
+    
+    # Highlight color [FXColor]
+    attr_accessor :hiliteColor
+
+    # Shadow color [FXColor]
+    attr_accessor :shadowColor
+
+    # Border color [FXColor]
+    attr_accessor :borderColor
+
+    # Scroll bar style [Integer]
+    attr_accessor :scrollbarStyle
+    
+    # Bar size [Integer]
+    attr_accessor :barSize
+
+    #
+    # Return an initialized FXScrollBar instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this scroll bar [FXComposite]
+    # +target+::	the initial message target (if any) for this scroll bar [FXObject]
+    # +selector+::	the message identifier for this scroll bar [Integer]
+    # +opts+::	the 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]
+    #
+    def initialize(p, target=nil, selector=0, opts=SCROLLBAR_VERTICAL, x=0, y=0, width=0, height=0) # :yields: theScrollBar
+    end
+  end
+  
+  #
+  # Corner between scroll bars
+  #
+  class FXScrollCorner < FXWindow
+    #
+    # Return an initialized FXScrollCorner instance, where _p_ is the
+    # parent window (an FXComposite instance).
+    #
+    def initialize(p) # :yields: theScrollCorner
+    end
+  end
+end
+

data/rdoc-sources/FXScrollPane.rb

@@ -0,0 +1,28 @@
+module Fox
+  #
+  # 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
+
+    # Index of top-most menu item [Integer]
+    attr_accessor :topItem
+    
+    # Number of visible items [Integer]
+    attr_accessor :numVisible
+
+    #
+    # Return an initialized FXScrollPane instance.
+    #
+    # ==== Parameters:
+    #
+    # +owner+::	owner window for this menu pane [FXWindow]
+    # +nvis+::	maximum number of visible items [Integer]
+    # +opts+::	options [Integer]
+    #
+    def initialize(owner, nvis, opts=0) # :yields: theScrollPane
+    end
+  end
+end
+

data/rdoc-sources/FXScrollWindow.rb

@@ -0,0 +1,38 @@
+module Fox
+  #
+  # The FXScrollWindow widget scrolls an arbitrary child window.
+  # Use the scroll window when parts of the user interface itself
+  # need to be scrolled, for example when applications need to run
+  # on small screens.  The scroll window observes some layout hints of 
+  # its content-window; it observes +LAYOUT_FIX_WIDTH+, +LAYOUT_FIX_HEIGHT+
+  # at all times.  The hints +LAYOUT_FILL_X+, +LAYOUT_LEFT+, +LAYOUT_RIGHT+, 
+  # +LAYOUT_CENTER_X+, as well as +LAYOUT_FILL_Y+, +LAYOUT_TOP+, +LAYOUT_BOTTOM+, 
+  # +LAYOUT_CENTER_Y+ are however only interpreted if the content size
+  # is smaller than the viewport size, because if the content size is
+  # larger than the viewport size, then content must be scrolled.
+  # Note that this means that the content window's position is not 
+  # necessarily equal to the scroll position of the scroll window!
+  #
+  class FXScrollWindow < FXScrollArea
+    #
+    # Return an initialized FXScrollWindow instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this scroll window [FXComposite]
+    # +opts+::	the 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]
+    #
+    def initialize(p, opts=0, x=0, y=0, width=0, height=0) # :yields: theScrollWindow
+    end
+  
+    #
+    # Return a reference to the contents window (an FXWindow instance).
+    #
+    def contentWindow; end
+  end
+end
+

data/rdoc-sources/FXSearchDialog.rb

@@ -0,0 +1,24 @@
+module Fox
+  #
+  # Text search dialog
+  #
+  class FXSearchDialog < FXReplaceDialog
+    #
+    # Return an initialized FXSearchDialog instance.
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		the owner window for this dialog box [FXWindow]
+    # +caption+::	the caption (title) string for this dialog box [String]
+    # +ic+::		the icon [FXIcon]
+    # +opts+::		the options [Integer]
+    # +x+::		initial x-position [Integer]
+    # +y+::		initial y-position [Integer]
+    # +width+::		initial width [Integer]
+    # +height+::		initial height [Integer]
+    #
+    def initialize(owner, caption, ic=nil, opts=0, x=0, y=0, width=0, height=0) # :yields: theSearchDialog
+    end
+  end
+end
+

data/rdoc-sources/FXSeparator.rb

@@ -0,0 +1,74 @@
+module Fox
+  #
+  # 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
+  #
+  # +SEPARATOR_NONE+::		Nothing visible
+  # +SEPARATOR_GROOVE+::	Etched-in looking groove
+  # +SEPARATOR_RIDGE+::		Embossed looking ridge
+  # +SEPARATOR_LINE+::		Simple line
+  #
+  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, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0) # :yields: theSeparator
+    end
+  end
+    
+  #
+  # Horizontal separator
+  #
+  class FXHorizontalSeparator < FXSeparator
+    #
+    # Return an initialized FXHorizontalSeparator instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this separator [FXComposite]
+    # +opts+::	the 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]
+    #
+    def initialize(p, opts=SEPARATOR_GROOVE|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=1, padRight=1, padTop=0, padBottom=0) # :yields: theHorizontalSeparator
+    end
+  end
+
+  #
+  # Vertical separator
+  #
+  class FXVerticalSeparator < FXSeparator
+    #
+    # Return an initialized FXVerticalSeparator instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent widget for this separator [FXComposite]
+    # +opts+::	the 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]
+    #
+    def initialize(p, opts=SEPARATOR_GROOVE|LAYOUT_FILL_Y, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=1, padBottom=1) # :yields: theVerticalSeparator
+    end
+  end
+end
+

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
+