Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXDirList

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:

FX::FXTreeList FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject List of all members.

Public Member Functions

 FXDirList (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
virtual void create ()
virtual void detach ()
virtual void destroy ()
void scan (FXbool force=TRUE)
FXbool isItemDirectory (const FXTreeItem *item) const
FXbool isItemFile (const FXTreeItem *item) const
FXbool isItemExecutable (const FXTreeItem *item) const
virtual FXbool collapseTree (FXTreeItem *tree, FXbool notify=FALSE)
virtual FXbool expandTree (FXTreeItem *tree, FXbool notify=FALSE)
void setCurrentFile (const FXString &file, FXbool notify=FALSE)
FXString getCurrentFile () const
void setDirectory (const FXString &path, FXbool notify=FALSE)
FXString getDirectory () const
FXString getItemPathname (const FXTreeItem *item) const
FXTreeItem * getPathnameItem (const FXString &path)
void setPattern (const FXString &ptrn)
FXString getPattern () const
FXuint getMatchMode () const
void setMatchMode (FXuint mode)
FXbool showFiles () const
void showFiles (FXbool showing)
FXbool showHiddenFiles () const
void showHiddenFiles (FXbool showing)
void setAssociations (FXFileDict *assoc)
FXFileDict * getAssociations () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXDirList ()

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)

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.

See also:

Constructor & Destructor Documentation

FX::FXDirList::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 FX::FXDirList::~FXDirList (   )  [virtual]
 

Destructor.

Member Function Documentation

static FXint FX::FXDirList::ascending (  const FXTreeItem *  a,
const FXTreeItem *  b
)  [static]
 

Reimplemented from FX::FXTreeList.

static FXint FX::FXDirList::descending (  const FXTreeItem *  a,
const FXTreeItem *  b
)  [static]
 

Reimplemented from FX::FXTreeList.

static FXint FX::FXDirList::ascendingCase (  const FXTreeItem *  a,
const FXTreeItem *  b
)  [static]
 

Reimplemented from FX::FXTreeList.

static FXint FX::FXDirList::descendingCase (  const FXTreeItem *  a,
const FXTreeItem *  b
)  [static]
 

Reimplemented from FX::FXTreeList.

virtual void FX::FXDirList::create (   )  [virtual]
 

Create server-side resources.

Reimplemented from FX::FXTreeList.

virtual void FX::FXDirList::detach (   )  [virtual]
 

Detach server-side resources.

Reimplemented from FX::FXTreeList.

virtual void FX::FXDirList::destroy (   )  [virtual]
 

Destroy server-side resources.

Reimplemented from FX::FXComposite.

void FX::FXDirList::scan (  FXbool  force = TRUE  ) 
 

Scan the directories and update the items if needed, or if force is TRUE.

FXbool FX::FXDirList::isItemDirectory (  const FXTreeItem *  item  )  const
 

Return TRUE if item is a directory.

FXbool FX::FXDirList::isItemFile (  const FXTreeItem *  item  )  const
 

Return TRUE if item is a file.

FXbool FX::FXDirList::isItemExecutable (  const FXTreeItem *  item  )  const
 

Return TRUE if item is executable.

virtual FXbool FX::FXDirList::collapseTree (  FXTreeItem *  tree,
FXbool  notify = FALSE
)  [virtual]
 

Collapse tree.

Reimplemented from FX::FXTreeList.

virtual FXbool FX::FXDirList::expandTree (  FXTreeItem *  tree,
FXbool  notify = FALSE
)  [virtual]
 

Expand tree.

Reimplemented from FX::FXTreeList.

void FX::FXDirList::setCurrentFile (  const FXString &  file,
FXbool  notify = FALSE
) 
 

Set current file.

FXString FX::FXDirList::getCurrentFile (   )  const
 

Return current file.

void FX::FXDirList::setDirectory (  const FXString &  path,
FXbool  notify = FALSE
) 
 

Set current directory.

FXString FX::FXDirList::getDirectory (   )  const
 

Return current directory.

FXString FX::FXDirList::getItemPathname (  const FXTreeItem *  item  )  const
 

Return absolute pathname of item.

FXTreeItem* FX::FXDirList::getPathnameItem (  const FXString &  path  ) 
 

Return the item from the absolute pathname.

void FX::FXDirList::setPattern (  const FXString &  ptrn  ) 
 

Change wildcard matching pattern.

FXString FX::FXDirList::getPattern (   )  const [inline]
 

Return wildcard pattern.

FXuint FX::FXDirList::getMatchMode (   )  const [inline]
 

Return wildcard matching mode.

void FX::FXDirList::setMatchMode (  FXuint  mode  ) 
 

Change wildcard matching mode.

FXbool FX::FXDirList::showFiles (   )  const
 

Return TRUE if showing files as well as directories.

void FX::FXDirList::showFiles (  FXbool  showing  ) 
 

Show or hide normal files.

FXbool FX::FXDirList::showHiddenFiles (   )  const
 

Return TRUE if showing hidden files and directories.

void FX::FXDirList::showHiddenFiles (  FXbool  showing  ) 
 

Show or hide hidden files and directories.

void FX::FXDirList::setAssociations (  FXFileDict *  assoc  ) 
 

Change file associations.

FXFileDict* FX::FXDirList::getAssociations (   )  const [inline]
 

Return file associations.

virtual void FX::FXDirList::save (  FXStream &  store  )  const [virtual]
 

Save to stream.

Reimplemented from FX::FXTreeList.

virtual void FX::FXDirList::load (  FXStream &  store  )  [virtual]
 

Load from stream.

Reimplemented from FX::FXTreeList.

Copyright © 1997-2005 Jeroen van der Zijp