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

FX::FXFileList Class Reference

#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, FXbool notify=FALSE)
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
FXFileAssocgetItemAssoc (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)
FXbool showParents () const
void showParents (FXbool shown)
void setAssociations (FXFileDict *assoc)
FXFileDictgetAssociations () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXFileList ()

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)

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.

See also:


Member Enumeration Documentation

anonymous enum
Enumerator:
ID_REFRESHTIMER 
ID_OPENTIMER 
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.

ID_LAST 

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

static FXint FX::FXFileList::ascending ( const FXIconItem a,
const FXIconItem b 
) [static]

Reimplemented from FX::FXIconList.

static FXint FX::FXFileList::descending ( const FXIconItem a,
const FXIconItem b 
) [static]

Reimplemented from FX::FXIconList.

static FXint FX::FXFileList::ascendingCase ( const FXIconItem a,
const FXIconItem b 
) [static]

Reimplemented from FX::FXIconList.

static FXint FX::FXFileList::descendingCase ( const FXIconItem a,
const FXIconItem b 
) [static]

Reimplemented from FX::FXIconList.

static FXint FX::FXFileList::ascendingType ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::descendingType ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::ascendingSize ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::descendingSize ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::ascendingTime ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::descendingTime ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::ascendingUser ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::descendingUser ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::ascendingGroup ( const FXIconItem a,
const FXIconItem b 
) [static]
static FXint FX::FXFileList::descendingGroup ( const FXIconItem a,
const FXIconItem b 
) [static]
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,
FXbool  notify = FALSE 
)

Set current file.

Return current file.

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

Set current directory.

Return current directory.

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

Change wildcard matching pattern.

Return wildcard pattern.

Return TRUE if item is a directory.

Return TRUE if item is a directory.

Return TRUE if item is a file.

Return TRUE if item is executable.

Return name of item at index.

Return full pathname of item at index.

Return file association of item.

Return wildcard matching mode.

Change wildcard matching mode.

Return TRUE if showing hidden files.

Show or hide hidden files.

Return TRUE if showing directories only.

Show directories only.

Return TRUE if showing files only.

Show files only.

Return TRUE if image preview on.

Show or hide preview images.

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

Return images preview size.

Change images preview size.

Return TRUE if showing parent directories.

Show parent directories.

Change file associations.

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