fxrubi 1.6.22.pre1

data/rdoc-sources/FXDirBox.rb

@@ -0,0 +1,55 @@
+module Fox
+  #
+  # A Directory Box widget allows the user to select parts of a file path.
+  # First, it is filled with a string comprising a file path, like "/a/b/c".
+  # Then, the user can select "/a/b/c", "/a/b", "/a", and "/" from the drop-down
+  # list.  The entries in the drop-down list are automatically provided with icons
+  # by consulting the file-associations registry settings.
+  # The Directory Box sends <tt>SEL_CHANGED</tt> and <tt>SEL_COMMAND</tt> messages, with the string
+  # containing the full path to the selected item.
+  #
+  # === Options
+  #
+  # +DIRBOX_NO_OWN_ASSOC+::	do not create associations for files
+  #
+  # === Events
+  #
+  # The following messages are sent by FXDirBox to its target:
+  #
+  # +SEL_CHANGED+::     sent when the current item changes; the message data is the new current directory.
+  # +SEL_COMMAND+::     sent when the current item changes; the message data is the new current directory.
+  #
+  class FXDirBox < FXTreeListBox
+
+    # Current directory [String]
+    attr_accessor :directory
+
+    # File associations [FXFileDict]
+    attr_accessor :associations
+
+    # Return an initialized FXDirBox instance.
+    def initialize(p, target=nil, selector=0, opts=FRAME_SUNKEN|FRAME_THICK|TREELISTBOX_NORMAL, x=0, y=0, width=0, height=0, padLeft=DEFAULT_PAD, padRight=DEFAULT_PAD, padTop=DEFAULT_PAD, padBottom=DEFAULT_PAD) # :yields: theDirBox
+    end
+
+    #
+    # Set current directory
+    #
+    def setDirectory(pathname); end
+    
+    #
+    # Return current directory
+    #
+    def getDirectory(); 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/FXDirDialog.rb

@@ -0,0 +1,47 @@
+module Fox
+  #
+  # Directory selection dialog
+  #
+  class FXDirDialog < FXDialogBox
+  
+    # 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
+    
+    # Returns an initialized FXDirDialog instance.
+    def initialize(owner, name, opts=0, x=0, y=0, width=500, height=300) # :yields: theDirDialog
+    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
+
+    #
+    # Display a directory dialog with the specified owner window, caption
+    # string and initial path string.
+    # Return the selected directory name (a string) or +nil+ if the dialog
+    # was cancelled.
+    #
+    def FXDirDialog.getOpenDirectory(owner, caption, path); end
+  end
+end
+

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
+