fxruby 1.2.2

data/rdoc-sources/FXFileDict.rb

@@ -0,0 +1,168 @@
+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
+
+  #
+  # An FXIconDict instance stores a mapping between the file names
+  # for icon files and FXIcon instances built from those icon files.
+  # Unlike a regular "dictionary" or hash-like object, the FXIconDict
+  # constructs and owns its own data (the FXIcon instances).
+  #
+  # If no icon path is specified at construction time, a default icon path
+  # of "~/.foxicons:/usr/local/share/icons:/usr/share/icons" is used.
+  #
+  # The particular subclass of FXIcon used for a given icon file is
+  # deduced from the file extension.
+  #
+  class FXIconDict < FXDict
+  
+    # Associated application [FXApp]
+    attr_reader :app
+    
+    # Current icon search path [String]
+    attr_accessor :iconPath
+    
+    # Return the default icon search path
+    def FXIconDict.defaultIconPath; end
+  
+    #
+    # Return an initialized FXIconDict instance.
+    #
+    #
+    # ==== Parameters:
+    #
+    # +a+::	the application [FXApp]
+    # +p+::
+    #   the search path used to find named icons [String]. If no path is specified,
+    #   the default icon path is used.
+    #
+    def initialize(a, p=defaultIconPath); end
+  
+    #
+    # Insert unique icon loaded from filename into dictionary;
+    # returns a reference to the icon.
+    #
+    def insert(filename); end
+  
+    #
+    # Remove icon from dictionary; returns a reference to the icon.
+    #
+    def remove(name); end
+  
+    # Find icon by name
+    def find(name); end
+  end
+  
+
+
+  #
+  # File association dictionary
+  #
+  class FXFileDict < FXDict
+  
+    # Application [FXApp]
+    attr_reader :app
+    
+    # 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 mapping file-extension to file associations,
+    # using the application registry settings as a source for the bindings.
+    #
+    def initialize(a); end
+  
+    #
+    # Construct a dictionary mapping file-extension to file associations,
+    # using the specified settings database as a source for the bindings.
+    #
+    # ==== Parameters:
+    #
+    # +a+:	Application [FXApp]
+    # +db+::	Settings database [FXSettings]
+    #
+    def initialize(a, db); end
+      return new FXRbFileDict(a,db);
+      }
+    }
+  
+    #
+    # 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 for the specified extension already in dictionary
+    # and return a reference to it.
+    #
+    def find(ext); end
+  
+    #
+    # Find file association from registry for the specified key.
+    #
+    def associate(key); 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,163 @@
+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
+
+  #
+  # File List object
+  #
+  # === File List options
+  #
+  # +FILELIST_SHOWHIDDEN+::	Show hidden files or directories
+  # +FILELIST_SHOWDIRS+::	Show only directories
+  # +FILELIST_SHOWFILES+::	Show only files
+  # +FILELIST_NO_OWN_ASSOC+::	Do not create associations for files
+  #
+  # === Message identifiers
+  #
+  # +ID_SORT_BY_NAME+:: x
+  # +ID_SORT_BY_TYPE+:: x
+  # +ID_SORT_BY_SIZE+:: x
+  # +ID_SORT_BY_TIME+:: x
+  # +ID_SORT_BY_USER+:: x
+  # +ID_SORT_BY_GROUP+:: x
+  # +ID_SORT_REVERSE+:: x
+  # +ID_DIRECTORY_UP+:: x
+  # +ID_SET_PATTERN+:: x
+  # +ID_SET_DIRECTORY+:: x
+  # +ID_SHOW_HIDDEN+:: x
+  # +ID_HIDE_HIDDEN+:: x
+  # +ID_TOGGLE_HIDDEN+:: x
+  # +ID_REFRESHTIMER+:: x
+  # +ID_OPENTIMER+:: x
+  #
+  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
+    
+    # Construct a file list
+    def initialize(p, tgt=nil, sel=0, opts=0, x=0, y=0, w=0, h=0) # :yields: theFileList
+    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
+  end
+end
+

data/rdoc-sources/FXFileSelector.rb

@@ -0,0 +1,148 @@
+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
+  # +SELECTFILE_DIRECTORY+::	Existing directory
+  #
+  # === 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_HOME+::			x
+  # +ID_WORK+::			x
+  # +ID_BOOKMARK+::		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
+  
+    #
+    # Return an initialized FXFileSelector instance.
+    #
+    def initialize(p, tgt=nil, sel=0, opts=0, x=0, y=0, w=0, h=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
+  
+    # 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
+
+    #
+    # 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
+