fxruby 1.2.6 → 1.4.0

data/rdoc-sources/FXDockTitle.rb

@@ -0,0 +1,26 @@
+module Fox
+  #
+  # A dock title is used to move its container, a dock bar.
+  # The dock title is also used simultaneously to provide a
+  # caption above the dock bar.
+  #
+  class FXDockTitle < FXDockHandler
+    # Caption text for the grip [String]
+    attr_accessor :caption
+    
+    # Caption font [FXFont]
+    attr_accessor :font
+    
+    # Caption color [FXColor]
+    attr_accessor :captionColor
+    
+    # Current justification mode [Integer]
+    attr_accessor :justify
+
+    #
+    # Construct dock bar title widget
+    #
+    def initialize(p, text, tgt=nil, sel=0, opts=FRAME_NORMAL|JUSTIFY_CENTER_X|JUSTIFY_CENTER_Y, x=0, y=0, w=0, h=0, pl=0, pr=0, pt=0, pb=0)
+    end
+  end
+end

data/rdoc-sources/FXFileDialog.rb

@@ -58,6 +58,9 @@ module Fox
     
     # 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, w=500, h=300) # :yields: theFileDialog
@@ -104,12 +107,42 @@ module Fox
     # Change pattern text for pattern number
     def setPatternText(patno, text); 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
   

data/rdoc-sources/FXFileDict.rb

@@ -35,66 +35,39 @@ module Fox
   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).
+  # 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:
   #
-  # If no icon path is specified at construction time, a default icon path
-  # of "~/.foxicons:/usr/local/share/icons:/usr/share/icons" is used.
+  #   command ';' extension ';' bigicon [ ':' bigiconopen ] ';' icon [ ':' iconopen ] ';' mime
   #
-  # The particular subclass of FXIcon used for a given icon file is
-  # deduced from the file extension.
+  # For example, the binding for "jpg" could be:
   #
-  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
-  
-
-
+  #   xv %s &;JPEG Image;bigimage.xpm;miniimage.xpm;image/jpeg
   #
-  # File association dictionary
+  # 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
   
-    # Application [FXApp]
-    attr_reader :app
-    
+    # Current icon search path [FXIconDict]
+    attr_accessor :iconDict
+
     # Current icon search path [String]
     attr_accessor :iconPath
     
@@ -111,7 +84,7 @@ module Fox
     # Construct a dictionary mapping file-extension to file associations,
     # using the application registry settings as a source for the bindings.
     #
-    def initialize(a); end
+    def initialize(app); end
   
     #
     # Construct a dictionary mapping file-extension to file associations,
@@ -119,10 +92,10 @@ module Fox
     #
     # ==== Parameters:
     #
-    # +a+:	Application [FXApp]
+    # +app+:	Application [FXApp]
     # +db+::	Settings database [FXSettings]
     #
-    def initialize(a, db); end
+    def initialize(app, db); end
       return new FXRbFileDict(a,db);
       }
     }

data/rdoc-sources/FXFileList.rb

@@ -46,32 +46,41 @@ module Fox
   end
 
   #
-  # File List object
+  # 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.
   #
   # === 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
   #
   # === 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
+  # +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
   
@@ -90,6 +99,9 @@ module Fox
     # File associations [FXFileDict]
     attr_accessor :associations
     
+    # Image size for preview images [Integer]
+    attr_accessor :imageSize
+
     # Construct a file list
     def initialize(p, tgt=nil, sel=0, opts=0, x=0, y=0, w=0, h=0) # :yields: theFileList
     end
@@ -158,6 +170,17 @@ module Fox
     
     # 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
   end
 end
 

data/rdoc-sources/FXFileSelector.rb

@@ -7,8 +7,8 @@ module Fox
   # +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
+  # +SELECTFILE_MULTIPLE_ALL+::	Multiple existing files or directories, but not '.' and '..'
+  # +SELECTFILE_DIRECTORY+::	Existing directory, including '.' or '..'
   #
   # === Wildcard matching modes
   #
@@ -27,6 +27,9 @@ module Fox
   # +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
@@ -69,6 +72,9 @@ module Fox
     # Wildcard matching mode [Integer]
     attr_accessor :matchMode
   
+    # Image size for preview images [Integer]
+    attr_accessor :imageSize
+
     #
     # Return an initialized FXFileSelector instance.
     #
@@ -129,6 +135,26 @@ module Fox
     # 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
+
     #
     # Given filename pattern of the form "GIF Format (*.gif)",
     # returns the pattern only, i.e. "*.gif" in this case.

data/rdoc-sources/FXFileStream.rb

@@ -1,6 +1,9 @@
 module Fox
   # File Store Definition
   class FXFileStream < FXStream
+
+    attr_reader :position
+
     #
     # Return an initialized FXFileStream instance.
     #

data/rdoc-sources/FXFoldingList.rb

@@ -86,9 +86,6 @@ module Fox
     # Change has items flag to +true+ or +false+.
     def hasItems=(flag); end
 
-    # Returns +true+ if this item owns its icons
-    def iconOwned? ; end
-    
     #
     # Return +true+ if this item is a descendant of _item_.
     #
@@ -118,6 +115,18 @@ module Fox
 
     # Destroy this folding item
     def destroy; end
+    
+    #
+    # Change open icon to _icn_, deleting old icon if it was owned.
+    # If _owned_ is +true+, mark _icn_ as owned by this folding item.
+    #
+    def setOpenIcon(icn, owned=false); end
+    
+    #
+    # Change closed icon to _icn_, deleting old icon if it was owned.
+    # If _owned_ is +true+, mark _icn_ as owned by this folding item.
+    #
+    def setClosedIcon(icn, owned=false); end
   end
 
   # 
@@ -179,50 +188,56 @@ module Fox
 
   class FXFoldingList < FXScrollArea
 
+    # Header control [FXHeader]
+    attr_reader :header
+    
+    # Number of header items [Integer]
+    attr_reader :numHeaders
+    
     # Number of items [Integer]
-    attr_reader		:numItems
+    attr_reader	:numItems
 
     # Number of visible items [Integer]
-    attr_accessor	:numVisible
+    attr_accessor :numVisible
 
     # First root-level item [FXFoldingItem]
-    attr_reader		:firstItem
+    attr_reader :firstItem
 
     # Last root-level item [FXFoldingItem]
-    attr_reader		:lastItem
+    attr_reader :lastItem
 
     # Current item, if any [FXFoldingItem]
-    attr_accessor	:currentItem
+    attr_accessor :currentItem
 
     # Anchor item, if any [FXFoldingItem]
-    attr_accessor	:anchorItem
+    attr_accessor :anchorItem
 
     # Item under the cursor, if any [FXFoldingItem]
-    attr_reader		:cursorItem
+    attr_reader	:cursorItem
 
     # Text font [FXFont]
-    attr_accessor	:font
+    attr_accessor :font
 
     # Parent-child indent amount, in pixels [Integer]
-    attr_accessor	:indent
+    attr_accessor :indent
 
     # Normal text color [FXColor]
-    attr_accessor	:textColor
+    attr_accessor :textColor
 
     # Selected text background color [FXColor]
-    attr_accessor	:selBackColor
+    attr_accessor :selBackColor
 
     # Selected text color [FXColor]
-    attr_accessor	:selTextColor
+    attr_accessor :selTextColor
 
     # Line color [FXColor]
-    attr_accessor	:lineColor
+    attr_accessor :lineColor
 
     # List style [Integer]
-    attr_accessor	:listStyle
+    attr_accessor :listStyle
 
     # Status line help text for this list [String]
-    attr_accessor	:helpText
+    attr_accessor :helpText
 
     #
     # Return an initialized FXFoldingList instance; the folding list is initially empty.
@@ -241,68 +256,78 @@ module Fox
     def initialize(p, tgt=nil, sel=0, opts=TREELIST_NORMAL, x=0, y=0, w=0, h=0) # :yields: theFoldingList
     end
 
-    # Prepend a new (possibly subclassed) _item_ as first child of _parentItem_.
-    # Returns a reference to the newly added item (an FXFoldingItem instance).
-    # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
-    # target after the item is added.
-    def addItemFirst(parentItem, item, notify=false); end
-  
-    # Prepend a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_, as first child of _parentItem_.
-    # Returns a reference to the newly added item (an FXFoldingItem instance).
+    # Set headers from an array of strings.
+    def setHeaders(headers, size=1); end
+
+    # Append header with given text and optional icon
+    def appendHeader(text, icon=nil, size=1); end
+
+    # Remove header at index
+    def removeHeader(index); end
+
+    # Change text of header at index
+    def setHeaderText(index, text); end
+
+    # Return text of header at index
+    def getHeaderText(index); end
+
+    # Change icon of header at index
+    def setHeaderIcon(index, icon); end
+
+    # Return icon of header at index
+    def getHeaderIcon(index); end
+
+    # Change size of header at index
+    def setHeaderSize(index, size); end
+
+    # Return width of header at index
+    def getHeaderSize(index); end
+
+    # Fill list by appending items from array of strings and return the number
+    # of items created.
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
-    # target after the item is added.
-    def addItemFirst(parentItem, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+    # target after each item is added.
+    def fillItems(father, strings, oi=nil, ci=nil, ptr=nil, notify=false); end
   
-    # Append a new (possibly subclassed) _item_ as last child of _parentItem_.
+    # Insert a (possibly subclassed) _item_ under _father_, before _other_.
     # Returns a reference to the newly added item (an FXFoldingItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemLast(parentItem, item, notify=false); end
+    def insertItem(other, father, item, notify=false); end
   
-    # Append a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_, as last child of _parentItem_.
+    # Insert item with given text and optional icons, and user-data pointer under _father_ before _other_ item..
     # Returns a reference to the newly added item (an FXFoldingItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemLast(parentItem, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+    def insertItem(other, father, text, oi=nil, ci=nil, ptr=nil, notify=false); end
   
-    # Append a new (possibly subclassed) _item_ after _otherItem_. 
+    # Append (possibly subclassed) _item_ as last child of _father_.. 
     # Returns a reference to the newly added item (an FXFoldingItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemAfter(otherItem, item, notify=false); end
+    def appendItem(father, item, notify=false); end
   
-    # Append a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_ after _otherItem_. 
+    # Append a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_
+    # as last child of _father_. 
     # Returns a reference to the newly added item (an FXFoldingItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemAfter(otherItem, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+    def appendItem(father, text, oi=nil, ci=nil, ptr=nil, notify=false); end
   
-    # Prepend a new (possibly subclassed) _item_ prior to _otherItem_. 
+    # Prepend (possibly subclassed) _item_ as first child of _father_. 
     # Returns a reference to the newly added item (an FXFoldingItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemBefore(otherItem, item, notify=false); end
+    def prependItem(father, item, notify=false); end
   
-    # Prepend a new item with given _text_ and optional _openIcon_, _closedIcon_ and user _data_ prior to _otherItem_. 
+    # Prepend a new item with given _text_ and optional icons and user data as first child of _father_. 
     # Returns a reference to the newly added item (an FXFoldingItem instance).
     # If _notify_ is +true+, a +SEL_INSERTED+ message is sent to the list's message
     # target after the item is added.
-    def addItemBefore(otherItem, text, openIcon=nil, closedIcon=nil, data=nil, notify=false); end
+    def prependItem(father, text, oi=nil, ci=nil, ptr=nil, notify=false); end
 
-    #
-    # Reparent _item_ under _parentItem_.
-    #
-    def reparentItem(item, parentItem); end
-  
-    #
-    # Move _item_ before _otherItem_ and return a reference to the moved _item_.
-    #
-    def moveItemBefore(otherItem, item); end
-  
-    #
-    # Move _item_ after _otherItem_ and return a reference to the moved _item_.
-    #
-    def moveItemAfter(otherItem, item); end
+    # Move _item_ under _father_ before _other_ item.
+    def moveItem(other, father, item); end
 
     # Remove item.
     # If _notify_ is +true+, a +SEL_DELETED+ message is sent to the list's message
@@ -325,10 +350,25 @@ module Fox
     # Return item height
     def getItemHeight(item); end
 
-    # Search items for item by _text_, starting from _startItem_; the
-    # _flags_ argument controls the search direction, and case sensitivity.
-    # Returns a reference to the matching item, or +nil+ if no match is found.
-    def findItem(text, startItem=nil, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+    # Search items by name, beginning from item _start_. If the start item
+    # is +nil+ the search will start at the first, top-most item in the list.
+    # Flags may be +SEARCH_FORWARD+ or +SEARCH_BACKWARD+ to control the search
+    # direction; this can be combined with +SEARCH_NOWRAP+ or +SEARCH_WRAP+
+    # to control whether the search wraps at the start or end of the list.
+    # The option +SEARCH_IGNORECASE+ causes a case-insensitive match.  Finally,
+    # passing +SEARCH_PREFIX+ causes searching for a prefix of the item name.
+    # Returns +nil+ if no matching item is found.
+    def findItem(text, start=nil, flags=SEARCH_FORWARD|SEARCH_WRAP); end
+
+    # Search items by associated user data, beginning from item _start_. If the start item
+    # is +nil+ the search will start at the first, top-most item in the list.
+    # Flags may be +SEARCH_FORWARD+ or +SEARCH_BACKWARD+ to control the search
+    # direction; this can be combined with +SEARCH_NOWRAP+ or +SEARCH_WRAP+
+    # to control whether the search wraps at the start or end of the list.
+    # The option +SEARCH_IGNORECASE+ causes a case-insensitive match.  Finally,
+    # passing +SEARCH_PREFIX+ causes searching for a prefix of the item name.
+    # Returns +nil+ if no matching item is found.
+    def findItemByData(ptr, start=nil, flags=SEARCH_FORWARD|SEARCH_WRAP); end
 
     # Scroll the list to make _item_ visible
     def makeItemVisible(item); end
@@ -339,14 +379,16 @@ module Fox
     # Return item's text
     def getItemText(item); end
   
-    # Change item's open icon
-    def setItemOpenIcon(item, openIcon); end
+    # Change item's open icon, deleting old icon if it was owned.
+    # If _owned_ is +true+, mark _icn_ as owned by this folding item.
+    def setItemOpenIcon(item, icn, owned=false); end
     
     # Return item's open icon
     def getItemOpenIcon(item); end
     
-    # Change item's closed icon
-    def setItemClosedIcon(item, closedIcon); end
+    # Change item's closed icon, deleting old icon if it was owned.
+    # If _owned_ is +true+, mark _icn_ as owned by this folding item.
+    def setItemClosedIcon(item, icn, owned=false); end
     
     # Return item's closed icon
     def getItemClosedIcon(item); end