Class Fox::FXFileList
In: rdoc-sources/FXFileList.rb
Parent: FXIconList

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

Methods

Attributes

associations  [RW]  File associations [FXFileDict]
currentFile  [RW]  Current file [String]
directory  [RW]  Current directory [String]
imageSize  [RW]  Image size for preview images [Integer]
matchMode  [RW]  Wildcard matching mode [Integer]
pattern  [RW]  Wildcard matching pattern [String]

Public Class methods

Public Instance methods

Show or hide hidden files.

Return true if showing hidden files.

If shown is true, the file list will show preview images; otherwise it won‘t.

Return true if the file list is showing preview images.

Return file association of item at index. Raises IndexError if index is out of bounds.

Return true if item is a directory. Raises IndexError if index is out of bounds.

Return true if item is executable. Raises IndexError if index is out of bounds.

Return true if item is a file. Raises IndexError if index is out of bounds.

Return name of item at index. Raises IndexError if index is out of bounds.

Return full pathname of item at index. Raises IndexError if index is out of bounds.

Return true if item is a share. Raises IndexError if index is out of bounds.

Show directories only.

Return true if showing directories only.

Show files only.

Return true if showing files only.

Set whether parent directories are shown to true or false.

Return true if parent directories are shown.

Scan the current directory and update the items if needed, or if force is true.

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.

[Validate]