A File List widget provides an icon rich view of the file system. More...

#include <FXFileList.h>

Inheritance diagram for FX::FXFileList:

Public Types
enum	{ ID_OPENTIMER = FXIconList::ID_LAST, ID_REFRESHTIMER, ID_DROPASK, ID_DROPCOPY, ID_DROPMOVE, ID_DROPLINK, ID_PREVIEWCHORE, ID_SORT_BY_NAME, ID_SORT_BY_TYPE, ID_SORT_BY_SIZE, ID_SORT_BY_TIME, ID_SORT_BY_USER, ID_SORT_BY_GROUP, ID_SORT_REVERSE, ID_SORT_CASE, ID_DIRECTORY_UP, ID_SET_PATTERN, ID_SET_DIRECTORY, ID_SHOW_HIDDEN, ID_HIDE_HIDDEN, ID_TOGGLE_HIDDEN, ID_TOGGLE_IMAGES, ID_REFRESH, ID_CUT_SEL, ID_COPY_SEL, ID_DELETE_SEL, ID_PASTE_SEL, ID_LAST }
Public Member Functions
long	onOpenTimer (FXObject , FXSelector, void )
long	onRefreshTimer (FXObject , FXSelector, void )
long	onPreviewChore (FXObject , FXSelector, void )
long	onDNDEnter (FXObject , FXSelector, void )
long	onDNDLeave (FXObject , FXSelector, void )
long	onDNDMotion (FXObject , FXSelector, void )
long	onDNDDrop (FXObject , FXSelector, void )
long	onDNDRequest (FXObject , FXSelector, void )
long	onBeginDrag (FXObject , FXSelector, void )
long	onEndDrag (FXObject , FXSelector, void )
long	onDragged (FXObject , FXSelector, void )
long	onClipboardLost (FXObject , FXSelector, void )
long	onClipboardRequest (FXObject , FXSelector, void )
long	onCmdSetValue (FXObject , FXSelector, void )
long	onCmdGetStringValue (FXObject , FXSelector, void )
long	onCmdSetStringValue (FXObject , FXSelector, void )
long	onCmdDirectoryUp (FXObject , FXSelector, void )
long	onUpdDirectoryUp (FXObject , FXSelector, void )
long	onCmdSortByName (FXObject , FXSelector, void )
long	onUpdSortByName (FXObject , FXSelector, void )
long	onCmdSortByType (FXObject , FXSelector, void )
long	onUpdSortByType (FXObject , FXSelector, void )
long	onCmdSortBySize (FXObject , FXSelector, void )
long	onUpdSortBySize (FXObject , FXSelector, void )
long	onCmdSortByTime (FXObject , FXSelector, void )
long	onUpdSortByTime (FXObject , FXSelector, void )
long	onCmdSortByUser (FXObject , FXSelector, void )
long	onUpdSortByUser (FXObject , FXSelector, void )
long	onCmdSortByGroup (FXObject , FXSelector, void )
long	onUpdSortByGroup (FXObject , FXSelector, void )
long	onCmdSortReverse (FXObject , FXSelector, void )
long	onUpdSortReverse (FXObject , FXSelector, void )
long	onCmdSortCase (FXObject , FXSelector, void )
long	onUpdSortCase (FXObject , FXSelector, void )
long	onCmdSetPattern (FXObject , FXSelector, void )
long	onUpdSetPattern (FXObject , FXSelector, void )
long	onCmdSetDirectory (FXObject , FXSelector, void )
long	onUpdSetDirectory (FXObject , FXSelector, void )
long	onCmdToggleHidden (FXObject , FXSelector, void )
long	onUpdToggleHidden (FXObject , FXSelector, void )
long	onCmdShowHidden (FXObject , FXSelector, void )
long	onUpdShowHidden (FXObject , FXSelector, void )
long	onCmdHideHidden (FXObject , FXSelector, void )
long	onUpdHideHidden (FXObject , FXSelector, void )
long	onCmdToggleImages (FXObject , FXSelector, void )
long	onUpdToggleImages (FXObject , FXSelector, void )
long	onCmdHeader (FXObject , FXSelector, void )
long	onUpdHeader (FXObject , FXSelector, void )
long	onCmdRefresh (FXObject , FXSelector, void )
long	onCmdCutSel (FXObject , FXSelector, void )
long	onCmdCopySel (FXObject , FXSelector, void )
long	onCmdPasteSel (FXObject , FXSelector, void )
long	onCmdDeleteSel (FXObject , FXSelector, void )
long	onCmdDropAsk (FXObject , FXSelector, void )
long	onCmdDropCopy (FXObject , FXSelector, void )
long	onCmdDropMove (FXObject , FXSelector, void )
long	onCmdDropLink (FXObject , FXSelector, void )
	FXFileList (FXComposite p, FXObject tgt=NULL, FXSelector sel=0, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
	Construct a file list.
virtual void	create ()
	Create server-side resources.
virtual void	detach ()
	Detach server-side resources.
virtual void	destroy ()
	Destroy server-side resources.
void	scan (FXbool force=true)
	Scan the current directory and update the items if needed, or if force is true.
void	setCurrentFile (const FXString &file, FXbool notify=false)
	Set current file.
FXString	getCurrentFile () const
	Return current file.
FXString *	getSelectedFiles () const
	Get selected files.
void	setDirectory (const FXString &path, FXbool notify=false)
	Set current directory.
FXString	getDirectory () const
	Return current directory.
void	setPattern (const FXString &ptrn)
	Change wildcard matching pattern.
FXString	getPattern () const
	Return wildcard pattern.
FXString	getItemFilename (FXint index) const
	Return name of item at index.
FXString	getItemPathname (FXint index) const
	Return full pathname of item at index.
FXbool	isItemFile (FXint index) const
	Return true if item is a file.
FXbool	isItemDirectory (FXint index) const
	Return true if item is a directory.
FXbool	isItemExecutable (FXint index) const
	Return true if item is executable.
FXbool	isItemSymlink (FXint index) const
	Return true if this is a symbolic link item.
FXbool	isItemNavigational (FXint index) const
	Return true if item is navigational item like '.' or '..'.
FXFileAssoc *	getItemAssoc (FXint index) const
	Return file association of item.
FXlong	getItemSize (FXint index) const
	Return the file size for this item.
FXTime	getItemDate (FXint index) const
	Return the date for this item, in nanoseconds.
FXuint	getItemMode (FXint index) const
	Return the mode bits for this item.
void	setMatchMode (FXuint mode)
	Change wildcard matching mode (see FXPath)
FXuint	getMatchMode () const
	Return wildcard matching mode.
void	showHiddenFiles (FXbool flag)
	Show or hide hidden files.
FXbool	showHiddenFiles () const
	Return true if showing hidden files.
void	showOnlyDirectories (FXbool flag)
	Show directories only.
FXbool	showOnlyDirectories () const
	Return true if showing directories only.
void	showOnlyFiles (FXbool flag)
	Show files only.
FXbool	showOnlyFiles () const
	Return true if showing files only.
void	showParents (FXbool flag)
	Show parent directories.
FXbool	showParents () const
	Return true if showing parent directories.
void	showImages (FXbool flag)
	Show or hide preview images.
FXbool	showImages () const
	Return true if image preview on.
void	setImageSize (FXint size)
	Change images preview size.
FXint	getImageSize () const
	Return images preview size.
void	setAssociations (FXFileDict *assoc, FXbool owned=false)
	Change file associations; delete the old one unless it was shared.
FXFileDict *	getAssociations () const
	Return file associations.
void	setDraggableFiles (FXbool flag)
	Set draggable files.
FXbool	getDraggableFiles () const
	Are draggable files.
virtual void	save (FXStream &store) const
	Save to stream.
virtual void	load (FXStream &store)
	Load from stream.
virtual	~FXFileList ()
	Destructor.
Static Public Member Functions
static FXint	ascending (const FXIconItem a, const FXIconItem b)
static FXint	descending (const FXIconItem a, const FXIconItem b)
static FXint	ascendingCase (const FXIconItem a, const FXIconItem b)
static FXint	descendingCase (const FXIconItem a, const FXIconItem b)
static FXint	ascendingType (const FXIconItem a, const FXIconItem b)
static FXint	descendingType (const FXIconItem a, const FXIconItem b)
static FXint	ascendingSize (const FXIconItem a, const FXIconItem b)
static FXint	descendingSize (const FXIconItem a, const FXIconItem b)
static FXint	ascendingTime (const FXIconItem a, const FXIconItem b)
static FXint	descendingTime (const FXIconItem a, const FXIconItem b)
static FXint	ascendingUser (const FXIconItem a, const FXIconItem b)
static FXint	descendingUser (const FXIconItem a, const FXIconItem b)
static FXint	ascendingGroup (const FXIconItem a, const FXIconItem b)
static FXint	descendingGroup (const FXIconItem a, const FXIconItem b)
Protected Member Functions
void	listItems (FXbool force)
FXIcon *	getItemPreviewIcon (FXint index) const
virtual FXIconItem *	createItem (const FXString &text, FXIcon big, FXIcon mini, void *ptr)
Protected Attributes
FXFileDict *	associations
FXFileItem *	list
FXIcon *	big_folder
FXIcon *	mini_folder
FXIcon *	big_doc
FXIcon *	mini_doc
FXIcon *	big_app
FXIcon *	mini_app
FXString	directory
FXString	pattern
FXString	startdirectory
FXString	dropdirectory
FXString *	clipfiles
FXString *	dragfiles
FXString *	dropfiles
FXuint	matchmode
FXint	imagesize
FXTime	timestamp
FXuint	counter
FXDragAction	dropaction
FXbool	clipcut
FXbool	draggable

Detailed Description

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.

Member Enumeration Documentation

anonymous enum

Enumerator:

ID_SORT_BY_TYPE	Sort by name.
ID_SORT_BY_SIZE	Sort by type.
ID_SORT_BY_TIME	Sort by size.
ID_SORT_BY_USER	Sort by access time.
ID_SORT_BY_GROUP	Sort by owner name.
ID_SORT_REVERSE	Sort by group name.
ID_SORT_CASE	Reverse sort order.
ID_DIRECTORY_UP	Toggle sort case sensitivity.
ID_SET_PATTERN	Move up one directory.
ID_SET_DIRECTORY	Set match pattern.
ID_SHOW_HIDDEN	Set directory.
ID_HIDE_HIDDEN	Show hidden files.
ID_TOGGLE_HIDDEN	Hide hidden files.
ID_TOGGLE_IMAGES	Toggle display of hidden files.
ID_REFRESH	Toggle display of images.
ID_CUT_SEL	Refresh immediately.

The documentation for this class was generated from the following file:

/home/jeroen/FOX/fox/fox-1.7.32/include/FXFileList.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation