fxruby 1.6.13-mswin32

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,56 @@
+module Fox
+  #
+  # 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
+
+    # 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]
+    # +width+::		initial width [Integer]
+    # +height+::		initial height [Integer]
+    #
+    def initialize(owner, caption, ic=nil, opts=0, x=0, y=0, width=0, height=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,130 @@
+module Fox
+  #
+  # 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.
+  # If the document size exceeds the available space, it is possible to
+  # scroll the document using setPosition().  When the document size is
+  # less than the available space, the alignment options can be used to
+  # center, left-adjust, or right-adjust the document.
+  # Finally, a special option exists to stretch the document to the
+  # available space, that is to say, the document will always be fitten
+  # with given left and right edges substracted from the available space.
+  #
+  # === 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.
+  # +SEL_CHANGED+::		sent whenever something about the ruler changes
+  #
+  # === 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
+  # +RULER_MARGIN_ADJUST+::	Allow margin adjustment
+  # +RULER_ALIGN_CENTER+::	Center document horizontally
+  # +RULER_ALIGN_LEFT+::	Align document to the left
+  # +RULER_ALIGN_RIGHT+::	Align document to the right
+  # +RULER_ALIGN_TOP+::		Align document to the top
+  # +RULER_ALIGN_BOTTOM+::	Align document to the bottom
+  # +RULER_ALIGN_STRETCH+::	Stretch document to fit horizontally
+  # +RULER_ALIGN_NORMAL+::	Normally, document is centered both ways
+  #
+  # === Message identifiers:
+  #
+  # +ID_ARROW+::		write me
+  #
+  class FXRuler < FXFrame
+  
+    # Current position [Integer]
+    attr_accessor :position
+    
+    # Content size [Integer]
+    attr_accessor :contentSize
+    
+    # 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
+    
+    # The slider value [Integer]
+    attr_accessor :value
+    
+    # The ruler style [Integer]
+    attr_accessor :rulerStyle
+    
+    # Ruler alignment [Integer]
+    attr_accessor :rulerAlignment
+
+    # 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, target=nil, selector=0, opts=RULER_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theRuler
+    end
+    
+    # Return lower edge of document (an integer)
+    def documentLower; end
+    
+    # Return upper edge of document (an integer)
+    def documentUpper; end
+  end
+end

data/rdoc-sources/FXRulerView.rb

@@ -0,0 +1,225 @@
+module Fox
+  #
+  # The Ruler View provides viewing of a document with rulers.
+  # It is intended to be subclassed in order to draw actual contents
+  # and provide editing behavior for the document.
+  # The ruler view itself simply manages the geometry of the document
+  # being edited, and coordinates the movement of the ruler displays
+  # as the document is being scrolled.
+  #
+  class FXRulerView < FXScrollArea
+
+    # Return a reference to the horizontal ruler [FXRuler]
+    attr_reader :horizontalRuler
+
+    # Return a reference to the vertical ruler [FXRuler]
+    attr_reader :verticalRuler
+
+    # Get document position X [Integer]
+    attr_reader :documentX
+
+    # Get document position Y [Integer]
+    attr_reader :documentY
+
+    # Current document color [FXColor]
+    attr_accessor :documentColor
+
+    # X arrow position, relative to document position [Integer]
+    attr_accessor :arrowPosX
+
+    # Y arrow position in document, relative to document position [Integer]
+    attr_accessor :arrowPosY
+
+    # Horizontal ruler style[Integer]
+    attr_accessor :hRulerStyle
+
+    # Vertical ruler style [Integer]
+    attr_accessor :vRulerStyle
+
+    # Status line help text [String]
+    attr_accessor :helpText
+
+    # Tool tip message [String]
+    attr_accessor :tipText
+    
+    # Document width [Integer]
+    attr_accessor :documentWidth
+    
+    # Document height [Integer]
+    attr_accessor :documentHeight
+    
+    # Horizontal edge spacing around document [Integer]
+    attr_accessor :hEdgeSpacing
+    
+    # Vertical edge spacing around document [Integer]
+    attr_accessor :vEdgeSpacing
+    
+    # Horizontal lower margin [Integer]
+    attr_accessor :hMarginLower
+    
+    # Horizontal upper margin [Integer]
+    attr_accessor :hMarginUpper
+    
+    # Vertical lower margin [Integer]
+    attr_accessor :vMarginLower
+    
+    # Vertical upper margin [Integer]
+    attr_accessor :vMarginUpper
+    
+    # Horizontal alignment; the default is +RULER_ALIGN_NORMAL+ [Integer]
+    attr_accessor :hAlignment
+    
+    # Vertical alignment; the default is +RULER_ALIGN_NORMAL+ [Integer]
+    attr_accessor :vAlignment
+
+    # Horizontal ruler font [FXFont]
+    attr_accessor :hRulerFont
+    
+    # Vertical ruler font [FXFont]
+    attr_accessor :vRulerFont
+    
+    # Horizontal document number placement [Integer]
+    attr_accessor :hNumberTicks
+    
+    # Vertical document number placement [Integer]
+    attr_accessor :vNumberTicks
+    
+    # Horizontal major ticks [Integer]
+    attr_accessor :hMajorTicks
+    
+    # Vertical major ticks [Integer]
+    attr_accessor :vMajorTicks
+
+    # Horizontal medium ticks [Integer]
+    attr_accessor :hMediumTicks
+    
+    # Vertical medium ticks [Integer]
+    attr_accessor :vMediumTicks
+
+    # Horizontal tiny ticks [Integer]
+    attr_accessor :hTinyTicks
+    
+    # Vertical tiny ticks [Integer]
+    attr_accessor :vTinyTicks
+    
+    # Horizontal pixels per tick spacing [Float]
+    attr_accessor :hPixelsPerTick
+    
+    # Vertical pixels per tick spacing [Float]
+    attr_accessor :vPixelsPerTick
+
+    #
+    # Return an initialized FXRulerView instance.
+    #
+    def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theRulerView
+    end
+ 
+    # Set document width (in pixels).
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the document size is changed.
+    def setDocumentWidth(w, notify=false); end
+    
+    # Set document height (in pixels).
+    def setDocumentHeight(h, notify=false); end
+    
+    # Set horizontal edge spacing around document (in pixels).
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the edge spacing is changed.
+    def setHEdgeSpacing(es, notify=false); end
+    
+    # Set vertical edge spacing around document (in pixels).
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the edge spacing is changed.
+    def setVEdgeSpacing(es, notify=false); end
+    
+    # Set horizontal lower margin (in pixels).
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the margin is changed.
+    def setHMarginLower(marg, notify=false); end
+    
+    # Set horizontal upper margin (in pixels).
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the margin is changed.
+    def setHMarginUpper(marg, notify=false); end
+    
+    # Set vertical lower margin (in pixels).
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the margin is changed.
+    def setVMarginLower(marg, notify=false); end
+    
+    # Set vertical upper margin (in pixels).
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the margin is changed.
+    def setVMarginUpper(marg, notify=false); end
+    
+    # Set horizontal alignment; the default is +RULER_ALIGN_NORMAL+.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the alignment is changed.
+    def setHAlignment(align, notify=false); end
+    
+    # Set vertical alignment; the default is +RULER_ALIGN_NORMAL+.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the alignment is changed.
+    def setVAlignment(align, notify=false); end
+
+    # Set horizontal ruler font.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the font is changed.
+    def setHRulerFont(font, notify=false); end
+    
+    # Set vertical ruler font.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the font is changed.
+    def setVRulerFont(font, notify=false); end
+    
+    # Set number of horizontal "number" ticks.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the number of ticks is changed.
+    def setHNumberTicks(ticks, notify=false); end
+    
+    # Set number of vertical "number" ticks.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the number of ticks is changed.
+    def setVNumberTicks(ticks, notify=false); end
+    
+    # Set number of horizontal major ticks.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the number of ticks is changed.
+    def setHMajorTicks(ticks, notify=false); end
+    
+    # Set number of vertical major ticks.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the number of ticks is changed.
+    def setVMajorTicks(ticks, notify=false); end
+
+    # Set number of horizontal medium ticks.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the number of ticks is changed.
+    def setHMediumTicks(ticks, notify=false); end
+    
+    # Set number of vertical medium ticks.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the number of ticks is changed.
+    def setVMediumTicks(ticks, notify=false); end
+
+    # Set number of horizontal tiny ticks.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the number of ticks is changed.
+    def setHTinyTicks(ticks, notify=false); end
+    
+    # Set number of vertical tiny ticks.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the number of ticks is changed.
+    def setVTinyTicks(ticks, notify=false); end
+    
+    # Set horizontal pixels per tick spacing
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the horizontal
+    # ruler's target after the spacing is changed.
+    def setHPixelsPerTick(space, notify=false); end
+    
+    # Set vertical pixels per tick spacing
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the vertical
+    # ruler's target after the spacing is changed.
+    def setVPixelsPerTick(space, notify=false); end
+  end
+end