fxruby 1.6.14-universal-darwin-9

data/rdoc-sources/FXExtentd.rb

@@ -0,0 +1,85 @@
+module Fox
+  class FXExtentd
+    # Lower corner of this extent (an FXVec2d instance).
+    attr_reader :lower
+    
+    # Upper corner of this extent (an FXVec2d instance).
+    attr_reader :upper
+    
+    # Default constructor
+    def initialize; end
+
+    # Copy constructor
+    def initialize(ext); end
+
+    # Initialize from two vectors (where _lo_ and _hi_ are two
+    # FXVec2d instances).
+    def initialize(lo, hi); end
+
+    # Initialize from four numbers
+    def initialize(xlo, xhi, ylo, yhi); end
+
+    # Indexing with 0..1 (returns an FXVec2d instance).
+    def [](i); end
+
+    # Return width of box
+    def width; end
+
+    # Return height of box
+    def height; end
+
+    # Return length of longest side
+    def longest; end
+
+    # Return length of shortest side
+    def shortest; end
+
+    # Return length of diagonal
+    def diameter; end
+
+    # Return radius of box
+    def radius; end
+
+    # Compute diagonal vector (returns an FXVec2d)
+    def diagonal; end
+
+    # Return center of box (as an FXVec2d)
+    def center; end
+
+    # Return +true+ if empty
+    def empty?; end
+
+    # Return +true+ if box contains point (_x_, _y_)
+    def contains?(x, y); end
+
+    # Return +true+ if box contains point _p_ (an FXVec2d instance)
+    def contains?(p); end
+
+    # Return +true+ if box properly contains another box (where _ext_ is
+    # another FXExtentd instance).
+    def contains?(ext); end
+
+    # Include point (_x_, _y_) and return a reference to self.
+    def include!(x, y); end
+
+    # Include point _v_ (an FXVec2d instance) and return a reference to self.
+    def include!(v); end
+
+    # Include given range into extent (where _ext_ is another FXExtentd instance)
+    # and return a reference to self.
+    def include!(ext); end
+
+    # Return +true+ if this extent's bounds overlap with _other_ extent's bounds.
+    def overlap?(other); end
+
+    # Return corner number 0, 1, 2 or 3 (as a FXVec2d instance).
+    def corner(c); end
+
+    # Return a new FXExtentd that is the union of this extent and _other_.
+    def unite_with(other); end
+
+    # Return a new FXExtentd that is the intersection of this extent and _other_.
+    def intersect_with(other); end
+  end
+end
+

data/rdoc-sources/FXExtentf.rb

@@ -0,0 +1,85 @@
+module Fox
+  class FXExtentf
+    # Lower corner of this extent (an FXVec2f instance).
+    attr_reader :lower
+    
+    # Upper corner of this extent (an FXVec2f instance).
+    attr_reader :upper
+    
+    # Default constructor
+    def initialize; end
+
+    # Copy constructor
+    def initialize(ext); end
+
+    # Initialize from two vectors (where _lo_ and _hi_ are two
+    # FXVec2f instances).
+    def initialize(lo, hi); end
+
+    # Initialize from four numbers
+    def initialize(xlo, xhi, ylo, yhi); end
+
+    # Indexing with 0..1 (returns an FXVec2f instance).
+    def [](i); end
+
+    # Return width of box
+    def width; end
+
+    # Return height of box
+    def height; end
+
+    # Return length of longest side
+    def longest; end
+
+    # Return length of shortest side
+    def shortest; end
+
+    # Return length of diagonal
+    def diameter; end
+
+    # Return radius of box
+    def radius; end
+
+    # Compute diagonal vector (returns an FXVec2f)
+    def diagonal; end
+
+    # Return center of box (as an FXVec2f)
+    def center; end
+
+    # Return +true+ if empty
+    def empty?; end
+
+    # Return +true+ if box contains point (_x_, _y_)
+    def contains?(x, y); end
+
+    # Return +true+ if box contains point _p_ (an FXVec2f instance)
+    def contains?(p); end
+
+    # Return +true+ if box properly contains another box (where _ext_ is
+    # another FXExtentf instance).
+    def contains?(ext); end
+
+    # Include point (_x_, _y_) and return a reference to self.
+    def include!(x, y); end
+
+    # Include point _v_ (an FXVec2f instance) and return a reference to self.
+    def include!(v); end
+
+    # Include given range into extent (where _ext_ is another FXExtentf instance)
+    # and return a reference to self.
+    def include!(ext); end
+
+    # Return +true+ if this extent's bounds overlap with _other_ extent's bounds.
+    def overlap?(other); end
+
+    # Return corner number 0, 1, 2 or 3 (as a FXVec2f instance).
+    def corner(c); end
+
+    # Return a new FXExtentf that is the union of this extent and _other_.
+    def unite_with(other); end
+
+    # Return a new FXExtentf that is the intersection of this extent and _other_.
+    def intersect_with(other); end
+  end
+end
+

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
+