fxruby 1.6.13-mswin32

data/rdoc-sources/FXDockHandler.rb

@@ -0,0 +1,26 @@
+module Fox
+  #
+  # The dock handler exists as a common base class for tool bar grip
+  # and dock title.  
+  #
+  # === Events
+  #
+  # The following messages are sent by FXDockHandler to its target:
+  #
+  # +SEL_KEYPRESS+::		sent when a key goes down; the message data is an FXEvent instance.
+  # +SEL_KEYRELEASE+::		sent when a key goes up; the message data is an FXEvent instance.
+  #
+  class FXDockHandler < FXFrame
+    # Status line help text [String]
+    attr_accessor :helpText
+    
+    # Tool tip text [String]
+    attr_accessor :tipText
+    
+    #
+    # Return an initialized FXDockHandler instance.
+    #
+    def initialize(p, tgt, sel, opts, x, y, w, h, pl, pr, pt, pb) # :yields: aDockHandler
+    end
+  end
+end

data/rdoc-sources/FXDockSite.rb

@@ -0,0 +1,104 @@
+module Fox
+  #
+  # The dock site widget is a widget where dock bars can be docked.
+  # Dock site widgets are typically embedded inside the main window, placed
+  # against those sides where docking of toolbars is to be allowed.
+  # Dock bars placed inside a dock site are laid out in horizontal or vertical bands
+  # called _galleys_. A toolbar with the +LAYOUT_DOCK_SAME+ hint is preferentially placed
+  # on the same galley as its previous sibling. A dock bar with the +LAYOUT_DOCK_NEXT+ is
+  # always placed on the next galley.
+  # Each galley will have at least one dock bar shown in it. Several dock bars
+  # may be placed side-by-side inside one galley, unless there is insufficient
+  # room. If there is insufficient room to place another dock bar, that dock bar
+  # will be moved to the next galley, even though its +LAYOUT_DOCK_NEXT+ option
+  # is not set. This implies that when the main window is resized, and more room
+  # becomes available, it will jump back to its preferred galley.
+  # Within a galley, dock bars will be placed from left to right, at the given
+  # x and y coordinates, with the constraints that the dock bar will stay within
+  # the galley, and do not overlap each other. It is possible to use +LAYOUT_FILL_X+
+  # and/or +LAYOUT_FILL_Y+ to stretch a toolbar to the available space on its galley.
+  # The galleys are oriented horizontally if the dock site is placed inside
+  # a top level window using +LAYOUT_SIDE_TOP+ or +LAYOUT_SIDE_BOTTOM+, and
+  # vertically oriented if placed with +LAYOUT_SIDE_LEFT+ or +LAYOUT_SIDE_RIGHT+.
+  #
+  # === Dock Site Options
+  #
+  # +DOCKSITE_WRAP+::		Dockbars are wrapped to another galley when not enough space on current galley
+  # +DOCKSITE_NO_WRAP+::	Never wrap dockbars to another galley even if not enough space
+  #
+  class FXDockSite < FXPacker
+    #
+    # Construct a toolbar dock layout manager. Passing +LAYOUT_SIDE_TOP+ or +LAYOUT_SIDE_BOTTOM+
+    # causes the toolbar dock to be oriented horizontally. Passing +LAYOUT_SIDE_LEFT+ or
+    # +LAYOUT_SIDE_RIGHT+ causes it to be oriented vertically.
+    #
+    def initialize(p, opts=0, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0, hSpacing=0, vSpacing=0) # :yields: theDockSite
+    end
+
+    #
+    # Move tool bar, changing its options to suit the new position.
+    # Used by the toolbar dragging to rearrange the toolbars inside the
+    # toolbar dock.
+    #
+    # ==== Parameters:
+    #
+    # +bar+::		a reference to the dockbar that's being dragged [FXDockBar]
+    # +barx+::		current x-coordinate of the dockbar [Integer]
+    # +bary+		current y-coordinate of the dockbar [Integer]
+    #
+    def moveToolBar(bar, barx, bary); end
+
+    #
+    # The dock site is notified that the given bar has been added
+    # logically before the given window, and is to placed on a new
+    # galley all by itself.  The default implementation adjusts
+    # the layout options of the bars accordingly.
+    #
+    # ==== Parameters:
+    #
+    # +bar+::		a reference to the newly docked dockbar [FXDockBar]
+    # +before+::	a reference to the window that the dockbar was added before [FXWindow]
+    #
+    def dockToolBar(bar, before); end
+
+    #
+    # The dock site is informed that the given bar has been docked
+    # at the given coordinates.  The default implementation determines
+    # where to insert the newly docked bar and adjusts the layout
+    # options of the bars accordingly.
+    #
+    # ==== Parameters:
+    #
+    # +bar+::		a reference to the newly docked dockbar [FXDockBar][FXDockBar]
+    # +barx+::		x-coordinate of the docking position [Integer]
+    # +bary+::		y-coordinate of the docking position [Integer]
+    #
+    def dockToolBar(bar, barx, bary); end
+
+    #
+    # The dock site is informed that the given bar has been removed.
+    # In the default implementation, the dock site fixes the layout
+    # options of the remaining bars so they stay in the same place
+    # if possible.
+    #
+    # ==== Parameters:
+    #
+    # +bar+::	a reference to the removed dockbar [FXDockBar]
+    #
+    def undockToolBar(bar); end
+    
+    #
+    # If _wrap_ is +true+, allow the wrapping of dockbars (i.e. set the
+    # +DOCKSITE_WRAP+ option.)
+    #
+    def wrapGalleys=(wrap); end
+    
+    #
+    # Return +true+ if the +DOCKSITE_WRAP+ option is set, indicating that
+    # dockbars will be wrapped to another galley if there's not enough space on
+    # current galley.
+    #
+    def wrapGalleys?; end
+  end
+end
+

data/rdoc-sources/FXDockTitle.rb

@@ -0,0 +1,26 @@
+module Fox
+  #
+  # A dock title is used to move its container, a dock bar.
+  # The dock title is also used simultaneously to provide a
+  # caption above the dock bar.
+  #
+  class FXDockTitle < FXDockHandler
+    # Caption text for the grip [String]
+    attr_accessor :caption
+    
+    # Caption font [FXFont]
+    attr_accessor :font
+    
+    # Caption color [FXColor]
+    attr_accessor :captionColor
+    
+    # Current justification mode [Integer]
+    attr_accessor :justify
+
+    #
+    # Construct dock bar title widget
+    #
+    def initialize(p, text, target=nil, selector=0, opts=FRAME_NORMAL|JUSTIFY_CENTER_X|JUSTIFY_CENTER_Y, x=0, y=0, width=0, height=0, padLeft=0, padRight=0, padTop=0, padBottom=0)
+    end
+  end
+end

data/rdoc-sources/FXDocument.rb

@@ -0,0 +1,29 @@
+module Fox
+  #
+  # Abstract base class for documents
+  #
+  # === Message identifiers
+  #
+  # +ID_TITLE+::	x
+  # +ID_FILENAME+::	x
+  #
+  class FXDocument < FXObject
+
+    # Modified state for the document [Boolean]
+    attr_writer :modified
+    
+    # Document title
+    attr_accessor :title
+    
+    # Document filename
+    attr_accessor :filename
+
+    # Return an initialized FXDocument instance
+    def initialize # :yields: theDocument
+    end
+  
+    # Return +true+ if document is modified
+    def modified?; end
+  end
+end
+

data/rdoc-sources/FXDragCorner.rb

@@ -0,0 +1,19 @@
+module Fox
+  #
+  # A drag corner widget may be placed in the bottom right corner
+  # so as to allow the window to be resized more easily.
+  #
+  class FXDragCorner < FXWindow
+  
+    # Highlight color [FXColor]
+    attr_accessor :hiliteColor
+    
+    # Shadow color [FXColor]
+    attr_accessor :shadowColor
+    
+    # Construct a drag corner
+    def initialize(p) # :yields: theDragCorner
+    end
+  end
+end
+

data/rdoc-sources/FXDrawable.rb

@@ -0,0 +1,27 @@
+module Fox
+  #
+  # FXDrawable is an abstract base class for any surface that can be
+  # drawn upon, such as an FXWindow or an FXImage.
+  #
+  class FXDrawable < FXId
+  
+    # Width of drawable, in pixels [Integer]
+    attr_reader	:width
+    
+    # Height of drawable, in pixels [Integer]
+    attr_reader	:height
+    
+    # Visual [FXVisual]
+    attr_accessor :visual
+
+    #
+    # Resize drawable to the specified width and height.
+    #
+    # ==== Parameters:
+    #
+    # +width+::	new drawable width, in pixels [Integer]
+    # +height+::	new drawable height, in pixels [Integer]
+    #
+    def resize(w, h); end
+  end
+end

data/rdoc-sources/FXDriveBox.rb

@@ -0,0 +1,46 @@
+module Fox
+  #
+  # Drive box
+  #
+  # === Events
+  #
+  # The following messages are sent by FXDriveBox to its target:
+  #
+  # +SEL_CHANGED+::	sent when the current item changes; the message data is the current drive
+  # +SEL_COMMAND+::	sent when a new item is selected from the list; the message data is the drive
+  #
+  class FXDriveBox < FXListBox
+
+    # Current drive [String]
+    attr_accessor :drive
+    
+    # File associations [FXFileDict]
+    attr_accessor :associations
+
+    # Returns an initialized FXDriveBox instance
+    def initialize(p, target=nil, selector=0, opts=FRAME_SUNKEN|FRAME_THICK|LISTBOX_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theDriveBox
+    end
+
+    #
+    # Set current drive, where _drive_ is a string.
+    # Returns +true+ on success, +false+ on failure.
+    #
+    def setDrive(drive); end
+    
+    #
+    # Return current drive as a string.
+    #
+    def getDrive(); end
+    
+    #
+    # Change file associations, where _assoc_ is an FXFileDict instance.
+    #
+    def setAssociations(assoc); end
+    
+    #
+    # Return file associations (an FXFileDict instance).
+    #
+    def getAssociations(); end
+  end
+end
+

data/rdoc-sources/FXExtentd.rb

@@ -0,0 +1,85 @@
+module Fox
+  class FXExtentd
+    # Lower corner of this extent (an FXVec2d instance).
+    attr_reader :lower
+    
+    # Upper corner of this extent (an FXVec2d instance).
+    attr_reader :upper
+    
+    # Default constructor
+    def initialize; end
+
+    # Copy constructor
+    def initialize(ext); end
+
+    # Initialize from two vectors (where _lo_ and _hi_ are two
+    # FXVec2d instances).
+    def initialize(lo, hi); end
+
+    # Initialize from four numbers
+    def initialize(xlo, xhi, ylo, yhi); end
+
+    # Indexing with 0..1 (returns an FXVec2d instance).
+    def [](i); end
+
+    # Return width of box
+    def width; end
+
+    # Return height of box
+    def height; end
+
+    # Return length of longest side
+    def longest; end
+
+    # Return length of shortest side
+    def shortest; end
+
+    # Return length of diagonal
+    def diameter; end
+
+    # Return radius of box
+    def radius; end
+
+    # Compute diagonal vector (returns an FXVec2d)
+    def diagonal; end
+
+    # Return center of box (as an FXVec2d)
+    def center; end
+
+    # Return +true+ if empty
+    def empty?; end
+
+    # Return +true+ if box contains point (_x_, _y_)
+    def contains?(x, y); end
+
+    # Return +true+ if box contains point _p_ (an FXVec2d instance)
+    def contains?(p); end
+
+    # Return +true+ if box properly contains another box (where _ext_ is
+    # another FXExtentd instance).
+    def contains?(ext); end
+
+    # Include point (_x_, _y_) and return a reference to self.
+    def include!(x, y); end
+
+    # Include point _v_ (an FXVec2d instance) and return a reference to self.
+    def include!(v); end
+
+    # Include given range into extent (where _ext_ is another FXExtentd instance)
+    # and return a reference to self.
+    def include!(ext); end
+
+    # Return +true+ if this extent's bounds overlap with _other_ extent's bounds.
+    def overlap?(other); end
+
+    # Return corner number 0, 1, 2 or 3 (as a FXVec2d instance).
+    def corner(c); end
+
+    # Return a new FXExtentd that is the union of this extent and _other_.
+    def unite_with(other); end
+
+    # Return a new FXExtentd that is the intersection of this extent and _other_.
+    def intersect_with(other); end
+  end
+end
+

data/rdoc-sources/FXExtentf.rb

@@ -0,0 +1,85 @@
+module Fox
+  class FXExtentf
+    # Lower corner of this extent (an FXVec2f instance).
+    attr_reader :lower
+    
+    # Upper corner of this extent (an FXVec2f instance).
+    attr_reader :upper
+    
+    # Default constructor
+    def initialize; end
+
+    # Copy constructor
+    def initialize(ext); end
+
+    # Initialize from two vectors (where _lo_ and _hi_ are two
+    # FXVec2f instances).
+    def initialize(lo, hi); end
+
+    # Initialize from four numbers
+    def initialize(xlo, xhi, ylo, yhi); end
+
+    # Indexing with 0..1 (returns an FXVec2f instance).
+    def [](i); end
+
+    # Return width of box
+    def width; end
+
+    # Return height of box
+    def height; end
+
+    # Return length of longest side
+    def longest; end
+
+    # Return length of shortest side
+    def shortest; end
+
+    # Return length of diagonal
+    def diameter; end
+
+    # Return radius of box
+    def radius; end
+
+    # Compute diagonal vector (returns an FXVec2f)
+    def diagonal; end
+
+    # Return center of box (as an FXVec2f)
+    def center; end
+
+    # Return +true+ if empty
+    def empty?; end
+
+    # Return +true+ if box contains point (_x_, _y_)
+    def contains?(x, y); end
+
+    # Return +true+ if box contains point _p_ (an FXVec2f instance)
+    def contains?(p); end
+
+    # Return +true+ if box properly contains another box (where _ext_ is
+    # another FXExtentf instance).
+    def contains?(ext); end
+
+    # Include point (_x_, _y_) and return a reference to self.
+    def include!(x, y); end
+
+    # Include point _v_ (an FXVec2f instance) and return a reference to self.
+    def include!(v); end
+
+    # Include given range into extent (where _ext_ is another FXExtentf instance)
+    # and return a reference to self.
+    def include!(ext); end
+
+    # Return +true+ if this extent's bounds overlap with _other_ extent's bounds.
+    def overlap?(other); end
+
+    # Return corner number 0, 1, 2 or 3 (as a FXVec2f instance).
+    def corner(c); end
+
+    # Return a new FXExtentf that is the union of this extent and _other_.
+    def unite_with(other); end
+
+    # Return a new FXExtentf that is the intersection of this extent and _other_.
+    def intersect_with(other); end
+  end
+end
+