fxruby 1.6.14-universal-darwin-9

data/rdoc-sources/FXDirList.rb

@@ -0,0 +1,149 @@
+module Fox
+  #
+  # Directory item
+  #
+  class FXDirItem < FXTreeItem
+    # File associations [FXFileAssoc]
+    attr_reader :assoc
+
+    # File size [Integer]
+    attr_reader :size
+    
+    # File time [Integer]
+    attr_reader :date
+
+    # Returns an initialized FXDirItem instance
+    def initialize(text, oi=nil, ci=nil, data=nil) # :yields: theDirItem
+    end
+    
+    # Return +true+ if this is a directory
+    def directory?; end
+
+    # Return +true+ if this is an executable
+    def executable?; end
+    
+    # Return +true+ if this is a symbolic link
+    def symlink?; end
+    
+    # Return +true+ if this is a character device
+    def chardev?; end
+    
+    # Return +true+ if this is a block device
+    def blockdev?; end
+    
+    # Return +true+ if this is a FIFO (a named pipe)
+    def fifo?; end
+    
+    # Return +true+ if this is a socket
+    def socket?; end
+  end
+  
+  #
+  # An FXDirList widget provides a tree-structured view of the file system.
+  # It automatically updates itself periodically by re-scanning the file system
+  # for any changes.  As it scans the displayed directories and files, it automatically
+  # determines the icons to be displayed by consulting the file-associations registry
+  # settings.  A number of messages can be sent to the FXDirList to control the
+  # filter pattern, sorting order, case sensitivity, and hidden file display mode.
+  # The Directory list widget supports drags and drops of files.
+  #
+  # === Events
+  #
+  # +SEL_CLOSED+::
+  #   sent when a folder item is closed; the message data is a reference to the FXDirItem that was closed
+  # +SEL_OPENED+::
+  #   sent when a folder item is opened; the message data is a reference to the FXDirItem that was opened
+  #
+  # === Directory List options
+  #
+  # +DIRLIST_SHOWFILES+::	Show files as well as directories
+  # +DIRLIST_SHOWHIDDEN+::	Show hidden files or directories
+  # +DIRLIST_NO_OWN_ASSOC+::	Do not create associations for files
+  #
+  # === Message identifiers
+  #
+  # +ID_REFRESH+::		x
+  # +ID_SHOW_FILES+::		x
+  # +ID_HIDE_FILES+::		x
+  # +ID_TOGGLE_FILES+::		x
+  # +ID_SHOW_HIDDEN+::		x
+  # +ID_HIDE_HIDDEN+::		x
+  # +ID_TOGGLE_HIDDEN+::	x
+  # +ID_SET_PATTERN+::		x
+  # +ID_SORT_REVERSE+::		x
+  #
+  class FXDirList < FXTreeList
+
+    # Current file [String]
+    attr_accessor :currentFile
+    
+    # Current directory [String]
+    attr_accessor :directory
+    
+    # Wildcard pattern [String]
+    attr_accessor :pattern
+    
+    # Wildcard matching mode, some combination of file matching flags [Integer]
+    attr_accessor :matchMode
+    
+    # File associations [FXFileDict]
+    attr_accessor :associations
+
+    # Returns an initialized FXDirList instance
+    def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theDirList
+    end
+  
+    #
+    # Scan the directories and update the items if needed, or if _force_ is +true+.
+    #
+    def scan(force=true); end
+
+    # Return +true+ if item is a directory
+    def itemDirectory?(anItem); end
+    
+    # Return +true+ if item is a file
+    def itemFile?(anItem); end
+    
+    # Return +true+ if item is executable
+    def itemExecutable?(anItem); end
+    
+    #
+    # Set current file.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the list's
+    # message target to indicate that the current item has changed.
+    #
+    def setCurrentFile(file, notify=false); end
+  
+    #
+    # Set current directory.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the list's
+    # message target to indicate that the current item has changed.
+    #
+    def setDirectory(path, notify=false); end
+
+    # Return absolute pathname of item
+    def itemPathname(anItem); end
+    
+    # Return the item from the absolute pathname
+    def pathnameItem(path); end
+
+    # Return +true+ if showing files as well as directories
+    def filesShown?; end
+    
+    #
+    # If _state_ is +true+, the directory list will show files as well as
+    # directories; otherwise, it will only show directories.
+    #
+    def filesShown=(state); end
+  
+    # Return +true+ if showing hidden files and directories
+    def hiddenFilesShown?; end
+    
+    #
+    # If _state_ is +true+, the directory list will show hidden files and
+    # directories; otherwise, it won't.
+    #
+    def hiddenFilesShown=(state); end
+  end
+end
+

data/rdoc-sources/FXDirSelector.rb

@@ -0,0 +1,64 @@
+module Fox
+  #
+  # The FXDirSelector widget is the reusable mega-widget component which
+  # is the core of the FXDirDialog.  The function of the directory selector widget
+  # is very similar to the file selector widget, except that the directory selector widget
+  # displays a tree-structured view of the file system, and thereby makes up and down
+  # navigation through the file system significantly easier.
+  #
+  # === Message identifiers
+  #
+  # +ID_DIRNAME+::	x
+  # +ID_DIRLIST+::	x
+  # +ID_HOME+::		x
+  # +ID_WORK+::		x
+  # +ID_DIRECTORY_UP+::	x
+  # +ID_BOOKMARK+::	x
+  # +ID_VISIT+::	x
+  # +ID_NEW+::		x
+  # +ID_DELETE+::	x
+  # +ID_MOVE+::		x
+  # +ID_COPY+::		x
+  # +ID_LINK+::		x
+  #
+  class FXDirSelector < FXPacker
+  
+    # The "Accept" button [FXButton]
+    attr_reader :acceptButton
+    
+    # The "Cancel" button [FXButton]
+    attr_reader :cancelButton
+    
+    # Directory [String]
+    attr_accessor :directory
+    
+    # Wildcard matching mode, some combination of file matching flags [Integer]
+    attr_accessor :matchMode
+    
+    # Directory list style [Integer]
+    attr_accessor :dirBoxStyle
+
+    # Return an initialized FXDirSelector instance
+    def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theDirSelector
+    end
+
+    # Return +true+ if showing files as well as directories
+    def filesShown?; end
+    
+    #
+    # If _state_ is +true+, the directory selector will show files as well as
+    # directories; otherwise, it will only show directories.
+    #
+    def filesShown=(state); end
+  
+    # Return +true+ if showing hidden files and directories
+    def hiddenFilesShown?; end
+    
+    #
+    # If _state_ is +true+, the directory selector will show hidden files and
+    # directories; otherwise, it won't.
+    #
+    def hiddenFilesShown=(state); end
+  end
+end
+

data/rdoc-sources/FXDockBar.rb

@@ -0,0 +1,151 @@
+module Fox
+  #
+  # A dock bar widget can be docked inside a dock site widget, or floated
+  # around freely.  Users can move, undock, and dock the dock bar widget
+  # by means of a handle such as a tool bar grip.  When docking, the dock
+  # bar sends a +SEL_DOCKED+ message to its target; when undocking, it sends
+  # a +SEL_FLOATED+ message. In either case the dock site involved is passed
+  # as the message data.
+  #
+  # === Events
+  #
+  # The following messages are sent by FXDockBar to its target:
+  #
+  # +SEL_DOCKED+::		sent when the dock bar is docked; the message data is a reference to the new dock site (an FXDockSite instance).
+  # +SEL_FLOATED+::		sent when the dock bar is undocked; the message data is a reference to the previous dock site.
+  #
+  # === Dock Bar Options
+  #
+  # +ALLOW_NOWHERE+::		Don't allow docking anywhere
+  # +ALLOW_TOP+::		Docking at the top only
+  # +ALLOW_BOTTOM+::		Docking at the bottom only
+  # +ALLOW_LEFT+::		Docking at the left only
+  # +ALLOW_RIGHT+::		Docking at the right only
+  # +ALLOW_HORIZONTAL+::	Docking at the top and bottom
+  # +ALLOW_VERTICAL+::		Docking at the left and right
+  # +ALLOW_EVERYWHERE+::	Docking can be everywhere
+  #
+  class FXDockBar < FXPacker
+
+    # Docking side, one of +LAYOUT_SIDE_LEFT+, +LAYOUT_SIDE_RIGHT+, +LAYOUT_SIDE_TOP+ or +LAYOUT_SIDE_BOTTOM+ [Integer]
+    attr_accessor :dockingSide
+
+    #
+    # Construct a floatable dock bar, with a default parent _p_ and an
+    # alternate parent _q_. To allow docking and dragging, the default parent
+    # _p_ must be of type FXDockSite, and the alternate parent _q_ must be of
+    # type FXToolBarShell.
+    # Normally, the dock bar is docked under a window _p_ of type FXDockSite.
+    # When floated, the toolbar can be docked under window _q_, which is
+    # usually an kind of FXToolBarShell window.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the "dry dock" window for this dock bar [FXComposite]
+    # +q+::	the "wet dock" window for this dock bar [FXComposite]
+    # +opts+::	dock bar 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, q, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theDockBar
+    end
+  
+    #
+    # Construct a non-floatable dock bar.
+    # The dock bar can not be undocked.
+    #
+    # ==== Parameters:
+    #
+    # +p+::	the parent window for this dock bar [FXComposite]
+    # +opts+::	dock bar 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, opts=LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x=0, y=0, width=0, height=0, padLeft=3, padRight=3, padTop=2, padBottom=2, hSpacing=DEFAULT_SPACING, vSpacing=DEFAULT_SPACING) # :yields: theDockBar
+    end
+    
+    # Return +true+ if docked
+    def docked? ; end
+
+    #
+    # Return +true+ if the dock bar would dock or undock if at locaton (_barx_, _bary_).
+    #
+    def insideDock?(docksite, barx, bary); end
+
+    #
+    # Set parent when docked.
+    # If it was docked, reparent under the new docking window.
+    #
+    def dryDock=(dry); end
+    
+    # Return parent when docked.
+    def dryDock; end
+
+    #
+    # Set parent when floating.
+    # If it was undocked, then reparent under the new floating window.
+    #
+    def wetDock=(wet); end
+    
+    # Return parent when floating.
+    def wetDock; end
+
+    #
+    # Search for dock against given side of main window.
+    #
+    def findDockAtSide(side=LAYOUT_SIDE_TOP); end
+
+    #
+    # Search for dock close to coordinates (<em>root_x</em>, <em>root_y</em>).
+    #
+    def findDockNear(root_x, root_y); end
+
+    #
+    # Dock the bar against the given side, after some other widget.
+    # However, if after is -1, it will be docked as the innermost bar just before
+    # the work-area, while if after is 0, if will be docked as the outermost bar.
+    #
+    def dock(docksite, before=nil, notify=false); end
+
+    #
+    # Dock the bar against the given side, near the given position relative
+    # to the toolbar dock's origin.
+    #
+    def dock(docksite, local_x, local_y, notify); end
+
+    #
+    # Undock or float the bar.
+    # The initial position of the wet dock is a few pixels
+    # below and to the right of the original docked position.
+    #
+    def undock(root_x, root_y, notify=false); end
+
+    #
+    # Change set of sides (a combination of +ALLOW_TOP+, +ALLOW_LEFT+, etc.), 
+    # where docking is allowed. The default is to allow docking on all sides.
+    #
+    def allowedSides=(allowed); end
+
+    #
+    # Return set of sides where docking is allowed
+    #
+    def allowedSides(); end
+  end
+end
+

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
+