fxruby 1.2.2

data/rdoc-sources/FXRecentFiles.rb

@@ -0,0 +1,73 @@
+module Fox
+  #
+  # The recent files object manages a most recently used file list by
+  # means of the standard system registry.
+  # When connected to a widget, like a menu command, the recent files object
+  # updates the menu commands label to the associated recent file name; when
+  # the menu command is invoked, the recent file object sends its target a
+  # +SEL_COMMAND+ message with the message data set to the associated file name
+  # (a String).
+  # When adding or removing file names, the recent files object automatically
+  # updates the system registry to record these changes.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXRecentFiles to its target:
+  #
+  # +SEL_COMMAND+::
+  #   sent when one of the recent files in this list is selected,
+  #   usually as a result of being selected from a menu command.
+  #   The message data is a String containing the name of the file.
+  #
+  # === Message identifiers
+  #
+  # <tt>ID_CLEAR</tt>::		Clear the list of files
+  # <tt>ID_ANYFILES</tt>::	x
+  # <tt>ID_FILE_1</tt>::	x
+  # <tt>ID_FILE_2</tt>::	x
+  # <tt>ID_FILE_3</tt>::	x
+  # <tt>ID_FILE_4</tt>::	x
+  # <tt>ID_FILE_5</tt>::	x
+  # <tt>ID_FILE_6</tt>::	x
+  # <tt>ID_FILE_7</tt>::	x
+  # <tt>ID_FILE_8</tt>::	x
+  # <tt>ID_FILE_9</tt>::	x
+  # <tt>ID_FILE_10</tt>::	x
+  #
+  class FXRecentFiles < FXObject
+    # Maximum number of files to track [Integer]
+    attr_accessor :maxFiles
+    
+    # Group name [String]
+    attr_accessor :groupName
+    
+    # Message target [FXObject]
+    attr_accessor :target
+    
+    # Message identifier [Integer]
+    attr_accessor :selector
+    
+    #
+    # Construct a new FXRecentFiles object with the default group name.
+    #
+    def initialize # :yields: theRecentFiles
+    end
+  
+    #
+    # Construct a new FXRecentFiles object with the specified
+    # group name, target and message identifier.
+    #
+    def initialize(group, tgt=nil, sel=0) # :yields: theRecentFiles
+    end
+
+    # Append a file to the end of the list.
+    def appendFile(filename); end
+  
+    # Remove a file from the list.
+    def removeFile(filename); end
+  
+    # Clear the list of files.
+    def clear(); end
+  end
+end
+

data/rdoc-sources/FXRectangle.rb

@@ -0,0 +1,137 @@
+module Fox
+  #
+  # Rectangle
+  #
+  class FXRectangle
+
+    #
+    # Upper left corner's x-coordinate [Integer]
+    #
+    attr_accessor :x
+    
+    # Upper left corner's y-coordinate [Integer]
+    attr_accessor :y
+    
+    # Rectangle width [Integer]
+    attr_accessor :w
+    
+    # Rectangle height [Integer]
+    attr_accessor :h
+  
+    #
+    # Return an uninitialized FXRectangle instance.
+    #
+    def initialize; end
+    
+    #
+    # Return an initialized FXRectangle instance.
+    #
+    # ==== Parameters:
+    #
+    # +xx+::	upper left corner's initial x-coordinate [Integer]
+    # +yy+::	upper left corner's initial y-coordinate [Integer]
+    # +ww+::	initial width [Integer]
+    # +hh+::	initial height [Integer]
+    #
+    def initialize(xx, yy, ww, hh); end
+    
+    #
+    # Return an initialized FXRectangle instance.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	upper left corner's initial position [FXPoint]
+    # +s+::	initial size [FXSize]
+    #
+    def initialize(p, s); end
+
+    #
+    # Return an initialized FXRectangle instance.
+    #
+    # ==== Parameters:
+    #
+    # +topleft+::	upper left corner's initial position [FXPoint]
+    # +bottomright+::	bottom right corner's initial position [FXPoint]
+    #
+    def initialize(topleft, bottomright); end
+  
+    #
+    # Return true if _p_ (an FXPoint instance) is contained within this rectangle.
+    #
+    def contains?(p); end
+    
+    #
+    # Return true if the point at (_xx_, _yy_) is contained within this rectangle.
+    #
+    def contains?(xx, yy); end
+  
+    #
+    # Return true if _r_ (another FXRectangle instance) is properly contained within
+    # this rectangle.
+    #
+    def contains?(r); 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/FXRegion.rb

@@ -0,0 +1,64 @@
+module Fox
+  class FXRegion
+    # Construct new empty region
+    def initialize; end
+    
+    # Construct new region copied from region _r_ (another FXRegion instance).
+    def initialize(r); end
+    
+    # Construct new region from rectangle _rect_ (an FXRectangle instance)
+    def initialize(rect); end
+    
+    #
+    # Construct rectangle region, where (_x_, _y_) are the coordinates of the
+    # upper left-hand corner and (_w_, _h_) are its width and height.
+    #
+    def initialize(x, y, w, h); end
+    
+    #
+    # Construct polygon region from an array of points. Here, _points_ is
+    # an array of FXPoint instances.
+    #
+    def initialize(points, winding=false); end
+    
+    # Return +true+ if this region is empty
+    def empty?; end
+    
+    # Return +true+ if this region contains the point at (_x_, _y_).
+    def contains?(x, y); end
+    
+    # Return +true+ if this region contains the rectangle whose upper left
+    # corner is at (_x_, _y_) and whose width and height are (_w_, _h_).
+    def contains?(x, y, w, h); end
+    
+    # Return the bounding box (an FXRectangle instance) for this region.
+    def bounds; end
+    
+    # Offset this region by (_dx_, _dy_) units, and return a reference to
+    # this region.
+    def offset!(dx, dy); end
+    
+    # Return a new FXRegion which is the union of this region and _other_
+    # (another FXRegion instance).
+    def +(other); end
+    
+    # Return a new FXRegion which is the intersection of this region and
+    # _other_ (another FXRegion instance).
+    def *(other); end
+    
+    # Return a new FXRegion which is the difference of this region and
+    # _other_ (another FXRegion instance).
+    def -(other); end
+    
+    # Return a new FXRegion which is the exclusive-or (XOR) of this region
+    # with _other_ (another FXRegion instance).
+    def ^(other); end
+    
+    # Return +true+ if this region is equal to _other_ (another FXRegion instance).
+    def ==(other); end
+    
+    # Reset this region to empty.
+    def reset; end
+  end
+end
+

data/rdoc-sources/FXRegistry.rb

@@ -0,0 +1,39 @@
+module Fox
+  #
+  # The registry maintains a database of persistent settings for an application,
+  # or suite of applications.
+  #
+  class FXRegistry < FXSettings
+
+    # Application key [String]
+    attr_reader	:appKey
+    
+    # Vendor key [String]
+    attr_reader	:vendorKey
+    
+    # Use file-based registry instead of Windows Registry [Boolean]
+    attr_writer	:asciiMode
+
+    #
+    # Construct registry object; _appKey_ and _vendorKey_ must be string constants.
+    # Regular applications SHOULD set a vendor key!
+    #
+    def initialize(appKey="", vendorKey="") ; end
+    
+    #
+    # Read registry.
+    #
+    def read; end
+    
+    #
+    # Write registry.
+    #
+    def write; end
+
+    #
+    # Return +true+ if we're using a file-based registry mechanism instead of the Windows Registry
+    # (only relevant on Windows systems).
+    #
+    def asciiMode?; end
+  end
+end

data/rdoc-sources/FXReplaceDialog.rb

@@ -0,0 +1,56 @@
+module Fox
+  #
+  # Search and replace dialog box.
+  #
+  # === Message identifiers
+  #
+  # +ID_NEXT+::         x
+  # +ID_PREV+::         x
+  # +ID_SEARCH_UP+::    x
+  # +ID_SEARCH_DN+::    x
+  # +ID_REPLACE_UP+::   x
+  # +ID_REPLACE_DN+::	x
+  # +ID_ALL+::		x
+  # +ID_DIR+::   	x
+  # +ID_SEARCH_TEXT+::	x
+  # +ID_REPLACE_TEXT+::	x
+  # +ID_MODE+::		x
+  #
+  class FXReplaceDialog < FXDialogBox
+    #
+    # Search matching mode, one of the following:
+    #
+    # +DONE+::		Cancel search
+    # +SEARCH+::	Search first occurrence
+    # +REPLACE+::	Replace first occurrence
+    # +SEARCH_NEXT+::	Search next occurrence
+    # +REPLACE_NEXT+::	Replace next occurrence
+    # +REPLACE_ALL+::	Replace all occurrences
+    #
+    attr_accessor :searchMode
+    
+    # Text or pattern to search for [String]
+    attr_accessor :searchText
+    
+    # Replacement text [String]
+    attr_accessor :replaceText
+  
+    #
+    # Return an initialized FXReplaceDialog 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]
+    # +w+::		initial width [Integer]
+    # +h+::		initial height [Integer]
+    #
+    def initialize(owner, caption, ic=nil, opts=0, x=0, y=0, w=0, h=0) # :yield: theReplaceDialog
+    end
+  end
+end
+

data/rdoc-sources/FXRootWindow.rb

@@ -0,0 +1,17 @@
+module Fox
+  #
+  # Root window
+  #
+  class FXRootWindow < FXComposite
+    #
+    # Return an initialized FXRootWindow instance.
+    #
+    # ==== Parameters:
+    #
+    # +a+::	an application instance [FXApp]
+    # +vis+::	a visual [FXVisual]
+    #
+    def initialize(a, vis) # :yield: theRootWindow
+    end
+  end
+end

data/rdoc-sources/FXRuler.rb

@@ -0,0 +1,60 @@
+module Fox
+  #
+  # An FXRuler widget can be placed alongside a document to measure position
+  # and size of entities within the document.
+  #
+  # === 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_LEFTBUTTONRELEASE+::	sent when the left mouse button goes up; the message data is an FXEvent instance.
+  #
+  # === Ruler options
+  #
+  # +RULER_NORMAL+::		Default appearance (default)
+  # +RULER_HORIZONTAL+::	Ruler is horizontal (default)
+  # +RULER_VERTICAL+::		Ruler is vertical
+  # +RULER_TICKS_OFF+::		Tick marks off (default)
+  # +RULER_TICKS_TOP+::		Ticks on the top (if horizontal)
+  # +RULER_TICKS_BOTTOM+::	Ticks on the bottom (if horizontal)
+  # +RULER_TICKS_LEFT+::	Ticks on the left (if vertical)
+  # +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_MARKERS+::		Draw markers for indentation settings
+  # +RULER_METRIC+::		Metric subdivision (default)
+  # +RULER_ENGLISH+::		English subdivision
+  #
+  # === Message identifiers:
+  #
+  # +ID_ARROW+::			write me
+  #
+  class FXRuler < FXFrame
+  
+    # The text font [FXFont]
+    attr_accessor :font
+    
+    # The slider value [Integer]
+    attr_accessor :value
+    
+    # The ruler style [Integer]
+    attr_accessor :rulerStyle
+    
+    # The current text color [FXColor]
+    attr_accessor :textColor
+    
+    # The status line help text for this ruler [String]
+    attr_accessor :helpText
+    
+    # The tool tip message for this ruler [String]
+    attr_accessor :tipText
+    
+    #
+    # Return an initialized FXRuler instance.
+    #
+    def initialize(p, tgt=nil, sel=0, opts=RULER_NORMAL, x=0, y=0, w=0, h=0, pl=DEFAULT_PAD, pr=DEFAULT_PAD, pt=DEFAULT_PAD, pb=DEFAULT_PAD) # :yields: theRuler
+    end
+  end
+end