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

FX::FXFileList Class Reference

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

#include <FXFileList.h>

Inheritance diagram for FX::FXFileList:

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

Public Types

enum  {
  ID_REFRESHTIMER = FXIconList::ID_LAST,
  ID_OPENTIMER,
  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_LAST
}

Public Member Functions

 FXFileList (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)
void setCurrentFile (const FXString &file)
FXString getCurrentFile () const
void setDirectory (const FXString &path)
FXString getDirectory () const
void setPattern (const FXString &ptrn)
FXString getPattern () const
FXbool isItemDirectory (FXint index) const
FXbool isItemShare (FXint index) const
FXbool isItemFile (FXint index) const
FXbool isItemExecutable (FXint index) const
FXString getItemFilename (FXint index) const
FXString getItemPathname (FXint index) const
FXFileAssoc * getItemAssoc (FXint index) const
FXuint getMatchMode () const
void setMatchMode (FXuint mode)
FXbool showHiddenFiles () const
void showHiddenFiles (FXbool showing)
FXbool showOnlyDirectories () const
void showOnlyDirectories (FXbool shown)
FXbool showOnlyFiles () const
void showOnlyFiles (FXbool shown)
FXbool showImages () const
void showImages (FXbool showing)
FXint getImageSize () const
void setImageSize (FXint size)
void setAssociations (FXFileDict *assoc)
FXFileDict * getAssociations () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXFileList ()

Static Public Member Functions

FXint ascending (const FXIconItem *pa, const FXIconItem *pb)
FXint descending (const FXIconItem *pa, const FXIconItem *pb)
FXint ascendingCase (const FXIconItem *pa, const FXIconItem *pb)
FXint descendingCase (const FXIconItem *pa, const FXIconItem *pb)
FXint ascendingType (const FXIconItem *pa, const FXIconItem *pb)
FXint descendingType (const FXIconItem *pa, const FXIconItem *pb)
FXint ascendingSize (const FXIconItem *pa, const FXIconItem *pb)
FXint descendingSize (const FXIconItem *pa, const FXIconItem *pb)
FXint ascendingTime (const FXIconItem *pa, const FXIconItem *pb)
FXint descendingTime (const FXIconItem *pa, const FXIconItem *pb)
FXint ascendingUser (const FXIconItem *pa, const FXIconItem *pb)
FXint descendingUser (const FXIconItem *pa, const FXIconItem *pb)
FXint ascendingGroup (const FXIconItem *pa, const FXIconItem *pb)
FXint descendingGroup (const FXIconItem *pa, const FXIconItem *pb)

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.

See also:

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
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 owner name.
ID_SORT_BY_GROUP  Sort by group name.
ID_SORT_REVERSE  Reverse sort order.
ID_SORT_CASE  Toggle sort case sensitivity.
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 display of hidden files.
ID_TOGGLE_IMAGES  Toggle display of images.
ID_REFRESH  Refresh immediately.

Constructor & Destructor Documentation

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

Destructor.

Member Function Documentation

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

Create server-side resources.

Reimplemented from FX::FXIconList.

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

Detach server-side resources.

Reimplemented from FX::FXIconList.

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

Destroy server-side resources.

Reimplemented from FX::FXComposite.

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

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

void FX::FXFileList::setCurrentFile (  const FXString &  file  ) 
 

Set current file.

FXString FX::FXFileList::getCurrentFile (   )  const
 

Return current file.

void FX::FXFileList::setDirectory (  const FXString &  path  ) 
 

Set current directory.

FXString FX::FXFileList::getDirectory (   )  const [inline]
 

Return current directory.

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

Change wildcard matching pattern.

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

Return wildcard pattern.

FXbool FX::FXFileList::isItemDirectory (  FXint  index  )  const
 

Return TRUE if item is a directory.

FXbool FX::FXFileList::isItemShare (  FXint  index  )  const
 

Return TRUE if item is a directory.

FXbool FX::FXFileList::isItemFile (  FXint  index  )  const
 

Return TRUE if item is a file.

FXbool FX::FXFileList::isItemExecutable (  FXint  index  )  const
 

Return TRUE if item is executable.

FXString FX::FXFileList::getItemFilename (  FXint  index  )  const
 

Return name of item at index.

FXString FX::FXFileList::getItemPathname (  FXint  index  )  const
 

Return full pathname of item at index.

FXFileAssoc* FX::FXFileList::getItemAssoc (  FXint  index  )  const
 

Return file association of item.

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

Return wildcard matching mode.

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

Change wildcard matching mode.

FXbool FX::FXFileList::showHiddenFiles (   )  const
 

Return TRUE if showing hidden files.

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

Show or hide hidden files.

FXbool FX::FXFileList::showOnlyDirectories (   )  const
 

Return TRUE if showing directories only.

void FX::FXFileList::showOnlyDirectories (  FXbool  shown  ) 
 

Show directories only.

FXbool FX::FXFileList::showOnlyFiles (   )  const
 

Return TRUE if showing files only.

void FX::FXFileList::showOnlyFiles (  FXbool  shown  ) 
 

Show files only.

FXbool FX::FXFileList::showImages (   )  const
 

Return TRUE if image preview on.

void FX::FXFileList::showImages (  FXbool  showing  ) 
 

Show or hide preview images.

FXint FX::FXFileList::getImageSize (   )  const [inline]
 

Return images preview size.

void FX::FXFileList::setImageSize (  FXint  size  ) 
 

Change images preview size.

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

Change file associations.

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

Return file associations.

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

Save to stream.

Reimplemented from FX::FXIconList.

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

Load from stream.

Reimplemented from FX::FXIconList.

Copyright © 1997-2005 Jeroen van der Zijp