fxruby 1.6.14-universal-darwin-9

data/rdoc-sources/FXFileList.rb

@@ -0,0 +1,208 @@
+module Fox
+  #
+  # File item
+  #
+  class FXFileItem < FXIconItem
+  
+    # The file association object for this item [FXFileAssoc]
+    attr_reader :assoc
+    
+    # The file size for this item [Integer]
+    attr_reader :size
+    
+    # Date for this item [Time]
+    attr_reader :date
+
+    # Returns an initialized FXFileItem instance
+    def initialize(text, bi=nil, mi=nil, ptr=nil) # :yields: theFileItem
+    end
+  
+    # Return +true+ if this is a file item
+    def file?; end
+  
+    # Return +true+ if this is a directory item
+    def directory?; end
+  
+    # Return +true+ if this is a share item
+    def share?; end
+
+    # Return +true+ if this is an executable item
+    def executable?; end
+  
+    # Return +true+ if this is a symbolic link item
+    def symlink?; end
+  
+    # Return +true+ if this is a character device item
+    def chardev?; end
+  
+    # Return +true+ if this is a block device item
+    def blockdev?; end
+  
+    # Return +true+ if this is an FIFO item
+    def fifo?; end
+  
+    # Return +true+ if this is a socket
+    def socket?; end
+  end
+
+  #
+  # A File List widget provides an icon rich view of the file system.
+  # It automatically updates itself periodically by re-scanning the file system
+  # for any changes.  As it scans the displayed directory, it automatically
+  # determines the icons to be displayed by consulting the file associations registry
+  # settings.  A number of messages can be sent to the File List to control the
+  # filter pattern, sort category, sorting order, case sensitivity, and hidden file
+  # display mode.
+  # The File list widget supports drags and drops of files.
+  #
+  # === File List options
+  #
+  # +FILELIST_SHOWHIDDEN+::	Show hidden files or directories
+  # +FILELIST_SHOWDIRS+::	Show only directories
+  # +FILELIST_SHOWFILES+::	Show only files
+  # +FILELIST_SHOWIMAGES+::	Show preview of images
+  # +FILELIST_NO_OWN_ASSOC+::	Do not create associations for files
+  # +FILELIST_NO_PARENT+::	Suppress display of '.' and '..'
+  #
+  # === Message identifiers
+  #
+  # +ID_SORT_BY_NAME+::		Sort by name
+  # +ID_SORT_BY_TYPE+::		Sort by type
+  # +ID_SORT_BY_SIZE+::		Sort by size
+  # +ID_SORT_BY_TIME+::		Sort by access time
+  # +ID_SORT_BY_USER+::		Sort by user name
+  # +ID_SORT_BY_GROUP+::	Sort by group name
+  # +ID_SORT_REVERSE+::		Reverse sort order
+  # +ID_DIRECTORY_UP+::		Move up one directory
+  # +ID_SET_PATTERN+::		Set match pattern
+  # +ID_SET_DIRECTORY+::	Set directory
+  # +ID_SHOW_HIDDEN+::		Show hidden files
+  # +ID_HIDE_HIDDEN+::		Hide hidden files
+  # +ID_TOGGLE_HIDDEN+::	Toggle visibility of hidden files
+  # +ID_REFRESHTIMER+:: 	x
+  # +ID_OPENTIMER+:: 		x
+  # +ID_TOGGLE_IMAGES+::	Toggle display of images
+  # +ID_REFRESH+::		Refresh immediately
+  #
+  class FXFileList < FXIconList
+  
+    # Current file [String]
+    attr_accessor :currentFile
+    
+    # Current directory [String]
+    attr_accessor :directory
+    
+    # Wildcard matching pattern [String]
+    attr_accessor :pattern
+    
+    # Wildcard matching mode [Integer]
+    attr_accessor :matchMode
+    
+    # File associations [FXFileDict]
+    attr_accessor :associations
+    
+    # Image size for preview images [Integer]
+    attr_accessor :imageSize
+
+    # Construct a file list
+    def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theFileList
+    end
+    
+    #
+    # Set the current file to _filename_.
+    # If _notify_ is +true+, a +SEL_CHANGED+ message is sent to the
+    # file list's message target after the current item has changed.
+    # If this change causes the selected item(s) to change (because
+    # the file list is operating in browse-select mode), +SEL_SELECTED+ and
+    # +SEL_DESELECTED+ may be sent to the message target as well.
+    #
+    def setCurrentFile(filename, notify=false); end
+  
+    #
+    # Scan the current directory and update the items if needed, or if _force_ is +true+.
+    #
+    def scan(force=true); end
+
+    #
+    # Return +true+ if item is a directory.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def itemDirectory?(index); end
+  
+    #
+    # Return +true+ if item is a share.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def itemShare?(index); end
+
+    #
+    # Return +true+ if item is a file.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def itemFile?(index); end
+  
+    #
+    # Return +true+ if item is executable.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def itemExecutable?(index); end
+  
+    #
+    # Return name of item at index.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def itemFilename(index); end
+  
+    #
+    # Return full pathname of item at index.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def itemPathname(index); end
+    
+    #
+    # Return file association of item at index.
+    # Raises IndexError if _index_ is out of bounds.
+    #
+    def itemAssoc(index); end
+  
+    # Return +true+ if showing hidden files.
+    def hiddenFilesShown?; end
+    
+    # Show or hide hidden files.
+    def hiddenFilesShown=(shown); end
+    
+    # Return +true+ if showing directories only.
+    def onlyDirectoriesShown?; end
+    
+    # Show directories only.
+    def onlyDirectoriesShown=(shown); end
+
+    # Return +true+ if showing files only.
+    def onlyFilesShown?; end
+    
+    # Show files only.
+    def onlyFilesShown=(shown); end
+
+    #
+    # If _shown_ is +true+, the file list will show preview images;
+    # otherwise it won't.
+    #
+    def imagesShown=(shown); end
+    
+    #
+    # Return +true+ if the file list is showing preview images.
+    #
+    def imagesShown? ; end
+    
+    #
+    # Return +true+ if parent directories are shown.
+    #
+    def parentDirsShown? ; end
+    
+    #
+    # Set whether parent directories are shown to +true+ or +false+.
+    #
+    def parentDirsShown=(shown); end
+  end
+end
+

data/rdoc-sources/FXFileSelector.rb

@@ -0,0 +1,184 @@
+module Fox
+  #
+  # File selection widget
+  #
+  # === File selection modes
+  #
+  # +SELECTFILE_ANY+::		A single file, existing or not (to save to)
+  # +SELECTFILE_EXISTING+::	An existing file (to load)
+  # +SELECTFILE_MULTIPLE+::	Multiple existing files
+  # +SELECTFILE_MULTIPLE_ALL+::	Multiple existing files or directories, but not '.' and '..'
+  # +SELECTFILE_DIRECTORY+::	Existing directory, including '.' or '..'
+  #
+  # === Wildcard matching modes
+  #
+  # +FILEMATCH_FILE_NAME+::		No wildcard can ever match "/" (or "\","/" under Windows).
+  # +FILEMATCH_NOESCAPE+::		Backslashes don't quote special chars ("\" is treated as "\").
+  # +FILEMATCH_PERIOD+::		Leading "." is matched only explicitly (Useful to match hidden files on Unix).
+  # +FILEMATCH_LEADING_DIR+::	Ignore "/..." after a match.
+  # +FILEMATCH_CASEFOLD+::		Compare without regard to case.
+  #
+  # Note that under Windows, +FILEMATCH_NOESCAPE+ must be passed.
+  #
+  # === Message identifiers
+  #
+  # +ID_FILEFILTER+::		x
+  # +ID_ACCEPT+::		x
+  # +ID_FILELIST+::		x
+  # +ID_DIRECTORY_UP+::		x
+  # +ID_DIRTREE+::		x
+  # +ID_NORMAL_SIZE+::		x
+  # +ID_MEDIUM_SIZE+::		x
+  # +ID_GIANT_SIZE+::		x
+  # +ID_HOME+::			x
+  # +ID_WORK+::			x
+  # +ID_BOOKMARK+::		x
+  # +ID_BOOKMENU+::		x
+  # +ID_VISIT+::		x
+  # +ID_NEW+::			x
+  # +ID_DELETE+::		x
+  # +ID_MOVE+::			x
+  # +ID_COPY+::			x
+  # +ID_LINK+::			x
+  #
+  class FXFileSelector < FXPacker
+  
+    # The "Accept" button [FXButton]
+    attr_reader :acceptButton
+    
+    # The "Cancel" button [FXButton]
+    attr_reader :cancelButton
+
+    # File name [String]
+    attr_accessor :filename
+    
+    # File pattern [String]
+    attr_accessor :pattern
+    
+    # Directory [String]
+    attr_accessor :directory
+    
+    # Current pattern number [Integer]
+    attr_accessor :currentPattern
+
+    # Inter-item spacing (in pixels) [Integer]
+    attr_accessor :itemSpace
+  
+    # Change file list style [Integer]
+    attr_accessor :fileBoxStyle
+  
+    # Change file selection mode [Integer]
+    attr_accessor :selectMode
+    
+    # Wildcard matching mode [Integer]
+    attr_accessor :matchMode
+  
+    # Image size for preview images [Integer]
+    attr_accessor :imageSize
+
+    #
+    # Return an initialized FXFileSelector instance.
+    #
+    def initialize(p, target=nil, selector=0, opts=0, x=0, y=0, width=0, height=0) # :yields: theFileSelector
+    end
+  
+    #
+    # Returns an array of the selected file names.
+    #
+    def filenames; end
+  
+    #
+    # Change the list of file patterns shown in the file selector.
+    # The _patterns_ argument is an array of strings, and each string
+    # represents a different file pattern. A pattern consists of an
+    # optional name, followed by a pattern in parentheses. For example,
+    # this code:
+    #
+    #   patterns = [ "*", "*.cpp,*.cc", "*.hpp,*.hh,*.h" ]
+    #   aFileSelector.setPatternList(patterns)
+    #
+    # and this code:
+    #
+    #   patterns = [ "All Files (*)", "C++ Sources (*.cpp,*.cc)", "C++ Headers (*.hpp,*.hh,*.h)" ]
+    #   aFileSelector.setPatternList(patterns)
+    #
+    # will both set the same three patterns, but the former shows no pattern names.
+    #
+    # For compatibility with the FOX C++ library API of the same name, #setPatternList
+    # also accepts a _patterns_ value that is a single string, with each pattern
+    # separated by newline characters, e.g.
+    #
+    #   patterns = "All Files (*)\nC++ Sources (*.cpp,*.cc)\nC++ Headers (*.hpp,*.hh,*.h)"
+    #   aFileSelector.setPatternList(patterns)
+    #
+    def setPatternList(patterns); end
+  
+    #
+    # Returns the list of patterns (an Array of Strings).
+    #
+    def getPatternList(); end
+
+    # Get pattern text for given pattern number
+    def getPatternText(patno); end
+  
+    # Change pattern text for pattern number
+    def setPatternText(patno, text); end
+  
+    # Return number of patterns.
+    def numPatterns; end
+
+    # Show read-only button.
+    def readOnlyShown=(shown); end
+    
+    # Return +true+ if the read-only button is shown.
+    def readOnlyShown?; end
+    
+    # Set state of read-only button.
+    def readOnly=(state); end
+  
+    # Return +true+ if in read-only mode.
+    def readOnly?; end
+
+    # Return +true+ if showing hidden files and directories
+    def hiddenFilesShown?; end
+    
+    #
+    # If _state_ is +true+, the file selector will show hidden files and
+    # directories; otherwise, it won't.
+    #
+    def hiddenFilesShown=(state); end
+
+    #
+    # If _shown_ is +true+, the file selector will show preview images;
+    # otherwise it won't.
+    #
+    def imagesShown=(shown); end
+    
+    #
+    # Return +true+ if the file selector is showing preview images.
+    #
+    def imagesShown? ; end
+
+    # Return +true+ if navigation allowed.
+    def navigationAllowed?; end
+
+    # Set navigation to allowed (+true+) or disallowed (+false+)
+    def navigationAllowed=(allowed); end
+
+    #
+    # Given filename pattern of the form "GIF Format (*.gif)",
+    # returns the pattern only, i.e. "*.gif" in this case.
+    # If the parentheses are not found then returns the entire
+    # input pattern.
+    #
+    def FXFileSelector.patternFromText(pattern) ; end
+    
+    #
+    # Given a pattern of the form "*.gif,*.GIF", return
+    # the first extension of the pattern, i.e. "gif" in this
+    # example. Returns empty string if it doesn't work out.
+    #
+    def FXFileSelector.extensionFromPattern(pattern) ; end
+  end
+end
+

data/rdoc-sources/FXFileStream.rb

@@ -0,0 +1,27 @@
+module Fox
+  # File Store Definition
+  class FXFileStream < FXStream
+
+    attr_reader :position
+
+    #
+    # Return an initialized FXFileStream instance.
+    #
+    def initialize(cont=nil) # :yields: theFileStream
+    end
+  
+    #
+    # Open binary data file stream; allocate a buffer of the given _size_
+    # for the file I/O; the buffer must be at least 16 bytes. Returns
+    # +true+ on success, +false+ on failure.
+    #
+    # ==== Parameters:
+    #
+    # +filename+::	name of the file to open [String]
+    # +save_or_load+::	access mode, either +FXStreamSave+ or +FXStreamLoad+ [Integer]
+    # +size+::		buffer size [Integer]
+    #
+    def open(filename, save_or_load, size=8192); end
+  end
+end
+