FX::FXDirList Class Reference

A Directory List widget provides a tree-structured view of the file system. More...

#include <FXDirList.h>

Inheritance diagram for FX::FXDirList:

List of all members.

Public Types
enum	{   ID_REFRESHTIMER = FXTreeList::ID_LAST, ID_DROPASK, ID_DROPCOPY, ID_DROPMOVE,   ID_DROPLINK, ID_SHOW_FILES, ID_HIDE_FILES, ID_TOGGLE_FILES,   ID_SHOW_HIDDEN, ID_HIDE_HIDDEN, ID_TOGGLE_HIDDEN, ID_SET_PATTERN,   ID_SORT_REVERSE, ID_SORT_CASE, ID_REFRESH, ID_LAST }
Public Member Functions
long	onRefreshTimer (FXObject *, FXSelector, void *)
long	onBeginDrag (FXObject *, FXSelector, void *)
long	onEndDrag (FXObject *, FXSelector, void *)
long	onDragged (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	onCmdSetValue (FXObject *, FXSelector, void *)
long	onCmdSetStringValue (FXObject *, FXSelector, void *)
long	onCmdGetStringValue (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	onCmdToggleFiles (FXObject *, FXSelector, void *)
long	onUpdToggleFiles (FXObject *, FXSelector, void *)
long	onCmdShowFiles (FXObject *, FXSelector, void *)
long	onUpdShowFiles (FXObject *, FXSelector, void *)
long	onCmdHideFiles (FXObject *, FXSelector, void *)
long	onUpdHideFiles (FXObject *, FXSelector, void *)
long	onCmdSetPattern (FXObject *, FXSelector, void *)
long	onUpdSetPattern (FXObject *, FXSelector, void *)
long	onCmdSortReverse (FXObject *, FXSelector, void *)
long	onUpdSortReverse (FXObject *, FXSelector, void *)
long	onCmdSortCase (FXObject *, FXSelector, void *)
long	onUpdSortCase (FXObject *, FXSelector, void *)
long	onCmdRefresh (FXObject *, FXSelector, void *)
long	onCmdDropAsk (FXObject *, FXSelector, void *)
long	onCmdDropCopy (FXObject *, FXSelector, void *)
long	onCmdDropMove (FXObject *, FXSelector, void *)
long	onCmdDropLink (FXObject *, FXSelector, void *)
	FXDirList (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 directory 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 directories 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.
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	getItemPathname (const FXTreeItem *item) const
	Return absolute pathname of item.
FXTreeItem *	getPathnameItem (const FXString &path)
	Return the item from the absolute pathname.
FXbool	isItemFile (const FXTreeItem *item) const
	Return true if item is a file.
FXbool	isItemDirectory (const FXTreeItem *item) const
	Return true if item is a directory.
FXbool	isItemExecutable (const FXTreeItem *item) const
	Return true if item is executable.
FXbool	isItemSymlink (const FXTreeItem *item) const
	Return true if this is a symbolic link item.
FXFileAssoc *	getItemAssoc (const FXTreeItem *item) const
	Return file association of item.
FXlong	getItemSize (const FXTreeItem *item) const
	Return the file size for this item.
FXTime	getItemDate (const FXTreeItem *item) const
	Return the date for this item, in nanoseconds.
FXuint	getItemMode (const FXTreeItem *item) const
	Return the mode bits for this item.
virtual FXbool	collapseTree (FXTreeItem *tree, FXbool notify=false)
	Collapse tree.
virtual FXbool	expandTree (FXTreeItem *tree, FXbool notify=false)
	Expand tree.
void	setMatchMode (FXuint mode)
	Change wildcard matching mode (see FXPath)
FXuint	getMatchMode () const
	Return wildcard matching mode.
void	showFiles (FXbool flag)
	Show or hide normal files.
FXbool	showFiles () const
	Return true if showing files as well as directories.
void	showHiddenFiles (FXbool flag)
	Show or hide hidden files and directories.
FXbool	showHiddenFiles () const
	Return true if showing hidden files and directories.
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 files draggable.
virtual void	save (FXStream &store) const
	Save to stream.
virtual void	load (FXStream &store)
	Load from stream.
virtual	~FXDirList ()
	Destructor.
Static Public Member Functions
static FXint	ascending (const FXTreeItem *a, const FXTreeItem *b)
static FXint	descending (const FXTreeItem *a, const FXTreeItem *b)
static FXint	ascendingCase (const FXTreeItem *a, const FXTreeItem *b)
static FXint	descendingCase (const FXTreeItem *a, const FXTreeItem *b)
Protected Member Functions
void	listRootItems ()
void	listChildItems (FXDirItem *par)
FXString	getSelectedFiles () const
virtual FXTreeItem *	createItem (const FXString &text, FXIcon *oi, FXIcon *ci, void *ptr)
Protected Attributes
FXFileDict *	associations
FXDirItem *	list
FXIcon *	opendiricon
FXIcon *	closeddiricon
FXIcon *	documenticon
FXIcon *	applicationicon
FXIcon *	cdromicon
FXIcon *	harddiskicon
FXIcon *	networkicon
FXIcon *	floppyicon
FXIcon *	zipdiskicon
FXString	pattern
FXString	dropdirectory
FXString	dragfiles
FXString	dropfiles
FXDragAction	dropaction
FXuint	matchmode
FXuint	counter
FXbool	draggable

---

Detailed Description

A Directory List widget provides a tree-structured view of the file system.

It automatically updates itself periodically by re-scanning the file system for any changes. As it scans the displayed directories and files, it automatically determines the icons to be displayed by consulting the file-associations registry settings. A number of messages can be sent to the Directory List to control the filter pattern, sorting order, case sensitivity, and hidden file display mode. The Directory list widget supports drags and drops of files.

---

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

• /home/jeroen/FOX/fox/fox-1.7.32/include/FXDirList.h