fxruby 1.6.13-mswin32

data/rdoc-sources/FXFileDialog.rb

@@ -0,0 +1,217 @@
+module Fox
+  #
+  # File selection dialog
+  #
+  # Each pattern in the _patternList_ comprises an optional name, followed by
+  # a pattern in parentheses. The patterns are separated by newlines.
+  # For example,
+  #
+  #  fileDialog.patternList = ["*",
+  #                            "*.cpp,*.cc",
+  #                            "*.hpp,*.hh,*.h"
+  #                           ]
+  #
+  # and
+  #
+  #  fileDialog.patternList = ["All Files (*)",
+  #                            "C++ Sources (*.cpp,*.cc)",
+  #                            "C++ Headers (*.hpp,*.hh,*.h)"
+  #                           ]
+  #
+  # will set the same three patterns, but the former shows no pattern names.
+  #
+  # === 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.
+  #
+  class FXFileDialog < FXDialogBox
+
+    # File name [String]
+    attr_accessor :filename
+    
+    # List of selected filenames [Array]
+    attr_reader :filenames
+    
+    # File pattern [String]
+    attr_accessor :pattern
+    
+    # Current pattern number [Integer]
+    attr_accessor :currentPattern
+    
+    # Directory [String]
+    attr_accessor :directory
+    
+    # Inter-item spacing (in pixels) [Integer]
+    attr_accessor :itemSpace
+    
+    # File list style [Integer]
+    attr_accessor :fileBoxStyle
+    
+    # File selection mode [Integer]
+    attr_accessor :selectMode
+    
+    # Wildcard matching mode [Integer]
+    attr_accessor :matchMode
+    
+    # Image size for preview images [Integer]
+    attr_accessor :imageSize
+
+    # Construct a file dialog box
+    def initialize(owner, name, opts=0, x=0, y=0, width=500, height=300) # :yields: theFileDialog
+    end
+
+    #
+    # Change the list of file patterns shown in the file dialog.
+    # 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
+
+    #
+    # Change whether this file dialog allows pattern entry or not.
+    #
+    def allowsPatternEntry=(allowed); end
+    
+    #
+    # Return +true+ if this file dialog allows pattern entry
+    #
+    def allowsPatternEntry? ; end
+
+    # Set visibility of the read-only button, where _shown_ is either +true+ or +false+
+    def showReadOnly=(shown); end
+    
+    # Return +true+ if read-only button is shown
+    def readOnlyShown?; end
+    
+    # Return +true+ if showing hidden files and directories
+    def hiddenFilesShown?; end
+    
+    #
+    # If _state_ is +true+, the file dialog will show hidden files and
+    # directories; otherwise, it won't.
+    #
+    def hiddenFilesShown=(state); end
+
+    #
+    # If _shown_ is +true+, the file dialog will show preview images;
+    # otherwise it won't.
+    #
+    def imagesShown=(shown); end
+    
+    #
+    # Return +true+ if the file dialog is showing preview images.
+    #
+    def imagesShown? ; end
+    
+    # Set initial state of read-only button, where _state_ is either +true+ or +false+
+    def readOnly=(state); end
+  
+    # Return +true+ if read-only
+    def readOnly?; end
+  
+    # Return +true+ if navigation allowed.
+    def navigationAllowed?; end
+
+    # Set navigation to allowed (+true+) or disallowed (+false+)
+    def navigationAllowed=(allowed); end
+
+    #
+    # Display a dialog box that allows the user to select a single existing file name
+    # for opening.
+    # Returns the selected file name (a String).
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		the owner window for the dialog box [FXWindow]
+    # +caption+::	the caption for the dialog box [String]
+    # +path+::		the initial filename [String]
+    # +patterns+::	the pattern list [String]
+    # +initial+::	the initial pattern to be used (an index into the pattern list) [Integer]
+    #
+    def FXFileDialog.getOpenFilename(owner, caption, path, patterns="*", initial=0); end
+  
+    #
+    # Display a dialog box that allows the user to select multiple existing file names
+    # for opening.
+    # Returns an array of the selected file names (an array of strings).
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		the owner window for the dialog box [FXWindow]
+    # +caption+::	the caption for the dialog box [String]
+    # +path+::		the initial filename [String]
+    # +patterns+::	the pattern list [String]
+    # +initial+::	the initial pattern to be used (an index into the pattern list) [Integer]
+    #
+    def FXFileDialog.getOpenFilenames(owner, caption, path, patterns="*", initial=0); end
+  
+    #
+    # Display a dialog box that allows the user to select an existing file name, or
+    # enter a new file name, for saving.
+    # Returns the save file name (a String).
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		the owner window for the dialog box [FXWindow]
+    # +caption+::	the caption for the dialog box [String]
+    # +path+::		the initial filename [String]
+    # +patterns+::	the pattern list [String]
+    # +initial+::	the initial pattern to be used (an index into the pattern list) [Integer]
+    #
+    def FXFileDialog.getSaveFilename(owner, caption, path, patterns="*", initial=0); end
+  
+    #
+    # Display a dialog box that allows the user to select a directory.
+    # Returns the directory name (a String).
+    #
+    # ==== Parameters:
+    #
+    # +owner+::		the owner window for the dialog box [FXWindow]
+    # +caption+::	the caption for the dialog box [String]
+    # +path+::		the initial directory path [String]
+    #
+    def FXFileDialog.getOpenDirectory(owner, caption, path); end
+  end
+end
+

data/rdoc-sources/FXFileDict.rb

@@ -0,0 +1,131 @@
+module Fox
+  #
+  # Registers stuff to know about the extension
+  #
+  class FXFileAssoc
+    # Command to execute [String]
+    attr_accessor :command
+    
+    # Full extension name [String]
+    attr_accessor :extension
+    
+    # Mime type name [String]
+    attr_accessor :mimetype
+    
+    # Big normal icon [FXIcon]
+    attr_accessor :bigicon
+    
+    # Big open icon [FXIcon]
+    attr_accessor :bigiconopen
+    
+    # Mini normal icon [FXIcon]
+    attr_accessor :miniicon
+    
+    # Mini open icon [FXIcon]
+    attr_accessor :miniiconopen
+    
+    # Registered drag type [FXDragType]
+    attr_accessor :dragtype
+    
+    # Flags [Integer]
+    attr_accessor :flags
+    
+    # Returns an initialized FXFileAssoc instance
+    def initialize; end
+  end
+
+  #
+  # The File Association dictionary associates a file extension with a File
+  # Association record which contains command name, mime type, icons, and other
+  # information about the file type.  The icons referenced by the file association
+  # are managed by the Icon Dictionary; this guarantees that each icon is loaded
+  # only once into memory.
+  # The associations are determined by the information by the FOX Registry settings;
+  # each entry under the FILETYPES registry section comprises the command line,
+  # extension name, large icon, small icon, and mime type:
+  #
+  #   command ';' extension ';' bigicon [ ':' bigiconopen ] ';' icon [ ':' iconopen ] ';' mime
+  #
+  # For example, the binding for "jpg" could be:
+  #
+  #   xv %s &;JPEG Image;bigimage.xpm;miniimage.xpm;image/jpeg
+  #
+  # The association for a file name is determined by first looking at the entire
+  # file name, then at the whole extension, and then at sub-extensions.
+  # For example, "name.tar.gz", "tar.gz", and "gz" can each be given a different
+  # file association.  Directory names may also be given associations; there is
+  # no command-line association for a directory, however.  The association for a
+  # directory is found by first checking the whole pathname, then checking the
+  # pathname less the first component, and so on.  So, "/usr/local/include",
+  # "/local/include", and "/include" can each be given their own file associations.
+  # If the above lookup procedure has not found a file association, the system
+  # uses a fallback associations: for files, the fallback association is determined
+  # by the binding "defaultfilebinding".  For directories, the "defaultdirbinding"
+  # is used, and for executables the "defaultexecbinding" is used.
+  #
+  class FXFileDict < FXDict
+  
+    # Settings database [FXSettings]
+    attr_accessor :settings
+  
+    # Current icon search path [FXIconDict]
+    attr_accessor :iconDict
+
+    # Current icon search path [String]
+    attr_accessor :iconPath
+    
+    # Return the registry key used to find fallback executable icons.
+    def FXFileDict.defaultExecBinding(); end
+  
+    # Return the registry key used to find fallback directory icons.
+    def FXFileDict.defaultDirBinding(); end
+
+    # Return the registry key used to find fallback document icons.
+    def FXFileDict.defaultFileBinding(); end
+  
+    #
+    # Construct a dictionary that maps file extensions to file associations.
+    # If _db_ is not +nil+, the specified settings database is used as a
+    # source for the bindings.
+    # Otherwise, the application registry settings are used.
+    #
+    # ==== Parameters:
+    #
+    # +app+:	Application [FXApp]
+    # +db+::	Settings database [FXSettings]
+    #
+    def initialize(app, db=nil); end
+  
+    #
+    # Replace file association for the specified extension;
+    # returns a reference to the file association.
+    #
+    # ==== Parameters:
+    #
+    # +ext+::	Extension [String]
+    # +str+::	String [String]
+    #
+    def replace(ext, str); end
+  
+    #
+    # Remove file association for the specified extension
+    # and return a reference to it.
+    #
+    def remove(ext); end
+  
+    #
+    # Find file association from registry for the specified key.
+    #
+    def find(ext); end
+
+    # Returns a reference to the FXFileAssoc instance...
+    def findFileBinding(pathname); end
+
+    # Returns a reference to the FXFileAssoc instance...
+    def findDirBinding(pathname); end
+
+    # Returns a reference to the FXFileAssoc instance...
+    def findExecBinding(pathname); end
+  end
+end
+

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
+